Added support for string template rendering in additional properties fields

CHANGELOG.md

@@ -1,5 +1,19 @@
 # GraphDB Helm chart release notes
 
+## Version 12.2.0
+
+### New
+
+- Added support for string template rendering in the following properties:
+  - `extraEnvFrom`
+  - `extraEnv`
+  - `extraVolumes`
+  - `extraVolumeMounts`
+  - `extraVolumeClaimTemplates`
+  - `extraInitContainers`
+  - `extraContainerPorts`
+  - `extraContainers`
+
 ## Version 12.1.0
 
 ### New

examples/templated-extra-objects-and-fields/README.md

@@ -0,0 +1,18 @@
+# Templated Extra Objects and Chart values Example
+
+This example shows how to configure the extra chart values with templated items.
+
+## Configuration
+
+The default [values.yaml](values.yaml) in the example creates an additional configmap resource and
+environment variables which reference sections from values.yaml. The additional configmap and environment variables are templated with Helm
+and have use of `include`, `tpl`, `range` and `if`. Other templating functions are also supported.
+
+NOTE: For templated resources in extraObjects, extraEnv, extraVolumes, etc., they need to be a string instead of YAML
+object.
+
+## Usage
+
+```bash
+helm upgrade --install --values ./values.yaml graphdb ontotext/graphdb
+```

examples/templated-extra-objects/values.yaml → examples/templated-extra-objects-and-fields/values.yaml

@@ -43,3 +43,17 @@ extraObjects:
       resources:
         requests:
           storage: 5Gi
+
+extraEnv:
+  - name: JVM_OPTS
+    value: "-Xms512m -Xmx1024m"
+  - name: GDB_REPLICA_ID
+    value: "{{ $.Release.Name }}"
+  - |
+    - name: CLUSTER_NAME
+      value: "{{ $.Release.Name }}"
+  - |
+    {{- if and .Values.randomCM.enabled (eq .Values.randomCM.values.key1 "value1") }}
+    - name: NODE_ID
+      value: test
+    {{- end }}

templates/_helpers.tpl

@@ -115,3 +115,24 @@ Calculate provisoner's bcrypt-hashed password
 {{- define "graphdb.security.provisioner.passwordHash" -}}
   {{- printf "%s" ( htpasswd .Values.security.provisioner.username .Values.security.provisioner.password | trimPrefix (printf "%s:" .Values.security.provisioner.username)) -}}
 {{- end -}}
+
+{{/*
+Render a mixed list (strings or maps) into a normalized YAML list.
+Useful when values may contain templated strings or raw YAML objects.
+*/}}
+{{- define "render.mixedList.toYaml" -}}
+{{- $ctx := .ctx -}}
+{{- $items := .items | default (list) -}}
+{{- range $raw := $items }}
+  {{- if kindIs "string" $raw -}}
+      {{- $val := fromYamlArray (tpl $raw $ctx) -}}
+      {{- if $val }}
+      {{- toYaml $val | nindent 0 -}}
+      {{- end }}
+  {{- else -}}
+  {{- $m := fromYaml (tpl (toYaml $raw) $ctx ) -}}
+  {{- $list := list $m -}}
+  {{- toYaml $list | nindent 0  -}}
+  {{- end -}}
+{{ end }}
+{{- end -}}

templates/extra-objects.yaml

@@ -1,5 +1,7 @@
-{{ range .Values.extraObjects }}
+{{- if .Values.extraObjects -}}
+  {{- $objs := include "render.list.singleMaps" (dict "ctx" $ "items" .Values.extraObjects) | fromYamlArray -}}
+  {{- range $obj := $objs }}
 ---
-{{- $value := typeIs "string" . | ternary . (. | toYaml) }}
-{{ tpl $value $ }}
-{{ end }}
+{{ toYaml $obj | nindent 0 }}
+  {{- end -}}
+  {{- end -}}

templates/graphdb/statefulset.yaml

@@ -48,7 +48,7 @@ spec:
         {{- toYaml .Values.import.volumeMount.volumeClaimTemplate.spec | nindent 8 }}
     {{- end }}
     {{- with .Values.extraVolumeClaimTemplates }}
-      {{- tpl (toYaml .) $ | nindent 4 }}
+      {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 4 }}
     {{- end }}
   {{- end }}
   template:
@@ -219,7 +219,7 @@ spec:
               {{- end }}
         {{- end }}
         {{- with .Values.extraVolumes }}
-          {{- tpl (toYaml .) $ | nindent 8 }}
+          {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 8 }}
         {{- end }}
       {{- with .Values.nodeSelector }}
       nodeSelector: {{- tpl (toYaml .) $ | nindent 8 }}
@@ -404,7 +404,7 @@ spec:
 
               echo 'Done'
         {{- with .Values.extraInitContainers }}
-          {{- tpl (toYaml .) $ | nindent 8 }}
+          {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 8 }}
         {{- end }}
       containers:
         - name: {{ .Chart.Name }}
@@ -425,16 +425,17 @@ spec:
               containerPort: {{ .Values.containerPorts.rpc }}
             {{- end }}
             {{- with .Values.extraContainerPorts }}
-              {{- toYaml . | nindent 12 }}
+              {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim nindent 12 }}
             {{- end }}
           envFrom:
             - configMapRef:
                 name: {{ include "graphdb.fullname.configmap.environment" . }}
             {{- with .Values.extraEnvFrom }}
-              {{- tpl (toYaml .) $ | nindent 12 }}
+              {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 12 }}
             {{- end }}
           {{- with .Values.extraEnv }}
-          env: {{- tpl (toYaml .) $ | nindent 12 }}
+          env:
+            {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 12 }}
           {{- end }}
           volumeMounts:
             - name: {{ .Values.persistence.volumeClaimTemplate.name }}
@@ -464,7 +465,7 @@ spec:
               mountPath: {{ .Values.cluster.tls.mountPath }}
             {{- end }}
             {{- with .Values.extraVolumeMounts }}
-              {{- tpl (toYaml .) $ | nindent 12 }}
+              {{- include "render.list.singleMaps" (dict "ctx" $ "items" .)| trim | nindent 12 }}
             {{- end }}
           {{- with .Values.resources }}
           resources: {{ toYaml . | nindent 12 }}
@@ -482,5 +483,5 @@ spec:
           livenessProbe: {{- toYaml . | nindent 12 }}
           {{- end }}
         {{- with .Values.extraContainers }}
-          {{ tpl (toYaml .) $ | nindent 8 }}
+          {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 8 }}
         {{- end }}

templates/proxy/statefulset.yaml

@@ -37,7 +37,7 @@ spec:
         {{- toYaml .Values.proxy.persistence.volumeClaimTemplate.spec | nindent 8 }}
     {{- end }}
     {{- with .Values.proxy.extraVolumeClaimTemplates }}
-      {{- tpl (toYaml .) $ | nindent 4 }}
+      {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 4 }}
     {{- end }}
   {{- end }}
   template:
@@ -187,7 +187,7 @@ spec:
               {{- end }}
         {{- end }}
         {{- with .Values.proxy.extraVolumes }}
-          {{- tpl (toYaml .) $ | nindent 8 }}
+          {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 8 }}
         {{- end }}
       {{- with .Values.proxy.nodeSelector }}
       nodeSelector: {{- tpl (toYaml .) $ | nindent 8 }}
@@ -347,7 +347,7 @@ spec:
 
               echo 'Done'
         {{- with .Values.proxy.extraInitContainers }}
-          {{- toYaml . | nindent 8 }}
+          {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 8 }}
         {{- end }}
       containers:
         - name: {{ include "graphdb-proxy.chartName" . }}
@@ -366,18 +366,19 @@ spec:
             - configMapRef:
                 name: {{ include "graphdb-proxy.fullname.configmap.environment" . }}
             {{- with .Values.proxy.extraEnvFrom }}
-              {{- tpl (toYaml .) $ | nindent 12 }}
+              {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 12 }}
             {{- end }}
           {{- with .Values.proxy.extraEnv }}
-          env: {{- tpl (toYaml .) $ | nindent 12 }}
+          env:
+            {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 12 }}
           {{- end }}
           ports:
             - name: http
               containerPort: {{ .Values.proxy.containerPorts.http }}
             - name: rpc
               containerPort: {{ .Values.proxy.containerPorts.rpc }}
             {{- with .Values.proxy.extraContainerPorts }}
-              {{- toYaml . | nindent 12 }}
+              {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 12 }}
             {{- end }}
           volumeMounts:
             - name: {{ .Values.proxy.persistence.volumeClaimTemplate.name }}
@@ -396,7 +397,7 @@ spec:
               mountPath: {{ .Values.cluster.tls.mountPath }}
             {{- end }}
             {{- with .Values.proxy.extraVolumeMounts }}
-              {{- toYaml . | nindent 12 }}
+              {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 12 }}
             {{- end }}
           {{- with .Values.proxy.resources }}
           resources: {{ toYaml . | nindent 12 }}
@@ -414,6 +415,6 @@ spec:
           livenessProbe: {{- toYaml . | nindent 12 }}
           {{- end }}
         {{- with .Values.proxy.extraContainers }}
-          {{ tpl (toYaml .) $ | nindent 8 }}
+          {{- include "render.list.singleMaps" (dict "ctx" $ "items" .) | trim | nindent 8 }}
         {{- end }}
 {{- end }}