feat: add ConfigMap support for static configuration (#81)

morremeyer · Apr 15, 2022 · ac4ae23 · ac4ae23
1 parent b20776a
commit ac4ae23
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 4 deletions.
diff --git a/charts/cronjob/Chart.yaml b/charts/cronjob/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: cronjob
 description: Run jobs on a schedule
 type: application
-version: 2.0.5
+version: 2.1.0
 maintainers:
   - name: morremeyer
     email: [email protected]
diff --git a/charts/cronjob/README.md b/charts/cronjob/README.md
@@ -1,6 +1,6 @@
 # cronjob
 
-![Version: 2.0.5](https://img.shields.io/badge/Version-2.0.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 Run jobs on a schedule
 
@@ -33,6 +33,22 @@ envValueFrom:
       key: user
 ```
 
+### configMap
+
+If you want to pass yaml as a value, you need to specify it in block style:
+
+```yaml
+configMap:
+  enabled: true
+  data:
+    config.yml: |
+      foo: bar
+      map:
+        list:
+          - foo
+          - bar
+```
+
 ## Upgrading
 
 ### To 2.0.0
@@ -60,6 +76,10 @@ The following default values have been changed:
 | annotations | object | `{}` |  |
 | args | list | `[]` | arguments to pass to the command or binary being run |
 | command | list | `[]` | the command or binary to run |
+| configMap.data | object | `{}` | The data for the ConfigMap. Both keys and values need to be strings. |
+| configMap.enabled | bool | `false` | If a ConfigMap with configurable values should be created |
+| configMap.mountFiles | list | `[]` | Mounting of individual keys in the ConfigMap as files |
+| configMap.mountPath | string | `""` | If specified, the ConfigMap is mounted as a directory at this path |
 | env | list | `[]` | Directly set environment variables |
 | envValueFrom | object | `{}` | Set environment variables from configMaps or Secrets |
 | failedJobsHistoryLimit | string | `nil` | The number of failed finished jobs to retain. |

diff --git a/charts/cronjob/README.md.gotmpl b/charts/cronjob/README.md.gotmpl
@@ -31,6 +31,22 @@ envValueFrom:
       key: user
 ```
 
+### configMap
+
+If you want to pass yaml as a value, you need to specify it in block style:
+
+```yaml
+configMap:
+  enabled: true
+  data:
+    config.yml: |
+      foo: bar
+      map:
+        list:
+          - foo
+          - bar
+```
+
 ## Upgrading
 
 ### To 2.0.0

diff --git a/charts/cronjob/templates/configmap.yaml b/charts/cronjob/templates/configmap.yaml
@@ -0,0 +1,13 @@
+{{- if .Values.configMap.enabled }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "cronjob.fullname" . }}
+  labels:
+    {{- include "cronjob.labels" . | nindent 4 }}
+data:
+  {{- range $key, $value := .Values.configMap.data }}
+  {{ $key }}: |
+    {{- $value | nindent 4 }}
+  {{- end }}
+{{- end }}
diff --git a/charts/cronjob/templates/cronjob.yaml b/charts/cronjob/templates/cronjob.yaml
@@ -67,12 +67,23 @@ spec:
                   valueFrom: {{- $value | toYaml | nindent 20 }}
                 {{- end }}
               {{- end }}
-              {{- if or .Values.persistence.enabled .Values.additionalVolumeMounts }}
+              {{- if or .Values.persistence.enabled .Values.additionalVolumeMounts .Values.configMap.mountPath .Values.configMap.mountFiles }}
               volumeMounts:
                 {{- if .Values.persistence.enabled }}
                 - name: data
                   mountPath: {{ .Values.persistence.mountPath }}
                 {{- end }}
+                {{- with .Values.configMap.mountPath }}
+                - name: configmap
+                  mountPath: {{ . }}
+                  readOnly: true
+                {{- end }}
+                {{- range $file := .Values.configMap.mountFiles }}
+                - name: configmap
+                  mountPath: {{ .mountPath }}
+                  subPath: {{ .subPath }}
+                  readOnly: true
+                {{- end }}
               {{- with .Values.additionalVolumeMounts }}
                 {{- toYaml . | nindent 16 }}
               {{- end }}
@@ -89,7 +100,7 @@ spec:
           {{- with .Values.tolerations }}
           tolerations: {{- toYaml . | nindent 12 }}
           {{- end }}
-          {{- if or .Values.persistence.enabled .Values.additionalVolumes }}
+          {{- if or .Values.persistence.enabled .Values.additionalVolumes .Values.configMap.mountPath .Values.configMap.mountFiles }}
           volumes:
             {{- if .Values.persistence.enabled }}
             - name: data
@@ -99,4 +110,9 @@ spec:
             {{- with .Values.additionalVolumes }}
             {{- toYaml . | nindent 12 }}
             {{- end }}
+            {{- if or .Values.configMap.mountPath .Values.configMap.mountFiles }}
+            - name: configmap
+              configMap:
+                name: {{ include "cronjob.fullname" . }}
+            {{- end }}
           {{- end }}
diff --git a/charts/cronjob/values.yaml b/charts/cronjob/values.yaml
@@ -60,6 +60,21 @@ labels: {}
 
 annotations: {}
 
+configMap:
+  # -- If a ConfigMap with configurable values should be created
+  enabled: false
+
+  # -- The data for the ConfigMap. Both keys and values need to be strings.
+  data: {}
+
+  # -- If specified, the ConfigMap is mounted as a directory at this path
+  mountPath: ""
+
+  # -- Mounting of individual keys in the ConfigMap as files
+  mountFiles: []
+    # - subPath: "config.yml"
+    #   mountPath: /app/config.yml
+
 persistence:
   enabled: false