Merge pull request #8 from funkypenguin/improve-strategy

funkypenguin · web-flow · commit 4b2cc5a879f8 · 2020-05-05T11:28:07.000+12:00
Fixes #6 by genericizing spec.strategy
diff --git a/.ci/ct-config.yaml b/.ci/ct-config.yaml
@@ -0,0 +1,7 @@
+# This file defines the config for "ct" (chart tester) used by the helm linting GitHub workflow
+
+# Here we define every possible upstream repo our charts use in `requirements.yaml`
+chart-repos:
+  - haproxy=https://haproxytech.github.io/helm-charts
+
+lint-conf: .ci/lint-config.yaml
diff --git a/.ci/lint-config.yaml b/.ci/lint-config.yaml
@@ -0,0 +1,6 @@
+rules:
+  # One blank line is OK
+  empty-lines: 
+    max-start: 1
+    max-end: 1
+    max: 1
diff --git a/.ci/scripts/local-ci.sh b/.ci/scripts/local-ci.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker run --rm -it -w /repo -v `pwd`:/repo quay.io/helmpack/chart-testing ct lint --config=.ci/ct-config.yaml 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# :wave: How can I contribute?
+
+First off, thank you for helping to improve this chart! :heart_eyes: :pray:
+
+## Testing
+
+To test the chart locally, before submitting changes, run `./ci/scripts/local-ci.sh`
+
+## Submitting changes
+
+Please send a [GitHub Pull Request](https://github.com/funkypenguin/helm-docker-mailserver/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).
+
+When you send a pull request, please make sure all of your commits are atomic (one feature per commit), and bump the chart version in `chart.yaml`
+
+Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
+
+    $ git commit -m "A brief summary of the commit
+    > 
+    > A paragraph describing what changed and its impact."
+
+Thanks again!
+Funky Penguin :penguin:
diff --git a/charts/docker-mailserver/Chart.yaml b/charts/docker-mailserver/Chart.yaml
@@ -2,9 +2,9 @@ apiVersion: v1
 appVersion: "6.3.0"
 description: A fullstack but simple mailserver (smtp, imap, antispam, antivirus, ssl...) using Docker.
 name: docker-mailserver
-version: 0.2.3
+version: 0.2.4-pre1
 sources:
-- https://github.com/funkypenguin/docker-mailserver
+- https://github.com/funkypenguin/helm-docker-mailserver
 maintainers:
 - name: funkypenguin
   email: davidy@funkypenguin.co.nz
@@ -14,4 +14,4 @@ keywords:
 - dovecot
 - amavis
 - imap
-tillerVersion: ">=2.13.0"
+home: https://github.com/funkypenguin/helm-docker-mailserver
diff --git a/charts/docker-mailserver/requirements.lock b/charts/docker-mailserver/requirements.lock
@@ -2,5 +2,5 @@ dependencies:
 - name: kubernetes-ingress
   repository: https://haproxytech.github.io/helm-charts
   version: 0.7.0
-digest: sha256:2fb5dd45349f1002565ff2a3c729212db7e6ed74d397fe9f2e67c3306366eb15
-generated: "2020-02-22T09:14:23.359769+13:00"
+digest: sha256:f1aefde9a154637312577e8dbdbe577851061e36565a612d8c15d86aef329a13
+generated: "2020-04-27T10:30:45.01314+12:00"
diff --git a/charts/docker-mailserver/templates/deployment-rainloop.yaml b/charts/docker-mailserver/templates/deployment-rainloop.yaml
@@ -16,11 +16,7 @@ spec:
     matchLabels:
       app: {{ template "dockermailserver.fullname" . }}-rainloop
       release: "{{ .Release.Name }}"
-  strategy:
-    rollingUpdate:
-      maxSurge: 1
-      maxUnavailable: 0
-    type: "Recreate"
+  strategy: {{- toYaml .Values.rainloop.strategy | nindent 4 }}
   template:
     metadata:
       labels:
diff --git a/charts/docker-mailserver/templates/deployment.yaml b/charts/docker-mailserver/templates/deployment.yaml
@@ -14,11 +14,7 @@ spec:
     matchLabels:
       app: {{ template "dockermailserver.fullname" . }}
       release: "{{ .Release.Name }}"
-  strategy:
-    rollingUpdate:
-      maxSurge: 1
-      maxUnavailable: 1
-    type: "RollingUpdate"
+  strategy: {{- toYaml .Values.pod.dockermailserver.strategy | nindent 4 }}      
   template:
     metadata:
       labels:
@@ -42,12 +38,14 @@ spec:
          - name: "opendkim-keys"
            secret:
              secretName: {{ template "dockermailserver.fullname" . }}-secrets
+{{ if .Values.pod.dockermailserver.ssl_type }}             
          - name: "ssl-cert"
            secret:
 {{ if .Values.ssl.useExisting }}
              secretName: {{ .Values.ssl.existingName }}
 {{- else }}
              secretName: {{ template "dockermailserver.fullname" . }}-tls
+{{- end }}
 {{- end }}
       initContainers:
         - name: prep-config
@@ -78,9 +76,11 @@ spec:
           volumeMounts:
             - name: config
               mountPath: /tmp/docker-mailserver
+{{ if .Values.pod.dockermailserver.ssl_type }}              
             - name: ssl-cert
               mountPath: /tmp/ssl
               readOnly: true              
+{{- end }}              
             - name: data
               mountPath: /var/mail
               subPath: mail
diff --git a/charts/docker-mailserver/templates/psp-rainloop.yaml b/charts/docker-mailserver/templates/psp-rainloop.yaml
@@ -259,7 +259,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   name: rb-docker-mailserver-rainloop
-  namespace: docker-mailserver
+  namespace: {{ .Release.Namespace }}
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole
diff --git a/charts/docker-mailserver/templates/psp.yaml b/charts/docker-mailserver/templates/psp.yaml
@@ -259,7 +259,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   name: rb-docker-mailserver
-  namespace: docker-mailserver
+  namespace: {{ .Release.Namespace }}
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole
diff --git a/charts/docker-mailserver/values.yaml b/charts/docker-mailserver/values.yaml
@@ -31,8 +31,6 @@ initContainer:
       ## it may terminated.
       memory: "64Mi"
 
-
-
 serviceAccount:
   create: "true"
 
@@ -55,7 +53,10 @@ ssl:
     kind: ClusterIssuer
   dnsname: example.com
   dns01provider: cloudflare
-  useExisting: false
+
+  # Set this to false to let the chart try to assemble a CR for you. This feature will be deprecated soon, and users will 
+  # need to manage cert-manager outside of this chart (the dependencies involved make it fragile)
+  useExisting: true 
   existingName: name-of-existing-secret
 
 ## Create the necessary PodSecurityPolicies (PSPs) for docker-mailserver, haproxy, and rainloop to work
@@ -115,6 +116,16 @@ pod:
     # pod.dockermailserver.hostPID defines whether the pod should use the host's PID namespace (default false)
     hostPID: false
 
+    ## Update strategy - only really applicable for deployments with RWO PVs attached
+    ## If replicas = 1, an update can get "stuck", as the previous pod remains attached to the 
+    ## PV, and the "incoming" pod can never start. Changing the strategy to "Recreate" will 
+    ## terminate the single previous pod, so that the new, incoming pod can attach to the PV    
+    strategy: {}
+      # rollingUpdate:
+      #   maxSurge: 1
+      #   maxUnavailable: 1
+      # type: "RollingUpdate"
+
     ## The following variables affect the behaviour of docker-mailserver
     ## See https://github.com/tomav/docker-mailserver#environment-variables for details
     ## Note that docker-mailserver expects most true/false values to present as 0 or 1, so that's how you should adjust the values below
@@ -137,7 +148,10 @@ pod:
     enable_dovecot_replication: true
 
     smtp_only: 0
-    # ssl_type: "manual"
+
+    # Set this to "manual" or "letsencrypt". Leaving it set empty will disable SSL support
+    ssl_type:
+
     # ssl_cert_path: "/tmp/ssl/tls.crt"
     # ssl_key_path: "/tmp/ssl/tls.key"
     tls_level:
@@ -308,13 +322,11 @@ monitoring:
     path: "/metrics"
     ## Port on which HTTP server is served
     port: "9102"
-    
-
 
 # Values imported from https://github.com/t13a/helm-chart-rainloop/blob/master/values.yaml
 rainloop:
   # rainloop.enabled will include a rainloop (webmail) pod in the release
-  enabled: true
+  enabled: false
   serviceAccount:
     create: true
     name: "rainloop"
@@ -324,6 +336,17 @@ rainloop:
     # rainloop.image.tag is the tag of the docker container to use for the rainloop pod
     tag: "latest"
     pullPolicy: "Always"
+
+    ## Update strategy - only really applicable for deployments with RWO PVs attached
+    ## If replicas = 1, an update can get "stuck", as the previous pod remains attached to the 
+    ## PV, and the "incoming" pod can never start. Changing the strategy to "Recreate" will 
+    ## terminate the single previous pod, so that the new, incoming pod can attach to the PV    
+    strategy: {}
+      # rollingUpdate:
+      #   maxSurge: 1
+      #   maxUnavailable: 1
+      # type: "RollingUpdate"
+          
   persistence:
     size: "1Gi"
     # Uncomment the backup.kubernetes.io/deltas annotation below if you use https://github.com/miracle2k/k8s-snapshots

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/bin/bash`
	`2`	`+`
	`3`	+docker run --rm -it -w /repo -v `pwd`:/repo quay.io/helmpack/chart-testing ct lint --config=.ci/ct-config.yaml