[installer]: allow customization of envvars

Author: Simon Emms

install/installer/pkg/common/customize.go

@@ -71,7 +71,31 @@ func CustomizeAnnotation(ctx *RenderContext, component string, typeMeta metav1.T
 }
 
 func CustomizeEnvvar(ctx *RenderContext, component string, existingEnvvars []corev1.EnvVar) []corev1.EnvVar {
-	return existingEnvvars
+	// Use a map so we can remove duplicated keys
+	envvars := make(map[string]corev1.EnvVar, 0)
+
+	// Apply the customizations - envvars only need to match name
+	if ctx.Config.Customization != nil {
+		for _, customization := range *ctx.Config.Customization {
+			if customization.Metadata.Name == component || customization.Metadata.Name == "*" {
+				for _, e := range customization.Spec.Env {
+					envvars[e.Name] = e
+				}
+			}
+		}
+	}
+
+	// Always apply existing envvars
+	for _, e := range existingEnvvars {
+		envvars[e.Name] = e
+	}
+
+	// Convert map back slice
+	output := make([]corev1.EnvVar, 0, len(envvars))
+	for _, e := range envvars {
+		output = append(output, e)
+	}
+	return output
 }
 
 func CustomizeLabel(ctx *RenderContext, component string, typeMeta metav1.TypeMeta, existingLabels ...func() map[string]string) map[string]string {

install/installer/pkg/common/customize_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/gitpod-io/gitpod/installer/pkg/config/v1"
 	"github.com/gitpod-io/gitpod/installer/pkg/config/versions"
 	"github.com/stretchr/testify/require"
+	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -379,3 +380,149 @@ func TestCustomizeLabel(t *testing.T) {
 		})
 	}
 }
+
+func TestCustomizeEnvvar(t *testing.T) {
+	testCases := []struct {
+		Name            string
+		Customization   []config.Customization
+		Component       string
+		ExistingEnnvars []corev1.EnvVar
+		Expect          []corev1.EnvVar
+	}{
+
+		{
+			Name:          "no customization",
+			Customization: nil,
+			Component:     "component",
+			Expect:        []corev1.EnvVar{},
+		},
+		{
+			Customization: []config.Customization{},
+			Name:          "empty customization",
+			Component:     "component",
+			Expect:        []corev1.EnvVar{},
+		},
+		{
+			Customization: []config.Customization{
+				{
+					TypeMeta: common.TypeMetaDeployment,
+					Metadata: metav1.ObjectMeta{
+						Name: "component2",
+					},
+					Spec: config.CustomizationSpec{
+						Env: []corev1.EnvVar{
+							{
+								Name:  "key1",
+								Value: "value1",
+							},
+						},
+					},
+				},
+			},
+			Name:      "ignore different name envvars",
+			Component: "component",
+			Expect:    []corev1.EnvVar{},
+		},
+		{
+			Customization: []config.Customization{
+				{
+					TypeMeta: common.TypeMetaDeployment,
+					Metadata: metav1.ObjectMeta{
+						Name: "component",
+					},
+					Spec: config.CustomizationSpec{
+						Env: []corev1.EnvVar{
+							{
+								Name:  "key1",
+								Value: "value1",
+							},
+						},
+					},
+				},
+			},
+			Name:      "add in name envvars",
+			Component: "component",
+			Expect: []corev1.EnvVar{
+				{
+					Name:  "key1",
+					Value: "value1",
+				},
+			},
+		},
+		{
+			Customization: []config.Customization{
+				{
+					Metadata: metav1.ObjectMeta{
+						Name: "*",
+					},
+					Spec: config.CustomizationSpec{
+						Env: []corev1.EnvVar{
+							{
+								Name:  "key1",
+								Value: "original",
+							},
+							{
+								Name:  "key2",
+								Value: "original",
+							},
+							{
+								Name:  "key3",
+								Value: "override",
+							},
+						},
+					},
+				},
+				{
+					Metadata: metav1.ObjectMeta{
+						Name: "component",
+					},
+					Spec: config.CustomizationSpec{
+						Env: []corev1.EnvVar{
+							{
+								Name:  "key1",
+								Value: "override",
+							},
+						},
+					},
+				},
+			},
+			ExistingEnnvars: []corev1.EnvVar{
+				{
+					Name:  "key3",
+					Value: "original",
+				},
+			},
+			Name:      "full-house envvars",
+			Component: "component",
+			Expect: []corev1.EnvVar{
+				{
+					Name:  "key1",
+					Value: "override",
+				},
+				{
+					Name:  "key2",
+					Value: "original",
+				},
+				{
+					Name:  "key3",
+					Value: "original",
+				},
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.Name, func(t *testing.T) {
+			ctx, err := common.NewRenderContext(config.Config{
+				Customization: &testCase.Customization,
+			}, versions.Manifest{}, "test_namespace")
+			require.NoError(t, err)
+
+			result := common.CustomizeEnvvar(ctx, testCase.Component, testCase.ExistingEnnvars)
+
+			if !reflect.DeepEqual(testCase.Expect, result) {
+				t.Errorf("expected %v but got %v", testCase.Expect, result)
+			}
+		})
+	}
+}

install/installer/pkg/config/v1/config.go

@@ -334,4 +334,9 @@ type OAuth struct {
 type Customization struct {
 	metav1.TypeMeta `json:",inline"`
 	Metadata        metav1.ObjectMeta `json:"metadata"`
+	Spec            CustomizationSpec `json:"spec,omitempty"`
+}
+
+type CustomizationSpec struct {
+	Env []corev1.EnvVar `json:"env"`
 }