Merge pull request #195 from cognifloyd/annotations

Allow custom annotations on all pods

Author: arm4b

CHANGELOG.md

@@ -7,6 +7,7 @@
 * Reformat some yaml strings so that single quotes wrap strings that include double quotes (#194) (by @cognifloyd)
 * st2chatops change: If `st2chatops.env.ST2_API_KEY` is defined, do not set `ST2_AUTH_USERNAME` or `ST2_AUTH_PASSWORD` env vars any more. (#197) (by @cognifloyd)
 * Add image.tag overrides for all deployments. (#200) (by @cognifloyd)
+* If your k8s cluster admin requires custom annotations (eg: to indicate mongo or rabbitmq usage), you can now add those to each set of pods. (#195) (by @cognifloyd)
 
 ## v0.60.0
 * Switch st2 version to `v3.5dev` as a new latest development version (#187)

templates/deployments.yaml

@@ -35,6 +35,9 @@ spec:
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/auth: {{ include (print $.Template.BasePath "/secrets_st2auth.yaml") . | sha256sum }}
+        {{- if .Values.st2auth.annotations }}
+{{ toYaml .Values.st2auth.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -145,6 +148,9 @@ spec:
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/datastore-key: {{ include (print $.Template.BasePath "/secrets_datastore_crypto_key.yaml") . | sha256sum }}
+        {{- if .Values.st2api.annotations }}
+{{ toYaml .Values.st2api.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -255,6 +261,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
+        {{- if .Values.st2stream.annotations }}
+{{ toYaml .Values.st2stream.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -333,6 +342,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2web.yaml") . | sha256sum }}
+        {{- if .Values.st2web.annotations }}
+{{ toYaml .Values.st2web.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -431,6 +443,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
+        {{- if .Values.st2rulesengine.annotations }}
+{{ toYaml .Values.st2rulesengine.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -518,6 +533,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
+        {{- if .Values.st2timersengine.annotations }}
+{{ toYaml .Values.st2timersengine.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -597,6 +615,9 @@ spec:
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/datastore-key: {{ include (print $.Template.BasePath "/secrets_datastore_crypto_key.yaml") . | sha256sum }}
+        {{- if .Values.st2workflowengine.annotations }}
+{{ toYaml .Values.st2workflowengine.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -688,6 +709,9 @@ spec:
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/datastore-key: {{ include (print $.Template.BasePath "/secrets_datastore_crypto_key.yaml") . | sha256sum }}
+        {{- if .Values.st2scheduler.annotations }}
+{{ toYaml .Values.st2scheduler.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -779,6 +803,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
+        {{- if .Values.st2notifier.annotations }}
+{{ toYaml .Values.st2notifier.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -1118,6 +1145,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
+        {{- if .Values.st2garbagecollector.annotations }}
+{{ toYaml .Values.st2garbagecollector.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -1199,6 +1229,9 @@ spec:
         checksum/auth: {{ include (print $.Template.BasePath "/secrets_st2auth.yaml") . | sha256sum }}
         checksum/ssh: {{ include (print $.Template.BasePath "/secrets_ssh.yaml") . | sha256sum }}
         checksum/datastore-key: {{ include (print $.Template.BasePath "/secrets_datastore_crypto_key.yaml") . | sha256sum }}
+        {{- if .Values.st2client.annotations }}
+{{ toYaml .Values.st2client.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.st2.packs.images }}
@@ -1367,6 +1400,9 @@ spec:
         heritage: {{ .Release.Service }}
       annotations:
         checksum/chatops: {{ include (print $.Template.BasePath "/secrets_st2chatops.yaml") . | sha256sum }}
+        {{- if .Values.st2chatops.annotations }}
+{{ toYaml .Values.st2chatops.annotations | indent 8 }}
+        {{- end }}
     spec:
       {{- if .Values.image.pullSecret }}
       imagePullSecrets:

templates/ingress.yaml

@@ -15,8 +15,8 @@ metadata:
     {{- if .Values.ingress.tls }}
     ingress.kubernetes.io/secure-backends: "true"
     {{- end }}
-    {{- range $key, $value := .Values.ingress.annotations }}
-    {{ $key }}: {{ $value | quote }}
+    {{- if .Values.ingress.annotations }}
+{{ toYaml .Values.ingress.annotations | indent 4 }}
     {{- end }}
 spec:
   rules:

templates/jobs.yaml

@@ -30,6 +30,9 @@ spec:
         # TODO: Investigate/propose running Helm hook only on condition when ConfigMap or Secret has changed
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/rbac: {{ include (print $.Template.BasePath "/configmaps_rbac.yaml") . | sha256sum }}
+        {{- if .Values.jobs.annotations }}
+{{ toYaml .Values.jobs.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -107,6 +110,9 @@ spec:
         # TODO: Investigate/propose running Helm hook only on condition when ConfigMap or Secret has changed
         checksum/urls: {{ include (print $.Template.BasePath "/configmaps_st2-urls.yaml") . | sha256sum }}
         checksum/apikeys: {{ include (print $.Template.BasePath "/secrets_st2apikeys.yaml") . | sha256sum }}
+        {{- if .Values.jobs.annotations }}
+{{ toYaml .Values.jobs.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -214,6 +220,9 @@ spec:
         # TODO: Investigate/propose running Helm hook only on condition when ConfigMap or Secret has changed
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/urls: {{ include (print $.Template.BasePath "/configmaps_st2-urls.yaml") . | sha256sum }}
+        {{- if .Values.jobs.annotations }}
+{{ toYaml .Values.jobs.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}
@@ -321,6 +330,9 @@ spec:
         # TODO: Investigate/propose running Helm hook only on condition when ConfigMap or Secret has changed
         checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
         checksum/packs: {{ include (print $.Template.BasePath "/configmaps_packs.yaml") . | sha256sum }}
+        {{- if .Values.jobs.annotations }}
+{{ toYaml .Values.jobs.annotations | indent 8 }}
+        {{- end }}
     spec:
       imagePullSecrets:
       {{- if .Values.image.pullSecret }}

values.yaml

@@ -242,6 +242,7 @@ st2web:
       cpu: "50m"
     limits:
       memory: "100Mi"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -274,6 +275,7 @@ st2auth:
     requests:
       memory: "85Mi"
       cpu: "50m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -292,6 +294,7 @@ st2api:
     requests:
       memory: "150Mi"
       cpu: "25m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -310,6 +313,7 @@ st2stream:
     requests:
       memory: "100Mi"
       cpu: "50m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -328,6 +332,7 @@ st2rulesengine:
     requests:
       memory: "75Mi"
       cpu: "25m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -345,6 +350,7 @@ st2timersengine:
     requests:
       memory: "75Mi"
       cpu: "10m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -363,6 +369,7 @@ st2workflowengine:
     requests:
       memory: "200Mi"
       cpu: "100m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -381,6 +388,7 @@ st2scheduler:
     requests:
       memory: "75Mi"
       cpu: "50m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -399,6 +407,7 @@ st2notifier:
     requests:
       memory: "75Mi"
       cpu: "50m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -442,6 +451,7 @@ st2actionrunner:
 # The st2client deployment/pod simplifies ad-hoc administration.
 # st2client is a special purpose actionrunner pod, but you can customize it separately
 st2client:
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -457,6 +467,7 @@ st2garbagecollector:
     requests:
       memory: "80Mi"
       cpu: "10m"
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!
@@ -498,6 +509,7 @@ st2chatops:
     requests:
       memory: "50Mi"
       cpu: "5m"
+  annotations: {}
   # Additional advanced settings to control pod/deployment placement
   nodeSelector: {}
   tolerations: []
@@ -509,6 +521,7 @@ st2chatops:
 ## Various batch jobs (apply-rbac-definitions, apikey-load, key-load, register-content)
 ##
 jobs:
+  annotations: {}
   # Override default image settings (for now, only tag can be overridden)
   image: {}
     ## Note that Helm templating is supported in this block!