Add support for grpc-plugin storage (#1517)

Signed-off-by: Pavol Loffay <[email protected]>
jaegertracing · Jul 26, 2021 · 4823277 · 4823277
1 parent 25e9291
commit 4823277
Show file tree

Hide file tree

Showing 17 changed files with 372 additions and 8 deletions.
diff --git a/deploy/crds/jaegertracing.io_jaegers_crd.yaml b/deploy/crds/jaegertracing.io_jaegers_crd.yaml
@@ -10677,6 +10677,11 @@ spec:
                         type: array
                         x-kubernetes-list-type: atomic
                     type: object
+                  grpcPlugin:
+                    properties:
+                      image:
+                        type: string
+                    type: object
                   options:
                     type: object
                     x-kubernetes-preserve-unknown-fields: true

diff --git a/examples/with-grpc-storage-plugin.yaml b/examples/with-grpc-storage-plugin.yaml
@@ -0,0 +1,28 @@
+# This example shows how to use Jaeger's Clickhouse grpc-plugin https://github.com/pavolloffay/jaeger-clickhouse
+# Before deploying Jaeger, create Clickhouse instance via Clickhouse operator and jaeger-clickhouse config map.
+# kubectl create configmap jaeger-clickhouse --from-file config.yaml
+# Content of config.yaml:
+# address: tcp://clickhouse-simple-01:9000
+# username: clickhouse_operator
+# password: clickhouse_operator_password
+apiVersion: jaegertracing.io/v1
+kind: Jaeger
+metadata:
+  name: clickhouse-grpc-plugin
+spec:
+  storage:
+    type: grpc-plugin
+    grpcPlugin:
+      image: ghcr.io/pavolloffay/jaeger-clickhouse:0.4.1
+    options:
+      grpc-storage-plugin:
+        binary: /plugin/jaeger-clickhouse
+        configuration-file: /plugin-config/config.yaml
+        log-level: debug
+  volumeMounts:
+    - name: plugin-config
+      mountPath: /plugin-config
+  volumes:
+    - name: plugin-config
+      configMap:
+        name: jaeger-clickhouse
diff --git a/pkg/apis/jaegertracing/v1/jaeger_types.go b/pkg/apis/jaegertracing/v1/jaeger_types.go
@@ -104,6 +104,10 @@ const (
 	// JaegerBadgerStorage indicates that the Jaeger storage type is badger
 	// +k8s:openapi-gen=true
 	JaegerBadgerStorage JaegerStorageType = "badger"
+
+	// JaegerGRPCPluginStorage indicates that the Jaeger storage type is grpc-plugin
+	// +k8s:openapi-gen=true
+	JaegerGRPCPluginStorage JaegerStorageType = "grpc-plugin"
 )
 
 // ValidStorageTypes returns the list of valid storage types
@@ -114,6 +118,7 @@ func ValidStorageTypes() []JaegerStorageType {
 		JaegerESStorage,
 		JaegerKafkaStorage,
 		JaegerBadgerStorage,
+		JaegerGRPCPluginStorage,
 	}
 }
 
@@ -122,6 +127,9 @@ func (storageType JaegerStorageType) OptionsPrefix() string {
 	if storageType == JaegerESStorage {
 		return "es"
 	}
+	if storageType == JaegerGRPCPluginStorage {
+		return "grpc-storage-plugin"
+	}
 	return string(storageType)
 }
 
@@ -522,6 +530,9 @@ type JaegerStorageSpec struct {
 
 	// +optional
 	Elasticsearch ElasticsearchSpec `json:"elasticsearch,omitempty"`
+
+	// +optional
+	GRPCPlugin GRPCPluginSpec `json:"grpcPlugin,omitempty"`
 }
 
 // ElasticsearchSpec represents the ES configuration options that we pass down to the Elasticsearch operator
@@ -593,6 +604,14 @@ type JaegerCassandraCreateSchemaSpec struct {
 	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
 }
 
+// GRPCPluginSpec represents the grpc-plugin configuration options.
+// +k8s:openapi-gen=true
+type GRPCPluginSpec struct {
+	// This image is used as an init-container to copy plugin binary into /plugin directory.
+	// +optional
+	Image string `json:"image,omitempty"`
+}
+
 // JaegerDependenciesSpec defined options for running spark-dependencies.
 // +k8s:openapi-gen=true
 type JaegerDependenciesSpec struct {

diff --git a/pkg/apis/jaegertracing/v1/jaeger_types_test.go b/pkg/apis/jaegertracing/v1/jaeger_types_test.go
@@ -22,5 +22,6 @@ func TestValidTypes(t *testing.T) {
 			JaegerESStorage,
 			JaegerKafkaStorage,
 			JaegerBadgerStorage,
+			JaegerGRPCPluginStorage,
 		})
 }
diff --git a/pkg/apis/jaegertracing/v1/zz_generated.deepcopy.go b/pkg/apis/jaegertracing/v1/zz_generated.deepcopy.go
diff --git a/pkg/apis/jaegertracing/v1/zz_generated.openapi.go b/pkg/apis/jaegertracing/v1/zz_generated.openapi.go
diff --git a/pkg/deployment/all_in_one.go b/pkg/deployment/all_in_one.go
@@ -5,6 +5,8 @@ import (
 	"sort"
 	"strconv"
 
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
+
 	"github.com/spf13/viper"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
@@ -66,6 +68,7 @@ func (a *AllInOne) Get() *appsv1.Deployment {
 	tls.Update(a.jaeger, commonSpec, &options)
 	ca.Update(a.jaeger, commonSpec)
 	ca.AddServiceCA(a.jaeger, commonSpec)
+	storage.UpdateGRPCPlugin(a.jaeger, commonSpec)
 
 	// Enable tls by default for openshift platform
 	// even though the agent is in the same process as the collector, they communicate via gRPC, and the collector has TLS enabled,
@@ -223,6 +226,7 @@ func (a *AllInOne) Get() *appsv1.Deployment {
 					Tolerations:        commonSpec.Tolerations,
 					SecurityContext:    commonSpec.SecurityContext,
 					EnableServiceLinks: &falseVar,
+					InitContainers:     storage.GetGRPCPluginInitContainers(a.jaeger, commonSpec),
 				},
 			},
 		},

diff --git a/pkg/deployment/all_in_one_test.go b/pkg/deployment/all_in_one_test.go
@@ -5,6 +5,7 @@ import (
 
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -397,6 +398,38 @@ func TestAllInOneEmptyStrategyType(t *testing.T) {
 	assert.Equal(t, appsv1.RecreateDeploymentStrategyType, dep.Spec.Strategy.Type)
 }
 
+func TestAllInOneGRPCPlugin(t *testing.T) {
+	jaeger := v1.NewJaeger(types.NamespacedName{Name: "TestAllInOneGRPCPlugin"})
+	jaeger.Spec.Storage.Type = v1.JaegerGRPCPluginStorage
+	jaeger.Spec.Storage.GRPCPlugin.Image = "plugin/plugin:1.0"
+	jaeger.Spec.Storage.Options = v1.NewOptions(map[string]interface{}{
+		"grpc-storage-plugin.binary": "/plugin/plugin",
+	})
+
+	allinone := NewAllInOne(jaeger)
+	dep := allinone.Get()
+
+	assert.Equal(t, []corev1.Container{
+		{
+			Image: "plugin/plugin:1.0",
+			Name:  "install-plugin",
+			VolumeMounts: []corev1.VolumeMount{
+				{
+					Name:      "testallinonegrpcplugin-sampling-configuration-volume",
+					MountPath: "/etc/jaeger/sampling",
+					ReadOnly:  true,
+				},
+				{
+					Name:      "plugin-volume",
+					MountPath: "/plugin",
+				},
+			},
+		},
+	}, dep.Spec.Template.Spec.InitContainers)
+	require.Equal(t, 1, len(dep.Spec.Template.Spec.Containers))
+	assert.Equal(t, []string{"--grpc-storage-plugin.binary=/plugin/plugin", "--sampling.strategies-file=/etc/jaeger/sampling/sampling.json"}, dep.Spec.Template.Spec.Containers[0].Args)
+}
+
 func getEnvVarByName(vars []corev1.EnvVar, name string) corev1.EnvVar {
 	envVar := corev1.EnvVar{}
 	for _, v := range vars {

diff --git a/pkg/deployment/collector.go b/pkg/deployment/collector.go
@@ -17,6 +17,7 @@ import (
 	"github.com/jaegertracing/jaeger-operator/pkg/config/sampling"
 	"github.com/jaegertracing/jaeger-operator/pkg/config/tls"
 	"github.com/jaegertracing/jaeger-operator/pkg/service"
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
 	"github.com/jaegertracing/jaeger-operator/pkg/util"
 )
 
@@ -79,6 +80,7 @@ func (c *Collector) Get() *appsv1.Deployment {
 		tls.Update(c.jaeger, commonSpec, &options)
 		ca.Update(c.jaeger, commonSpec)
 	}
+	storage.UpdateGRPCPlugin(c.jaeger, commonSpec)
 
 	// ensure we have a consistent order of the arguments
 	// see https://github.com/jaegertracing/jaeger-operator/issues/334
@@ -194,6 +196,7 @@ func (c *Collector) Get() *appsv1.Deployment {
 					Tolerations:        commonSpec.Tolerations,
 					SecurityContext:    commonSpec.SecurityContext,
 					EnableServiceLinks: &falseVar,
+					InitContainers:     storage.GetGRPCPluginInitContainers(c.jaeger, commonSpec),
 				},
 			},
 		},

diff --git a/pkg/deployment/collector_test.go b/pkg/deployment/collector_test.go
@@ -5,10 +5,9 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/jaegertracing/jaeger-operator/pkg/version"
-
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -18,6 +17,7 @@ import (
 
 	v1 "github.com/jaegertracing/jaeger-operator/pkg/apis/jaegertracing/v1"
 	"github.com/jaegertracing/jaeger-operator/pkg/util"
+	"github.com/jaegertracing/jaeger-operator/pkg/version"
 )
 
 func init() {
@@ -596,6 +596,38 @@ func TestCollectorEmptyStrategyType(t *testing.T) {
 	assert.Equal(t, appsv1.RecreateDeploymentStrategyType, dep.Spec.Strategy.Type)
 }
 
+func TestCollectorGRPCPlugin(t *testing.T) {
+	jaeger := v1.NewJaeger(types.NamespacedName{Name: "TestCollectorGRPCPlugin"})
+	jaeger.Spec.Storage.Type = v1.JaegerGRPCPluginStorage
+	jaeger.Spec.Storage.GRPCPlugin.Image = "plugin/plugin:1.0"
+	jaeger.Spec.Storage.Options = v1.NewOptions(map[string]interface{}{
+		"grpc-storage-plugin.binary": "/plugin/plugin",
+	})
+
+	collector := Collector{jaeger: jaeger}
+	dep := collector.Get()
+
+	assert.Equal(t, []corev1.Container{
+		{
+			Image: "plugin/plugin:1.0",
+			Name:  "install-plugin",
+			VolumeMounts: []corev1.VolumeMount{
+				{
+					Name:      "testcollectorgrpcplugin-sampling-configuration-volume",
+					MountPath: "/etc/jaeger/sampling",
+					ReadOnly:  true,
+				},
+				{
+					Name:      "plugin-volume",
+					MountPath: "/plugin",
+				},
+			},
+		},
+	}, dep.Spec.Template.Spec.InitContainers)
+	require.Equal(t, 1, len(dep.Spec.Template.Spec.Containers))
+	assert.Equal(t, []string{"--grpc-storage-plugin.binary=/plugin/plugin", "--sampling.strategies-file=/etc/jaeger/sampling/sampling.json"}, dep.Spec.Template.Spec.Containers[0].Args)
+}
+
 func hasVolume(name string, volumes []corev1.Volume) bool {
 	for _, v := range volumes {
 		if v.Name == name {

diff --git a/pkg/deployment/ingester.go b/pkg/deployment/ingester.go
@@ -14,6 +14,7 @@ import (
 	"github.com/jaegertracing/jaeger-operator/pkg/account"
 	v1 "github.com/jaegertracing/jaeger-operator/pkg/apis/jaegertracing/v1"
 	"github.com/jaegertracing/jaeger-operator/pkg/config/ca"
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
 	"github.com/jaegertracing/jaeger-operator/pkg/util"
 )
 
@@ -75,6 +76,7 @@ func (i *Ingester) Get() *appsv1.Deployment {
 		i.jaeger.Spec.Storage.Options.Filter(i.jaeger.Spec.Storage.Type.OptionsPrefix()))
 
 	ca.Update(i.jaeger, commonSpec)
+	storage.UpdateGRPCPlugin(i.jaeger, commonSpec)
 
 	// ensure we have a consistent order of the arguments
 	// see https://github.com/jaegertracing/jaeger-operator/issues/334
@@ -161,6 +163,7 @@ func (i *Ingester) Get() *appsv1.Deployment {
 					Tolerations:        commonSpec.Tolerations,
 					SecurityContext:    commonSpec.SecurityContext,
 					EnableServiceLinks: &falseVar,
+					InitContainers:     storage.GetGRPCPluginInitContainers(i.jaeger, commonSpec),
 				},
 			},
 		},