Enable storage options to be filtered out based on specified storage …

pkg/apis/io/v1alpha1/options.go

@@ -3,6 +3,7 @@ package v1alpha1
 import (
 	"encoding/json"
 	"fmt"
+	"strings"
 )
 
 // Options defines a common options parameter to the different structs
@@ -17,6 +18,22 @@ func NewOptions(o map[string]interface{}) Options {
 	return options
 }
 
+// Filter creates a new Options object with just the elements identified by the supplied prefix
+func (o *Options) Filter(prefix string) Options {
+	options := Options{}
+	options.opts = make(map[string]string)
+
+	prefix += "."
+
+	for k, v := range o.opts {
+		if strings.HasPrefix(k, prefix) {
+			options.opts[k] = v
+		}
+	}
+
+	return options
+}
+
 // UnmarshalJSON implements an alternative parser for this field
 func (o *Options) UnmarshalJSON(b []byte) error {
 	var entries map[string]interface{}

pkg/apis/io/v1alpha1/options_test.go

@@ -46,13 +46,33 @@ func TestMarshalling(t *testing.T) {
 	assert.Contains(t, s, `"es.username":"elastic"`)
 }
 
+func TestMarshallingWithFilter(t *testing.T) {
+	o := NewOptions(map[string]interface{}{
+		"es.server-urls":    "http://elasticsearch.default.svc:9200",
+		"memory.max-traces": "50000",
+	})
+	o = o.Filter("memory")
+	args := o.ToArgs()
+	assert.Len(t, args, 1)
+	assert.Equal(t, "50000", o.Map()["memory.max-traces"])
+}
+
 func TestMultipleSubValues(t *testing.T) {
 	o := NewOptions(nil)
 	o.UnmarshalJSON([]byte(`{"es": {"server-urls": "http://elasticsearch:9200", "username": "elastic", "password": "changeme"}}`))
 	args := o.ToArgs()
 	assert.Len(t, args, 3)
 }
 
+func TestMultipleSubValuesWithFilter(t *testing.T) {
+	o := NewOptions(nil)
+	o.UnmarshalJSON([]byte(`{"memory": {"max-traces": "50000"}, "es": {"server-urls": "http://elasticsearch:9200", "username": "elastic", "password": "changeme"}}`))
+	o = o.Filter("memory")
+	args := o.ToArgs()
+	assert.Len(t, args, 1)
+	assert.Equal(t, "50000", o.Map()["memory.max-traces"])
+}
+
 func TestExposedMap(t *testing.T) {
 	o := NewOptions(nil)
 	o.UnmarshalJSON([]byte(`{"cassandra": {"servers": "cassandra:9042"}}`))

pkg/controller/controller.go

@@ -9,6 +9,7 @@ import (
 	batchv1 "k8s.io/api/batch/v1"
 
 	"github.com/jaegertracing/jaeger-operator/pkg/apis/io/v1alpha1"
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
 )
 
 // Controller knows what type of deployments to build based on a given spec
@@ -55,7 +56,7 @@ func normalize(jaeger *v1alpha1.Jaeger) {
 			"The provided storage type for the Jaeger instance '%v' is unknown ('%v'). Falling back to 'memory'. Known options: %v",
 			jaeger.Name,
 			jaeger.Spec.Storage.Type,
-			knownStorages(),
+			storage.ValidTypes(),
 		)
 		jaeger.Spec.Storage.Type = "memory"
 	}
@@ -78,20 +79,11 @@ func normalize(jaeger *v1alpha1.Jaeger) {
 }
 
 func unknownStorage(typ string) bool {
-	for _, k := range knownStorages() {
+	for _, k := range storage.ValidTypes() {
 		if strings.ToLower(typ) == k {
 			return false
 		}
 	}
 
 	return true
 }
-
-func knownStorages() []string {
-	return []string{
-		"memory",
-		"kafka",
-		"elasticsearch",
-		"cassandra",
-	}
-}

pkg/deployment/all-in-one.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/jaegertracing/jaeger-operator/pkg/apis/io/v1alpha1"
 	"github.com/jaegertracing/jaeger-operator/pkg/service"
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
 )
 
 // AllInOne builds pods for jaegertracing/all-in-one
@@ -73,7 +74,8 @@ func (a *AllInOne) Get() *appsv1.Deployment {
 					Containers: []v1.Container{{
 						Image: a.jaeger.Spec.AllInOne.Image,
 						Name:  "jaeger",
-						Args:  allArgs(a.jaeger.Spec.AllInOne.Options, a.jaeger.Spec.Storage.Options),
+						Args: allArgs(a.jaeger.Spec.AllInOne.Options,
+							a.jaeger.Spec.Storage.Options.Filter(storage.OptionsPrefix(a.jaeger.Spec.Storage.Type))),
 						Env: []v1.EnvVar{
 							v1.EnvVar{
 								Name:  "SPAN_STORAGE_TYPE",

pkg/deployment/collector.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/jaegertracing/jaeger-operator/pkg/apis/io/v1alpha1"
 	"github.com/jaegertracing/jaeger-operator/pkg/service"
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
 )
 
 // Collector builds pods for jaegertracing/jaeger-collector
@@ -80,7 +81,8 @@ func (c *Collector) Get() *appsv1.Deployment {
 					Containers: []v1.Container{{
 						Image: c.jaeger.Spec.Collector.Image,
 						Name:  "jaeger-collector",
-						Args:  allArgs(c.jaeger.Spec.Collector.Options, c.jaeger.Spec.Storage.Options),
+						Args: allArgs(c.jaeger.Spec.Collector.Options,
+							c.jaeger.Spec.Storage.Options.Filter(storage.OptionsPrefix(c.jaeger.Spec.Storage.Type))),
 						Env: []v1.EnvVar{
 							v1.EnvVar{
 								Name:  "SPAN_STORAGE_TYPE",

pkg/deployment/query.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/jaegertracing/jaeger-operator/pkg/apis/io/v1alpha1"
 	"github.com/jaegertracing/jaeger-operator/pkg/service"
+	"github.com/jaegertracing/jaeger-operator/pkg/storage"
 )
 
 // Query builds pods for jaegertracing/jaeger-query
@@ -86,7 +87,8 @@ func (q *Query) Get() *appsv1.Deployment {
 					Containers: []v1.Container{{
 						Image: q.jaeger.Spec.Query.Image,
 						Name:  "jaeger-query",
-						Args:  allArgs(q.jaeger.Spec.Query.Options, q.jaeger.Spec.Storage.Options),
+						Args: allArgs(q.jaeger.Spec.Query.Options,
+							q.jaeger.Spec.Storage.Options.Filter(storage.OptionsPrefix(q.jaeger.Spec.Storage.Type))),
 						Env: []v1.EnvVar{
 							v1.EnvVar{
 								Name:  "SPAN_STORAGE_TYPE",

pkg/storage/types.go

@@ -0,0 +1,23 @@
+package storage
+
+import (
+	"strings"
+)
+
+// ValidTypes returns the list of valid storage types
+func ValidTypes() []string {
+	return []string{
+		"memory",
+		"kafka",
+		"elasticsearch",
+		"cassandra",
+	}
+}
+
+// OptionsPrefix returns the options prefix associated with the supplied storage type
+func OptionsPrefix(storageType string) string {
+	if strings.ToLower(storageType) == "elasticsearch" {
+		return "es"
+	}
+	return storageType
+}

pkg/storage/types_test.go

@@ -0,0 +1,23 @@
+package storage
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDefaultPrefix(t *testing.T) {
+	assert.Equal(t, "anystorage", OptionsPrefix("anystorage"))
+}
+
+func TestElasticsearchPrefix(t *testing.T) {
+	assert.Equal(t, "es", OptionsPrefix("elasticsearch"))
+}
+
+func TestValidTypes(t *testing.T) {
+	assert.Len(t, ValidTypes(), 4)
+	assert.Contains(t, ValidTypes(), "memory")
+	assert.Contains(t, ValidTypes(), "elasticsearch")
+	assert.Contains(t, ValidTypes(), "cassandra")
+	assert.Contains(t, ValidTypes(), "kafka")
+}