feat: add support for external postgres secrets in listmonk chart

- Add helper templates for postgres secret name and key resolution
- Support existing secrets via existingSecret and secretKey values
- Restructure values under listmonk namespace for better organization
- Bump chart version to 0.5.0

Author: gcordalis

charts/listmonk/Chart.yaml

@@ -3,4 +3,4 @@ appVersion: "5.1.0"
 description: High performance, self-hosted, newsletter and mailing list manager with a modern dashboard.
 name: listmonk
 type: application
-version: 0.4.0
+version: 0.5.0

charts/listmonk/templates/_helpers.tpl

@@ -0,0 +1,21 @@
+{{/*
+Get the postgres secret name
+*/}}
+{{- define "listmonk.postgresSecretName" -}}
+{{- if .Values.postgres.existingSecret -}}
+{{- .Values.postgres.existingSecret -}}
+{{- else -}}
+{{- .Release.Name }}-postgres-secret
+{{- end -}}
+{{- end -}}
+
+{{/*
+Get the postgres secret key
+*/}}
+{{- define "listmonk.postgresSecretKey" -}}
+{{- if .Values.postgres.secretKey -}}
+{{- .Values.postgres.secretKey -}}
+{{- else -}}
+postgres-password
+{{- end -}}
+{{- end -}}

charts/listmonk/templates/deployment.yaml

@@ -6,7 +6,7 @@ metadata:
     app: {{ .Release.Name }}-listmonk
     app.kubernetes.io/component: listmonk
 spec:
-  replicas: {{ .Values.replicas }}
+  replicas: {{ .Values.listmonk.replicas }}
   selector:
     matchLabels:
       app.kubernetes.io/component: listmonk
@@ -42,8 +42,8 @@ spec:
         - name: PGPASSWORD
           valueFrom:
             secretKeyRef:
-              name: {{ .Release.Name }}-postgres-secret
-              key: postgres-password
+              name: {{ include "listmonk.postgresSecretName" . }}
+              key: {{ include "listmonk.postgresSecretKey" . }}
         - name: PGSSLMODE
           value: "disable"
       - name: check-db-tables
@@ -63,15 +63,15 @@ spec:
         - name: PGPASSWORD
           valueFrom:
             secretKeyRef:
-              name: {{ .Release.Name }}-postgres-secret
-              key: postgres-password
+              name: {{ include "listmonk.postgresSecretName" . }}
+              key: {{ include "listmonk.postgresSecretKey" . }}
         - name: PGSSLMODE
           value: "disable"
         volumeMounts:
         - name: init-flag
           mountPath: /tmp
       - name: db-init
-        image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+        image: "{{ .Values.listmonk.image.repository }}:{{ .Values.listmonk.image.tag }}"
         imagePullPolicy: IfNotPresent
         command: ["/bin/sh", "-c"]
         args:
@@ -97,8 +97,8 @@ spec:
         - name: LISTMONK_db__password
           valueFrom:
             secretKeyRef:
-              name: {{ .Release.Name }}-postgres-secret
-              key: postgres-password
+              name: {{ include "listmonk.postgresSecretName" . }}
+              key: {{ include "listmonk.postgresSecretKey" . }}
         - name: LISTMONK_db__database
           value: "{{ .Values.postgres.database }}"
         - name: LISTMONK_db__ssl_mode
@@ -108,7 +108,7 @@ spec:
           mountPath: /tmp
       containers:
       - name: {{ .Release.Name }}-listmonk
-        image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+        image: "{{ .Values.listmonk.image.repository }}:{{ .Values.listmonk.image.tag }}"
         imagePullPolicy: IfNotPresent
         command: ["./listmonk", "--config", "/listmonk/config/app-config.toml"]
         env:
@@ -128,8 +128,8 @@ spec:
         - name: LISTMONK_db__password
           valueFrom:
             secretKeyRef:
-              name: {{ .Release.Name }}-postgres-secret
-              key: postgres-password
+              name: {{ include "listmonk.postgresSecretName" . }}
+              key: {{ include "listmonk.postgresSecretKey" . }}
         - name: LISTMONK_db__database
           value: "{{ .Values.postgres.database }}"
         - name: LISTMONK_db__ssl_mode
@@ -158,7 +158,7 @@ spec:
         - name: config
           mountPath: /listmonk/config
         resources:
-          {{- toYaml .Values.resources | nindent 10 }}
+          {{- toYaml .Values.listmonk.resources | nindent 10 }}
       volumes:
       - name: uploads
         persistentVolumeClaim:

charts/listmonk/templates/postgres-deployment.yaml

@@ -28,8 +28,8 @@ spec:
         - name: POSTGRES_PASSWORD
           valueFrom:
             secretKeyRef:
-              name: {{ .Release.Name }}-postgres-secret
-              key: postgres-password
+              name: {{ include "listmonk.postgresSecretName" . }}
+              key: {{ include "listmonk.postgresSecretKey" . }}
         - name: POSTGRES_DB
           value: "{{ .Values.postgres.database }}"
         - name: PGDATA

charts/listmonk/templates/pvc.yaml

@@ -7,7 +7,7 @@ spec:
     - ReadWriteOnce
   resources:
     requests:
-      storage: {{ .Values.storage.uploadsSize | default "5Gi" }}
+      storage: {{ .Values.listmonk.storage.uploadsSize | default "5Gi" }}
 ---
 apiVersion: v1
 kind: PersistentVolumeClaim
@@ -18,4 +18,4 @@ spec:
     - ReadWriteOnce
   resources:
     requests:
-      storage: {{ .Values.storage.staticSize | default "1Gi" }} 
+      storage: {{ .Values.listmonk.storage.staticSize | default "1Gi" }} 

charts/listmonk/templates/secret.yaml

@@ -1,11 +1,9 @@
+{{- if not .Values.postgres.existingSecret }}
 apiVersion: v1
 kind: Secret
 metadata:
   name: {{ .Release.Name }}-postgres-secret
 type: Opaque
 data:
-  {{- if .Values.postgres.existingSecret }}
-  postgres-password: {{ .Values.postgres.existingSecret | b64enc | quote }}
-  {{- else }}
   postgres-password: {{ .Values.postgres.password | b64enc | quote }}
-  {{- end }} 
+{{- end }}

charts/listmonk/values.yaml

@@ -1,4 +1,4 @@
-commonAnnotations: {}
+hcommonAnnotations: {}
 podAnnotations: {}
 podLabels: {}
 extraInitContainers: {}
@@ -18,24 +18,24 @@ ingress:
 service:
   type: ClusterIP
   annotations: {}
+listmonk:
+  # -- The listmonk image configuration
+  image:
+    # -- the listmonk image repository
+    repository: listmonk/listmonk
+    # -- the listmonk image tag
+    tag: v5.1.0
 
-# -- The listmonk image configuration
-image:
-  # -- the listmonk image repository
-  repository: listmonk/listmonk
-  # -- the listmonk image tag
-  tag: v5.1.0
-
-# -- the number of listmonk deployment replicas
-replicas: 1
+  # -- the number of listmonk deployment replicas
+  replicas: 1
 
-# -- resources for the listmonk deployment
-resources: {}
+  # -- resources for the listmonk deployment
+  resources: {}
 
-# -- Storage configuration for listmonk
-storage:
-  uploadsSize: "5Gi"
-  staticSize: "1Gi"
+  # -- Storage configuration for listmonk
+  storage:
+    uploadsSize: "5Gi"
+    staticSize: "1Gi"
 
 postgres:
   # -- the postgres database name
@@ -44,9 +44,11 @@ postgres:
   enabled: true
   # -- when not enabled, the external postgres service hostname is required
   hostname: ""
-  # -- existing secret name containing postgres password
+  # -- existing secret name containing postgres password (if set, password field is ignored and no secret is created)
   existingSecret: ""
-  # -- the postgres password
+  # -- key in existing secret containing the password (defaults to postgres-password)
+  secretKey: ""
+  # -- the postgres password (ignored if existingSecret is set)
   password: "listmonk"
   # -- the postgres username
   user: "listmonk"