Merge branch 'docker-mailserver:master' into fix/probes

Author: radicand

.ci/ct-config.yaml

@@ -1,4 +1,6 @@
 # This file defines the config for "ct" (chart tester) used by the helm linting GitHub workflow
 
 lint-conf: .ci/lint-config.yaml
-validate-maintainers: false
+target-branch: master
+validate-maintainers: false
+check-version-increment: false

.github/workflows/on-push-lint-charts.yml

@@ -64,7 +64,7 @@ jobs:
     strategy:
       matrix:
         # Choose from https://hub.docker.com/r/kindest/node/tags
-        KubeVersion: [ 1.27.3, 1.28.0, 1.29.0 ]
+        KubeVersion: [ 1.30.10, 1.31.6, 1.32.2]
 
     steps:
       - name: Checkout
@@ -78,7 +78,7 @@ jobs:
           python-version: 3.11
 
       - name: Set up chart-testing
-        uses: helm/chart-testing-action@v2.6.0
+        uses: helm/chart-testing-action@v2.7.0
 
       - name: Run chart-testing (list-changed)
         id: list-changed

.github/workflows/on-push-master-publish-chart.yml

@@ -27,7 +27,7 @@ jobs:
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1.6.0
+        uses: helm/chart-releaser-action@v1.7.0
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
 

charts/docker-mailserver/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: "14.0.0"
 description: A fullstack but simple mailserver (smtp, imap, antispam, antivirus, ssl...) using Docker.
 name: docker-mailserver
-version: 4.1.0
+version: 4.1.4
 sources:
 - https://github.com/docker-mailserver/docker-mailserver-helm
 maintainers:

charts/docker-mailserver/README.md

@@ -98,11 +98,11 @@ Configuration files are stored on a Kubernetes [volume](#persistence) mounted at
 
 ### ConfigMaps
 
-Its is also possible to use ConfigMaps to mount configuration files in the container. This is done by adding to  the `configFiles` key in a custom `values.yaml` file. For more information please see the [documentation](./values.yaml#L425) in values.yaml
+Its is also possible to use ConfigMaps to mount configuration files in the container. This is done by adding to  the `configFiles` key in a custom `values.yaml` file. For more information please see the [documentation](./values.yaml#L453) in values.yaml
 
 ### Secrets
 
-Secrets can also be used to mount configuration files in the container. For example, dkim keys could be stored in a secret as opposed to a file in the `mail-config` volume. Once again, for more information please see the [documentation](./values.yaml#L600) in values.yaml
+Secrets can also be used to mount configuration files in the container. For example, dkim keys could be stored in a secret as opposed to a file in the `mail-config` volume. Once again, for more information please see the [documentation](./values.yaml#L610) in values.yaml
 
 ## Values YAML
 
@@ -179,7 +179,7 @@ If you do not enable the PROXY protocol and your mail server is not exposed usin
 
 ## Persistence
 
-By default, the Chart creates four PersistentVolumeClaims. These are defined under the `persistence` key:
+By default, the Chart assumes there are for Persistent volumes. Thus it requests four PersistentVolumeClaims which are defined using the `persistent_volume_claims` key. Each PVC can be set to an existing claim by settin the `persistent_volume_claims.<volume_name>.existing_claim` key or a new cliams. To disable creation of a PVC, set `persistent_volume_claims.<volume_name>.enabled` to false. The default PVCs have the following characteristics:
 
 | PVC Name    |  Default Size  | Mount            |  Description                         |
 | ----------  | ------- | ----------------------- | -------------------------------------|
@@ -188,6 +188,25 @@ By default, the Chart creates four PersistentVolumeClaims. These are defined und
 | mail-state  |   1Gi   | /var/mail-state         | Stores [state](https://docker-mailserver.github.io/docker-mailserver/latest/faq/#what-about-the-docker-datadmsmail-state-directory) for mail services       |
 | mail-log    |   1Gi   | /var/log/mail           | Stores log files                     |
 
+The PVCs are then mounted to `volumeMounts` via the `persistence` key. Each `volumeMount` must specify a volume name and mount path. It is also possbile to set a subpath via the `subPath` key.
+
+Extra volumes and volume mounts may be added using the `extraVolumes` and `extraVolumeMounts` keys.
+
+## Upgrading to Version 5
+Version 5.0 upgrades docker-mailserver to version 15. This version of the chart *does* include backwards incompatible changes
+
+### PersistentVolumeClaims
+
+Previously by default the Chart created four persistent volume claims and then mounted them to the container. This made it difficult for users that want to use just one Volume. Therefore the `persistence` key was spit into two keys:
+
+* `persistent_volume_claims`
+* `persistence`
+
+This separate the creation of PVCs from mounting their associated volumes. If you previously overrode the creation of PVCs or their mount paths you will need to update your custom `values.yaml` file.
+
+## Upgrading to Version 4
+Version 4.0 upgrades docker-mailserver to version 14. There are no backwards incompatible changes in the chart.
+
 ## Upgrading to Version 3
 
 Version 3.0 is not backwards compatible with previous versions. The biggest changes include:

charts/docker-mailserver/ci/ci-haproxy.yaml

@@ -1,2 +1,2 @@
 service:
-  type: ClusterIP
+  type: ClusterIP

charts/docker-mailserver/templates/deployment.yaml

@@ -71,12 +71,12 @@ spec:
       {{- end }}
 
         # PVCs
-    {{- range $name, $persistence := .Values.persistence }}
-      {{- if $persistence.enabled }}
+    {{- range $name, $pvc := .Values.persistent_volume_claims }}
+      {{- if $pvc.enabled }}
         - name: {{ $name }}
           persistentVolumeClaim:
-            {{- if $persistence.existingClaim}}
-            claimName: {{ $persistence.existingClaim }}
+            {{- if $pvc.existingClaim}}
+            claimName: {{ $pvc.existingClaim }}
             {{ else }}
             claimName: {{ template "dockermailserver.fullname" $ }}-{{ $name }}
             {{ end }}
@@ -168,10 +168,11 @@ spec:
 
             # Mount Volumes
         {{- range $name, $persistence := .Values.persistence }}
-          {{- if $persistence.enabled }}
-            - name: {{ $name }}
+            - name: {{ $persistence.volumeName }}
               mountPath: {{ $persistence.mountPath }}
-          {{- end }}
+            {{- if $persistence.subPath }}
+              subPath: {{ $persistence.subPath }}
+            {{- end }}
         {{- end }}
 
             # Mount Extra Volumes

charts/docker-mailserver/templates/pvc.yaml

@@ -1,26 +1,26 @@
-{{- range $name, $persistence := .Values.persistence -}}
-{{- if and (not $persistence.existingClaim) ($persistence.enabled) }}
+{{- range $name, $pvc := .Values.persistent_volume_claims -}}
+{{- if and (not $pvc.existingClaim) ($pvc.enabled) }}
 kind: PersistentVolumeClaim
 apiVersion: v1
 metadata:
   name: {{ template "dockermailserver.fullname" $ }}-{{ $name }}
-  {{- if $persistence.annotations }}
+  {{- if $pvc.annotations }}
   annotations:
-  {{ toYaml $persistence.annotations | indent 2 }}  
+    {{ toYaml $pvc.annotations }}  
   {{ end }}
 spec:
   accessModes:
-  {{ toYaml $persistence.accessModes | indent 2 }}
+  {{ toYaml $pvc.accessModes | indent 2 }}
 
-  {{- if $persistence.storageClass }}
-  storageClassName: {{ $persistence.storageClass | quote }}
+  {{- if $pvc.storageClass }}
+  storageClassName: {{ $pvc.storageClass | quote }}
   {{- end }}    
   resources:
     requests:
-      storage: {{ $persistence.size | quote }}
-  {{- if $persistence.selector }}
+      storage: {{ $pvc.size | quote }}
+  {{- if $pvc.selector }}
   selector:
-{{ toYaml $persistence.selector | indent 4 }}
+{{ toYaml $pvc.selector | indent 4 }}
   {{ end }}
 ---
 {{- end }}

charts/docker-mailserver/templates/service.yaml

@@ -26,11 +26,17 @@ metadata:
 spec:
   ## If a load balancer is being used, ensure that the newer type of LB that passes along IP information is used
   ## rather than the legacy one.
-  {{- if eq .Values.service.type "LoadBalancer" }}
+  {{- if or (eq .Values.service.type "NodePort") (eq .Values.service.type "LoadBalancer") }}
+  {{- if .Values.service.externalTrafficPolicy }}
+  externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }}
+  {{- end }}
+  {{- if and (not .Values.service.externalTrafficPolicy) (eq .Values.service.type "LoadBalancer") }}
   externalTrafficPolicy: Local
-  {{- else if eq .Values.service.type "NodePort" }}
+  {{- end }}
+  {{- if and (not .Values.service.externalTrafficPolicy) (eq .Values.service.type "NodePort") }}
   externalTrafficPolicy: Cluster
-  {{ end }}
+  {{- end }}
+  {{- end }}
   selector:
     app.kubernetes.io/name: {{ template "dockermailserver.fullname" . }}
     release: "{{ .Release.Name }}"

charts/docker-mailserver/tests/__snapshot__/pvc_test.yaml.snap

@@ -43,7 +43,7 @@ manifest should match snapshot:
       resources:
         requests:
           storage: 1Gi
-should apply annotations from persistence.annotations:
+should apply annotations from persistent_volume_claims.annotations:
   1: |
     apiVersion: v1
     kind: PersistentVolumeClaim