Annotate deployments with hashed extraconfig

- When the extra config for a client or server is updated, it updates the underlying configMap but has no way of informing the server statefulSet or client daemonSet of the update.With this PR, the values for server.extraConfig & client.extraConfig are saved as annotations on the server statefulSet spec and client daemonsetSpec respectfully. If a user updates the extraConfig and performs a `helm upgrade`, it will force a reconcile of the server and client pods (depending on what changed) and will keep them updated with the latest config. Signed-off-by: Ashwin Venkatesh <[email protected]>
hashicorp · Jul 24, 2020 · 65a0941 · 65a0941
1 parent 6303775
commit 65a0941
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 ## Unreleased
 
+IMPROVEMENTS:
+
+* Add server.extraConfig and client.extraConfig values as hashes on Server
+  StatefulSet and Client Daemonset annotations respectively. This recreates
+  the server/client pod when the server/client extraConfig is updated via `helm upgrade` [[GH-550](https://github.com/hashicorp/consul-helm/pull/550)]
+
 ## 0.23.1 (July 10, 2020)
 
 BUG FIXES:

diff --git a/templates/client-daemonset.yaml b/templates/client-daemonset.yaml
@@ -32,6 +32,7 @@ spec:
         hasDNS: "true"
       annotations:
         "consul.hashicorp.com/connect-inject": "false"
+        "consul.hashicorp.com/config-checksum": {{ .Values.client.extraConfig | sha256sum }}
         {{- if .Values.client.annotations }}
           {{- tpl .Values.client.annotations . | nindent 8 }}
         {{- end }}

diff --git a/templates/server-statefulset.yaml b/templates/server-statefulset.yaml
@@ -40,6 +40,7 @@ spec:
         hasDNS: "true"
       annotations:
         "consul.hashicorp.com/connect-inject": "false"
+        "consul.hashicorp.com/config-checksum": {{ .Values.server.extraConfig | sha256sum }}
         {{- if .Values.server.annotations }}
           {{- tpl .Values.server.annotations . | nindent 8 }}
         {{- end }}

diff --git a/test/unit/client-daemonset.bats b/test/unit/client-daemonset.bats
@@ -355,7 +355,7 @@ load _helpers
   local actual=$(helm template \
       -s templates/client-daemonset.yaml  \
       . | tee /dev/stderr |
-      yq -r '.spec.template.metadata.annotations | del(."consul.hashicorp.com/connect-inject")' | tee /dev/stderr)
+      yq -r '.spec.template.metadata.annotations | del(."consul.hashicorp.com/connect-inject") | del(."consul.hashicorp.com/config-checksum")' | tee /dev/stderr)
   [ "${actual}" = "{}" ]
 }
 
@@ -369,6 +369,28 @@ load _helpers
   [ "${actual}" = "bar" ]
 }
 
+#--------------------------------------------------------------------
+# extraConfig
+
+@test "client/DaemonSet: adds config-checksum annotation when extraConfig is blank" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/client-daemonset.yaml  \
+      . | tee /dev/stderr |
+      yq -r '.spec.template.metadata.annotations."consul.hashicorp.com/config-checksum"' | tee /dev/stderr)
+  [ "${actual}" = ca3d163bab055381827226140568f3bef7eaac187cebd76878e0b63e9e442356 ]
+}
+
+@test "client/DaemonSet: adds config-checksum annotation when extraConfig is provided" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/client-daemonset.yaml  \
+      --set 'client.extraConfig="{\"hello\": \"world\"}"' \
+      . | tee /dev/stderr |
+      yq -r '.spec.template.metadata.annotations."consul.hashicorp.com/config-checksum"' | tee /dev/stderr)
+  [ "${actual}" = 83df36fdaf1b4acb815f1764f9ff2782c520ca012511f282ba9c57a04401a239 ]
+}
+
 #--------------------------------------------------------------------
 # tolerations
 

diff --git a/test/unit/server-statefulset.bats b/test/unit/server-statefulset.bats
@@ -353,7 +353,7 @@ load _helpers
   local actual=$(helm template \
       -s templates/server-statefulset.yaml  \
       . | tee /dev/stderr |
-      yq -r '.spec.template.metadata.annotations | del(."consul.hashicorp.com/connect-inject")' | tee /dev/stderr)
+      yq -r '.spec.template.metadata.annotations | del(."consul.hashicorp.com/connect-inject") | del(."consul.hashicorp.com/config-checksum")' | tee /dev/stderr)
   [ "${actual}" = "{}" ]
 }
 
@@ -366,6 +366,27 @@ load _helpers
       yq -r '.spec.template.metadata.annotations.foo' | tee /dev/stderr)
   [ "${actual}" = "bar" ]
 }
+#--------------------------------------------------------------------
+# extraConfig
+
+@test "server/StatefulSet: adds config-checksum annotation when extraConfig is blank" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/server-statefulset.yaml  \
+      . | tee /dev/stderr |
+      yq -r '.spec.template.metadata.annotations."consul.hashicorp.com/config-checksum"' | tee /dev/stderr)
+  [ "${actual}" = ca3d163bab055381827226140568f3bef7eaac187cebd76878e0b63e9e442356 ]
+}
+
+@test "server/StatefulSet: adds config-checksum annotation when extraConfig is provided" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/server-statefulset.yaml  \
+      --set 'server.extraConfig="{\"hello\": \"world\"}"' \
+      . | tee /dev/stderr |
+      yq -r '.spec.template.metadata.annotations."consul.hashicorp.com/config-checksum"' | tee /dev/stderr)
+  [ "${actual}" = 83df36fdaf1b4acb815f1764f9ff2782c520ca012511f282ba9c57a04401a239 ]
+}
 
 #--------------------------------------------------------------------
 # tolerations