introduce the concept of configVariables

they are environment variables that can be sourced from raw values or any other env source and can also be templated to refer to values from helm. they can be defined globally or per service, while per service definitions overwrite globals.

Author: pschichtel

charts/docspell/Chart.yaml

@@ -3,8 +3,7 @@ name: docspell
 description: A Helm chart to deploy docspell to Kubernetes
 home: https://docspell.org/
 type: application
-version: 0.0.19
+version: 0.0.20
 # this only tracks the restserver, but restserver's and joex's versions are synced
 # renovate: image=ghcr.io/docspell/restserver
 appVersion: "0.43.0"
-

charts/docspell/templates/_helpers.tpl

@@ -49,3 +49,28 @@ Selector labels
 app.kubernetes.io/name: {{ include "docspell.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
+
+{{- define "docspell.configVariables" -}}
+{{- $configVars := dict }}
+{{- range $source := .Sources -}}
+{{- $configVars = mergeOverwrite $configVars (deepCopy $source) -}}
+{{- end }}
+{{- range $name, $config := $configVars }}
+{{- if $config.value }}
+- name: {{ $name }}
+{{- if $config.template }}
+  value: {{ tpl $config.value $.Root | quote }}
+{{- else }}
+  value: {{ $config.value | quote }}
+{{- end }}
+{{- else if $config.valueFrom }}
+- name: {{ $name }}
+{{- if $config.template }}
+  valueFrom: {{- tpl ($config.valueFrom | toYaml) $.Root | nindent 4 }}
+{{- else }}
+  valueFrom: {{- $config.valueFrom | nindent 4 }}
+{{- end }}
+{{- else }}
+{{- end }}
+{{- end }}
+{{- end }}

charts/docspell/templates/statefulset-joex.yml

@@ -36,9 +36,8 @@ spec:
         {{- end }}
         - '--'
         - '/opt/docspell.conf'
-        envFrom:
-        - secretRef:
-            name: {{ .Values.jdbc.credentialsSecretName }}
+        env:
+        {{- include "docspell.configVariables" (dict "Sources" (list .Values.configVariables .Values.joex.configVariables) "Root" $) | nindent 8 }}
         ports:
         - name: api
           containerPort: 7878

charts/docspell/templates/statefulset-restserver.yml

@@ -28,9 +28,8 @@ spec:
         image: {{ print .Values.restserver.image.repo ":" (.Values.restserver.image.tag | default .Values.image.tag | default (print "v" .Chart.AppVersion)) | quote }}
         imagePullPolicy: {{ .Values.restserver.image.pullPolicy | default .Values.image.pullPolicy | quote }}
         args: ['/opt/docspell.conf']
-        envFrom:
-        - secretRef:
-            name: {{ .Values.jdbc.credentialsSecretName }}
+        env:
+        {{- include "docspell.configVariables" (dict "Sources" (list .Values.configVariables .Values.restserver.configVariables) "Root" $) | nindent 8 }}
         volumeMounts:
         - name: config
           mountPath: /opt/docspell.conf

charts/docspell/values.yaml

@@ -11,6 +11,12 @@ jdbc:
   port: 5432
   database: docspell
   credentialsSecretName: credentialsSecretName
+  config: |
+    jdbc {
+      url = ${JDBC_URI}
+      user = ${JDBC_USERNAME}
+      password = ${JDBC_PASSWORD}
+    }
 
 files:
   config: ''
@@ -23,11 +29,29 @@ fullTextSearchConfig: |
     use-default-connection = true
   }
 
+configVariables:
+  JDBC_URI:
+    template: true
+    value: 'jdbc:postgresql://{{ .Values.jdbc.host }}:{{ .Values.jdbc.port }}/{{ .Values.jdbc.database }}'
+  JDBC_USERNAME:
+    template: true
+    valueFrom:
+      secretKeyRef:
+        name: '{{ .Values.jdbc.credentialsSecretName }}'
+        key: username
+  JDBC_PASSWORD:
+    template: true
+    valueFrom:
+      secretKeyRef:
+        name: '{{ .Values.jdbc.credentialsSecretName }}'
+        key: password
+
 restserver:
   image:
     repo: 'ghcr.io/docspell/restserver'
     tag: null
     pullPolicy: null
+  configVariables: {}
   replicas: 1
   resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
@@ -90,11 +114,7 @@ restserver:
 
       # Configuration for the backend.
       backend {
-        jdbc {
-          url = {{ print "jdbc:postgresql://" .Values.jdbc.host ":" .Values.jdbc.port "/" .Values.jdbc.database | quote }}
-          user = ${username}
-          password = ${password}
-        }
+        {{- tpl (.Values.jdbc.config | default "" | nindent 4) $ }}
 
         # Configuration for registering new users.
         signup {
@@ -121,6 +141,7 @@ joex:
     repo: 'ghcr.io/docspell/joex'
     tag: null
     pullPolicy: null
+  configVariables: {}
   replicas: 1
   resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
@@ -143,11 +164,7 @@ joex:
         port = 7878
       }
 
-      jdbc {
-        url = {{ print "jdbc:postgresql://" .Values.jdbc.host ":" .Values.jdbc.port "/" .Values.jdbc.database | quote }}
-        user = ${username}
-        password = ${password}
-      }
+      {{- tpl (.Values.jdbc.config | default "" | nindent 2) $ }}
 
       full-text-search {
         {{- .Values.fullTextSearchConfig | nindent 4 }}