Add support for ephemeral volume (configMap) (#61)

gimlet-io · Mar 16, 2023 · 5660435 · 5660435
1 parent 96cbc7e
commit 5660435
Show file tree

Hide file tree

Showing 11 changed files with 279 additions and 80 deletions.
diff --git a/charts/common/templates/_customFileConfigmap.yaml b/charts/common/templates/_customFileConfigmap.yaml
@@ -0,0 +1,16 @@
+{{- define "common.customFileConfigmap.tpl" -}}
+{{- range .Values.volumes }}
+  {{- if .fileName }}
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ template "common.robustName" .fileName }}
+  namespace: {{ $.Release.Namespace }}
+data:
+  {{ .fileName }}: |
+    {{- .fileContent | nindent 4 }}
+
+  {{- end }}  
+{{- end }}
+{{- end -}}
diff --git a/charts/common/templates/_pvc.yaml b/charts/common/templates/_pvc.yaml
@@ -1,6 +1,6 @@
 {{- define "common.pvc.tpl" -}}
 {{- range .Values.volumes }}
-{{- if not (or .existingClaim .hostPath) }}
+{{- if not (or .existingClaim .hostPath .fileName .emptyDir .existingConfigMap) }}
 {{- $robustName := include "common.robustName" $.Release.Name }}
 ---
 apiVersion: v1
@@ -23,4 +23,4 @@ spec:
       storage: {{ .size | default "1Gi" }}
 {{- end }}
 {{- end }}
-{{- end -}}
+{{- end -}}
diff --git a/charts/common/templates/_volumeMountsRef.yaml b/charts/common/templates/_volumeMountsRef.yaml
@@ -2,9 +2,21 @@
 {{- if or (or (or (.Values.volumes) (.Values.sealedFileSecrets)) .Values.fileSecrets) .Values.existingFileSecrets }}
 volumeMounts: &volumeMounts
 {{- range .Values.volumes }}
-  - name: {{ .name }}
-    mountPath: {{ .path }}
+
+{{- $volumeName := .name -}}
+{{- if .existingConfigMap }}
+{{- $volumeName = .existingConfigMap -}}
+{{- end }}
+{{- if .fileName }}
+{{- $volumeName = include "common.robustName" .fileName -}}
 {{- end }}
+
+  - name: {{ $volumeName }}
+    mountPath: {{ .path }}
+    {{- if .subPath }}
+    subPath: {{ .subPath }}
+    {{- end }}
+{{- end }}    
 {{- range .Values.sealedFileSecrets }}
   - name: {{ .name }}
     mountPath: {{ .path }}
@@ -25,3 +37,4 @@ volumeMounts: &volumeMounts
 {{- end }}
 {{- end }}
 {{- end }}
+
diff --git a/charts/common/templates/_volumesRef.yaml b/charts/common/templates/_volumesRef.yaml
@@ -2,9 +2,24 @@
 {{- if or (or (or (.Values.volumes) (.Values.sealedFileSecrets)) .Values.fileSecrets) .Values.existingFileSecrets }}
 volumes:
   {{- range .Values.volumes }}
-  - name: {{ .name }}
+
+{{- $volumeName := .name -}}
+{{- if .existingConfigMap }}
+{{- $volumeName = .existingConfigMap -}}
+{{- end }}
+{{- if .fileName }}
+{{- $volumeName = include "common.robustName" .fileName -}}
+{{- end }}
+
+  - name: {{ $volumeName }}
     {{- if .emptyDir }}
     emptyDir: {}
+    {{- else if .existingConfigMap }}
+    configMap:
+      name: {{ .existingConfigMap }}
+    {{- else if .fileName }}
+    configMap:
+      name: {{ $volumeName }}
     {{- else if .hostPath }}
     hostPath:
       path: {{ .hostPath.path }}
@@ -18,8 +33,8 @@ volumes:
       {{ else }}
       claimName: {{ printf "%s-%s" $.Release.Name .name }}
       {{- end }}
-    {{- end }}
-  {{- end }}
+      {{- end }}
+{{- end }}     
   {{- range .Values.sealedFileSecrets }}
   - name: {{ .name }}
     secret:

diff --git a/charts/cron-job/charts/common-0.2.0.tgz b/charts/cron-job/charts/common-0.2.0.tgz
diff --git a/charts/onechart/charts/common-0.2.0.tgz b/charts/onechart/charts/common-0.2.0.tgz
diff --git a/charts/onechart/helm-ui.json b/charts/onechart/helm-ui.json
@@ -115,11 +115,14 @@
     "uiSchema": {
       "#/properties/volumes": {
         "items": {
-        "emptyDir": {
-          "ui:widget": "hidden"
+          "emptyDir": {
+            "ui:widget": "hidden"
+          },
+          "configMapValue": {
+            "ui:widget": "textarea"
+          }
         }
       }
-      }
     },
     "metaData": {
       "name": "Volumes",

diff --git a/charts/onechart/templates/custom-file-configmap.yaml b/charts/onechart/templates/custom-file-configmap.yaml
@@ -0,0 +1 @@
+{{- include "common.customFileConfigmap.tpl" . -}}
diff --git a/charts/onechart/tests/custom_file_configmap_test.yaml b/charts/onechart/tests/custom_file_configmap_test.yaml
@@ -0,0 +1,22 @@
+suite: test deployment
+templates:
+  - custom-file-configmap.yaml
+tests:
+  - it: Should create configmaps for custom string files
+    set:
+      volumes:
+        - fileName: myFile.conf
+          fileContent: |
+              blablabla
+              bla
+          path: /randomPath/myFile.conf
+          subPath: myFile.conf
+    asserts:
+      - hasDocuments:
+          count: 1
+      - equal:
+          path: data
+          value:
+            myFile.conf: |
+              blablabla
+              bla
diff --git a/charts/onechart/tests/deployment_volumes_test.yaml b/charts/onechart/tests/deployment_volumes_test.yaml
@@ -116,3 +116,61 @@ tests:
             - name: data
               hostPath:
                 path: /somewhere/over/the/rainbow
+  - it: Should use emptyDir
+    set:
+      volumes:
+        - name: myScratchDisk
+          path: /randomPath
+          emptyDir: true
+    asserts:
+      - equal:
+          path: spec.template.spec.volumes
+          value:
+            - name: myScratchDisk
+              emptyDir: {}
+      - equal:
+          path: spec.template.spec.containers[0].volumeMounts
+          value:
+            - name: myScratchDisk
+              mountPath: /randomPath
+  - it: Should use a configMap
+    set:
+      volumes:
+        - existingConfigMap: my-configmap
+          path: /randomPath/app.conf
+          subPath: app.conf
+    asserts:
+      - equal:
+          path: spec.template.spec.volumes
+          value:
+            - name: my-configmap
+              configMap:
+                name: my-configmap
+      - equal:
+          path: spec.template.spec.containers[0].volumeMounts
+          value:
+            - name: my-configmap
+              mountPath: /randomPath/app.conf
+              subPath: app.conf
+  - it: Should use a configmap with custom value
+    set:
+      volumes:
+        - fileName: myfile.conf
+          fileContent: |
+              blablabla
+              bla
+          path: /randomPath/myfile.conf
+          subPath: myfile.conf
+    asserts:
+      - equal:
+          path: spec.template.spec.volumes
+          value:
+            - name: myfile-conf
+              configMap:
+                name: myfile-conf
+      - equal:
+          path: spec.template.spec.containers[0].volumeMounts
+          value:
+            - name: myfile-conf
+              mountPath: /randomPath/myfile.conf
+              subPath: myfile.conf