Add support for extraVolumes/extraVolumeMounts (#583)

* Add support for `extraVolumes/extraVolumeMounts` * changelog
solo-io · Sep 10, 2024 · 37bff11 · 37bff11
1 parent 85da7cf
commit 37bff11
Show file tree

Hide file tree

Showing 26 changed files with 1,212 additions and 7 deletions.
diff --git a/Makefile b/Makefile
@@ -23,6 +23,7 @@ install-go-tools: mod-download
 	go install github.com/golang/mock/[email protected]
 	go install github.com/onsi/ginkgo/v2/[email protected]
 	go install golang.org/x/tools/cmd/goimports
+	go install sigs.k8s.io/kind/cmd/[email protected]
 
 # proto compiler installation
 PROTOC_VERSION:=3.15.8
@@ -74,18 +75,26 @@ generate-changelog:
 # set TEST_PKG to run a specific test package
 .PHONY: run-tests
 run-tests:
-	PATH=$(DEPSGOBIN):$$PATH ginkgo -r -failFast -trace -progress \
-		-progress \
+	PATH=$(DEPSGOBIN):$$PATH ginkgo -r --fail-fast -trace \
+		--show-node-events \
 		-compilers=4 \
-		-skipPackage=$(SKIP_PACKAGES) $(TEST_PKG) \
+		$(GINKGO_FLAGS) \
+		--skip-package=$(SKIP_PACKAGES) $(TEST_PKG) \
 		-failOnPending \
 		-randomizeAllSpecs \
 		-randomizeSuites \
 		-keepGoing
 	$(DEPSGOBIN)/goimports -w .
 
-run-test:
-	PATH=$(DEPSGOBIN):$$PATH ginkgo $(GINKGO_FLAGS) $(TEST_PKG)
+test-clusters:
+	@kind create cluster --name skv2-test-master 2> /dev/null || true
+	@kind create cluster --name skv2-test-remote 2> /dev/null || true
+
+# CI workflow for running tests
+run-all: REMOTE_CLUSTER_CONTEXT ?= kind-skv2-test-remote
+run-all: test-clusters
+	@go test ./...
+	@goimports -w .
 
 #----------------------------------------------------------------------------------
 # Third Party License Management

diff --git a/changelog/v0.40.7/issue-582.yaml b/changelog/v0.40.7/issue-582.yaml
@@ -0,0 +1,6 @@
+changelog:
+  - type: NEW_FEATURE
+    issueLink: https://github.com/solo-io/skv2/issues/582
+    description: >
+      Support extraVolumes/extraVolumeMounts fields which can be passed in by the user from helm values.
+    skipCI: "false"
diff --git a/codegen/cmd_test.go b/codegen/cmd_test.go
@@ -44,6 +44,240 @@ var _ = Describe("Cmd", func() {
 		"encoding/protobuf/cue/cue.proto",
 	}
 
+	{
+		type TestEntry struct {
+			name                    string
+			values                  any
+			staticVolumes           []v1.Volume
+			conditionalVolumes      []ConditionalVolume
+			staticVolumeMounts      []v1.VolumeMount
+			conditionalVolumeMounts []ConditionalVolumeMount
+		}
+
+		DescribeTable(
+			"extraVolume/extraVolumeMounts",
+			Ordered, func(entry TestEntry, expectedVolumes, expectedVolumeMounts int) {
+				cmd := &Command{
+					Chart: &Chart{
+						Data: Data{
+							ApiVersion:  "v1",
+							Description: "",
+							Name:        "Painting Operator",
+							Version:     "v0.0.1",
+							Home:        "https://docs.solo.io/skv2/latest",
+							Sources: []string{
+								"https://github.com/solo-io/skv2",
+							},
+						},
+						Operators: []Operator{{
+							Name: "painter",
+							Deployment: Deployment{
+								Container: Container{
+									Image: Image{
+										Tag:        "v0.0.0",
+										Repository: "painter",
+										Registry:   "quay.io/solo-io",
+										PullPolicy: "IfNotPresent",
+									},
+									VolumeMounts:            entry.staticVolumeMounts,
+									ConditionalVolumeMounts: entry.conditionalVolumeMounts,
+								},
+								Volumes:            entry.staticVolumes,
+								ConditionalVolumes: entry.conditionalVolumes,
+							},
+						}},
+					},
+					ManifestRoot: fmt.Sprintf("codegen/test/chart/%s", entry.name),
+				}
+				Expect(cmd.Execute()).NotTo(HaveOccurred(), "failed to execute command")
+
+				manifests := helmTemplate(fmt.Sprintf("./test/chart/%s", entry.name), entry.values)
+
+				var (
+					renderedDeployment *appsv1.Deployment
+					decoder            = kubeyaml.NewYAMLOrJSONDecoder(bytes.NewBuffer(manifests), 4096)
+				)
+				for {
+					var deployment appsv1.Deployment
+					if err := decoder.Decode(&deployment); errors.Is(err, io.EOF) {
+						break
+					}
+
+					if deployment.GetName() == "painter" && deployment.Kind == "Deployment" {
+						renderedDeployment = &deployment
+						break
+					}
+				}
+
+				Expect(renderedDeployment.Spec.Template.Spec.Volumes).To(HaveLen(expectedVolumes))
+
+				Expect(renderedDeployment.Spec.Template.Spec.Containers).To(HaveLen(1))
+
+				Expect(renderedDeployment.Spec.Template.Spec.Containers[0].VolumeMounts).To(HaveLen(expectedVolumes))
+			},
+			Entry(
+				"empty with no volumes",
+				TestEntry{
+					name: "extra-volumes",
+					values: map[string]any{
+						"painter": map[string]any{
+							"enabled": true,
+							"extraVolumes": []v1.Volume{{
+								Name: "extra-certs",
+								VolumeSource: v1.VolumeSource{
+									Secret: &v1.SecretVolumeSource{
+										SecretName: "extra-secret",
+									},
+								},
+							}},
+							"extraVolumeMounts": []v1.VolumeMount{{
+								Name:      "extra-certs",
+								MountPath: "/etc/ssl/certs",
+							}},
+						},
+					},
+				},
+				0,
+				0,
+			),
+			Entry(
+				"with static volumes",
+				TestEntry{
+					name: "static-volumes",
+					values: map[string]any{
+						"painter": map[string]any{
+							"enabled": true,
+							"extraVolumes": []v1.Volume{{
+								Name: "extra-certs",
+								VolumeSource: v1.VolumeSource{
+									Secret: &v1.SecretVolumeSource{
+										SecretName: "extra-secret",
+									},
+								},
+							}},
+							"extraVolumeMounts": []v1.VolumeMount{{
+								Name:      "extra-certs",
+								MountPath: "/etc/ssl/extra",
+							}},
+						},
+					},
+					staticVolumes: []v1.Volume{{
+						Name: "static-certs",
+						VolumeSource: v1.VolumeSource{
+							Secret: &v1.SecretVolumeSource{
+								SecretName: "static-secret",
+							},
+						},
+					}},
+					staticVolumeMounts: []v1.VolumeMount{{
+						Name:      "static-certs",
+						MountPath: "/var/run/secret/static",
+					}},
+				},
+				2,
+				2,
+			),
+			Entry(
+				"with conditional volumes",
+				TestEntry{
+					name: "conditional-volumes",
+					values: map[string]any{
+						"painter": map[string]any{
+							"enabled": true,
+							"extraVolumes": []v1.Volume{{
+								Name: "extra-certs",
+								VolumeSource: v1.VolumeSource{
+									Secret: &v1.SecretVolumeSource{
+										SecretName: "extra-secret",
+									},
+								},
+							}},
+							"extraVolumeMounts": []v1.VolumeMount{{
+								Name:      "extra-certs",
+								MountPath: "/etc/ssl/extra",
+							}},
+						},
+					},
+					conditionalVolumes: []ConditionalVolume{{
+						Condition: ".Values.painter.enabled",
+						Volume: v1.Volume{
+							Name: "conditional-certs",
+							VolumeSource: v1.VolumeSource{
+								Secret: &v1.SecretVolumeSource{
+									SecretName: "conditional-secret",
+								},
+							},
+						},
+					}},
+					conditionalVolumeMounts: []ConditionalVolumeMount{{
+						Condition: ".Values.painter.enabled",
+						VolumeMount: v1.VolumeMount{
+							Name:      "conditional-certs",
+							MountPath: "/var/run/secret/conditional",
+						},
+					}},
+				},
+				2,
+				2,
+			),
+			Entry(
+				"with all volumes",
+				TestEntry{
+					name: "all-volumes",
+					values: map[string]any{
+						"painter": map[string]any{
+							"enabled": true,
+							"extraVolumes": []v1.Volume{{
+								Name: "extra-certs",
+								VolumeSource: v1.VolumeSource{
+									Secret: &v1.SecretVolumeSource{
+										SecretName: "extra-secret",
+									},
+								},
+							}},
+							"extraVolumeMounts": []v1.VolumeMount{{
+								Name:      "extra-certs",
+								MountPath: "/etc/ssl/extra",
+							}},
+						},
+					},
+					staticVolumes: []v1.Volume{{
+						Name: "static-certs",
+						VolumeSource: v1.VolumeSource{
+							Secret: &v1.SecretVolumeSource{
+								SecretName: "static-secret",
+							},
+						},
+					}},
+					conditionalVolumes: []ConditionalVolume{{
+						Condition: ".Values.painter.enabled",
+						Volume: v1.Volume{
+							Name: "conditional-certs",
+							VolumeSource: v1.VolumeSource{
+								Secret: &v1.SecretVolumeSource{
+									SecretName: "conditional-secret",
+								},
+							},
+						},
+					}},
+					staticVolumeMounts: []v1.VolumeMount{{
+						Name:      "static-certs",
+						MountPath: "/var/run/secret/static",
+					}},
+					conditionalVolumeMounts: []ConditionalVolumeMount{{
+						Condition: ".Values.painter.enabled",
+						VolumeMount: v1.VolumeMount{
+							Name:      "conditional-certs",
+							MountPath: "/var/run/secret/conditional",
+						},
+					}},
+				},
+				3,
+				3,
+			),
+		)
+	}
+
 	Describe("image pull secrets", Ordered, func() {
 		BeforeAll(func() {
 			cmd := &Command{

diff --git a/codegen/templates/chart/operator-deployment.yamltmpl b/codegen/templates/chart/operator-deployment.yamltmpl
@@ -105,9 +105,15 @@ spec:
 [[- end ]]
 [[- if $volumes ]]
       volumes:
-[[ toYaml $volumes | indent 6 ]]
+      [[- toYaml $volumes | nindent 6 ]]
+      {{- if [[ (opVar $operator) ]].extraVolumes }}
+        {{- tpl (toYaml [[ (opVar $operator) ]].extraVolumes) . | nindent 6 }}
+      {{- end }}
 [[- else if $conditionalVolumes ]]
       volumes:
+      {{- if [[ (opVar $operator) ]].extraVolumes }}
+        {{- tpl (toYaml [[ (opVar $operator) ]].extraVolumes) . | nindent 6 }}
+      {{- end }}     
 [[- end ]]
 [[- range $v := $conditionalVolumes ]]
 {{- if [[ $v.Condition ]] }}
@@ -178,9 +184,15 @@ spec:
 {{- end }}
 [[- if $container.VolumeMounts ]]
         volumeMounts:
-[[ toYaml $container.VolumeMounts | indent 8 ]]
+        [[- toYaml $container.VolumeMounts | nindent 8 ]]
+        {{- if [[ (opVar $operator) ]].extraVolumeMounts }}
+          {{- tpl (toYaml [[ (opVar $operator) ]].extraVolumeMounts) . | nindent 8 }}
+        {{- end }}        
 [[- else if $container.ConditionalVolumeMounts ]]
         volumeMounts:
+        {{- if [[ (opVar $operator) ]].extraVolumeMounts }}
+          {{- tpl (toYaml [[ (opVar $operator) ]].extraVolumeMounts) . | nindent 8 }}
+        {{- end }}        
 [[- end ]]
 [[- range $v := $container.ConditionalVolumeMounts ]]
 {{- if [[ $v.Condition ]] }}

diff --git a/codegen/test/chart-no-desc/templates/deployment.yaml b/codegen/test/chart-no-desc/templates/deployment.yaml
@@ -42,6 +42,9 @@ spec:
       volumes:
       - emptyDir: {}
         name: paint
+      {{- if $.Values.painter.extraVolumes }}
+        {{- tpl (toYaml $.Values.painter.extraVolumes) . | nindent 6 }}
+      {{- end }}
       containers:
 {{- $painter := $.Values.painter }}
 {{- $painterImage := $painter.image }}
@@ -116,6 +119,9 @@ spec:
         volumeMounts:
         - mountPath: /etc/paint
           name: paint
+        {{- if $.Values.painter.extraVolumeMounts }}
+          {{- tpl (toYaml $.Values.painter.extraVolumeMounts) . | nindent 8 }}
+        {{- end }}
         resources:
 {{- if $palette.resources }}
 {{ toYaml $palette.resources | indent 10}}

diff --git a/codegen/test/chart/all-volumes/Chart.yaml b/codegen/test/chart/all-volumes/Chart.yaml
@@ -0,0 +1,8 @@
+# Code generated by skv2. DO NOT EDIT.
+
+apiVersion: v1
+home: https://docs.solo.io/skv2/latest
+name: Painting Operator
+sources:
+- https://github.com/solo-io/skv2
+version: v0.0.1