feat: auto restart deployment when config files change (#36)

Signed-off-by: Zhiming Guo <guo.zhming@gmail.com>

Author: zhming0

charts/zot/Chart.yaml

@@ -3,4 +3,4 @@ appVersion: v2.0.1
 description: A Helm chart for Kubernetes
 name: zot
 type: application
-version: 0.1.46
+version: 0.1.47

charts/zot/templates/deployment.yaml

@@ -11,10 +11,13 @@ spec:
       {{- include "zot.selectorLabels" . | nindent 6 }}
   template:
     metadata:
-      {{- with .Values.podAnnotations }}
       annotations:
+        {{- with .Values.podAnnotations }}
         {{- toYaml . | nindent 8 }}
-      {{- end }}
+        {{- end }}
+        {{- if and .Values.mountConfig .Values.configFiles }}
+        checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
+        {{- end }}
       labels:
         {{- include "zot.selectorLabels" . | nindent 8 }}
     spec:

charts/zot/unittests/configmap_checksum_test.yaml

@@ -0,0 +1,23 @@
+suite: configmap checksum in deployment
+# Can't use global templates in this test suite as it will break the checksum calculation
+# causing false negative test outcome.
+# templates:
+#   - deployment.yaml
+tests:
+  - it: has no checksum/config if no config
+    template: deployment.yaml
+    asserts:
+      - isNull:
+          path: spec.template.metadata.annotations.checksum/config
+  - it: generate checksum/config if config is present
+    template: deployment.yaml
+    set:
+      mountConfig: true
+      configFiles:
+        config.json: "{}"
+    asserts:
+      - isNotNull:
+          path: spec.template.metadata.annotations.checksum/config
+      - matchRegex:
+          path: spec.template.metadata.annotations.checksum/config
+          pattern: "^[a-f0-9]{64}$" # SHA256 hex output

charts/zot/values.yaml

@@ -171,3 +171,5 @@ extraVolumeMounts: []
 extraVolumes: []
 # - name: data
 #   emptyDir: {}
+
+podAnnotations: {}