Merge pull request #17975 from jakesmith/HPCC-30711-global-annotations

HPCC-30711 Add global annotations Reviewed-by: Gavin Halliday <[email protected]> Merged-by: Gavin Halliday <[email protected]>
hpcc-systems · Nov 2, 2023 · fb5d871 · fb5d871
2 parents 4d6b337 + e7d956f
commit fb5d871
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 51 deletions.
diff --git a/helm/hpcc/templates/_helpers.tpl b/helm/hpcc/templates/_helpers.tpl
@@ -2527,3 +2527,16 @@ spec:
   {{- end -}}
  {{- end -}}
 {{- end -}}
+
+{{/*
+A template to generate component annotations, merges static default annotations with global and component annotations
+Pass in dict with .root, .me
+*/}}
+{{- define "hpcc.generateAnnotations" -}}
+{{- $annotations := dict -}}
+{{- if hasKey .root.Values.global "componentAnnotations" -}}{{- $annotations = merge $annotations .root.Values.global.componentAnnotations -}}{{- end -}}
+{{- if hasKey .me "annotations" -}}{{- $annotations = merge $annotations .me.annotations -}}{{- end -}}
+{{- range $key, $value := $annotations }}
+{{ $key }}: {{ $value | quote }}
+{{- end -}}
+{{- end -}}
diff --git a/helm/hpcc/templates/dafilesrv.yaml b/helm/hpcc/templates/dafilesrv.yaml
@@ -53,6 +53,7 @@ spec:
         helmVersion: 9.2.33-closedown0
       annotations:
         checksum/config: {{ $configSHA }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" .name "type" "dafilesrv") | indent 6 }}
       serviceAccountName: "hpcc-default"

diff --git a/helm/hpcc/templates/dali.yaml b/helm/hpcc/templates/dali.yaml
@@ -94,9 +94,7 @@ spec:
  {{- if hasKey $.Values.global "metrics" }}
   {{- include "hpcc.addPrometheusScrapeAnnotations" $.Values.global.metrics | nindent 8 }}
  {{- end }}
- {{- if hasKey $dali "annotations" }}
-  {{- toYaml $dali.annotations | nindent 8 }}
- {{- end }}
+ {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
 {{- end }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $dali.name "type" "dali") | indent 6 }}

diff --git a/helm/hpcc/templates/dfuserver.yaml b/helm/hpcc/templates/dfuserver.yaml
@@ -62,9 +62,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey . "annotations" }}
-{{ toYaml .annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" .name "target" .name "type" "dfuserver") | indent 6 }}
       serviceAccountName: "hpcc-default"

diff --git a/helm/hpcc/templates/eclagent.yaml b/helm/hpcc/templates/eclagent.yaml
@@ -62,10 +62,8 @@ data:
 {{- if hasKey .me "labels" }}
 {{ toYaml .me.labels | indent 12 }}
 {{- end }}
-{{- if hasKey .me "annotations" }}
           annotations:
-{{ toYaml .me.annotations | indent 12 }}
-{{- end }}
+            {{- include "hpcc.generateAnnotations" . | indent 12 }}
         spec:
           {{- include "hpcc.placementsByJobTargetType" (dict "root" .root "job" $appJobName "target" .me.name "type" "eclagent") | indent 10 }}
           serviceAccountName: "hpcc-agent"
@@ -141,9 +139,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey . "annotations" }}
-{{ toYaml .annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" .name "target" .name "type" "eclagent") | indent 6 }}
       serviceAccountName: "hpcc-agent"

diff --git a/helm/hpcc/templates/eclccserver.yaml b/helm/hpcc/templates/eclccserver.yaml
@@ -61,10 +61,8 @@ data:
 {{- if hasKey .me "labels" }}
 {{ toYaml .me.labels | indent 12 }}
 {{- end }}
-{{- if hasKey .me "annotations" }}
           annotations:
-{{ toYaml .me.annotations | indent 12 }}
-{{- end }}
+            {{- include "hpcc.generateAnnotations" . | indent 12 }}
         spec:
           {{- include "hpcc.placementsByJobTargetType" (dict "root" .root "job" $compileJobName "target" .me.name "type" "eclccserver") | indent 10 }}
           serviceAccountName: "hpcc-default"
@@ -148,9 +146,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey . "annotations" }}
-{{ toYaml .annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" .name "target" .name "type" "eclccserver") | indent 6 }}
       serviceAccountName: {{ .useChildProcesses | default false | ternary "hpcc-default" "hpcc-agent" }}

diff --git a/helm/hpcc/templates/eclscheduler.yaml b/helm/hpcc/templates/eclscheduler.yaml
@@ -70,9 +70,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey . "annotations" }}
-{{ toYaml .annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" .name "target" .name "type" "eclscheduler") | indent 6 }}
       serviceAccountName: "hpcc-default"

diff --git a/helm/hpcc/templates/esp.yaml b/helm/hpcc/templates/esp.yaml
@@ -130,11 +130,9 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
 {{- if hasKey  $.Values.global "metrics" }}
  {{- include "hpcc.addPrometheusScrapeAnnotations" $.Values.global.metrics | nindent 8 }}
-{{- end }}
-{{- if hasKey . "annotations" }}
-{{ toYaml .annotations | indent 8 }}
 {{- end }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" .name "type" "esp") | indent 6 }}

diff --git a/helm/hpcc/templates/localroxie.yaml b/helm/hpcc/templates/localroxie.yaml
@@ -77,9 +77,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey . "annotations" }}
-{{ toYaml .annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $roxie.name "target" $roxie.name "type" "roxie") | indent 6 }}
       serviceAccountName: "hpcc-default"

diff --git a/helm/hpcc/templates/roxie.yaml b/helm/hpcc/templates/roxie.yaml
@@ -129,11 +129,9 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $topoconfigSHA }}
+        {{- include "hpcc.generateAnnotations" (dict "root" $commonCtx.root "me" $toposerver) | indent 8 }}
 {{- if hasKey $.Values.global "metrics" }}
  {{- include "hpcc.addPrometheusScrapeAnnotations"  $.Values.global.metrics | nindent 8 }}
-{{- end }}
-{{- if hasKey $toposerver "annotations" }}
-{{ toYaml $toposerver.annotations | indent 8 }}
 {{- end }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $commonCtx.toponame "target" $roxie.name "type" "roxie") | indent 6 }}
@@ -252,6 +250,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
 {{- if hasKey $.Values.global "metrics" }}
  {{- include "hpcc.addPrometheusScrapeAnnotations" $.Values.global.metrics | nindent 8 }}
 {{- end }}
@@ -356,11 +355,9 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
 {{- if hasKey $.Values.global "metrics" }}
  {{- include "hpcc.addPrometheusScrapeAnnotations" $.Values.global.metrics | nindent 8 }}
-{{- end }}
-{{- if hasKey $roxie "annotations" }}
-{{ toYaml $roxie.annotations | indent 8 }}
 {{- end }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $name "target" $roxie.name "type" "roxie") | indent 6 }}

diff --git a/helm/hpcc/templates/sasha.yaml b/helm/hpcc/templates/sasha.yaml
@@ -59,9 +59,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey $sasha "annotations" }}
-{{ toYaml $sasha.annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $serviceName "type" "sasha") | indent 6 }}
       serviceAccountName: "hpcc-default"

diff --git a/helm/hpcc/templates/thor.yaml b/helm/hpcc/templates/thor.yaml
@@ -87,10 +87,8 @@ data:
 {{- if hasKey .me "labels" }}
 {{ toYaml .me.labels | indent 12 }}
 {{- end }}
-{{- if hasKey .me "annotations" }}
           annotations:
-{{ toYaml .me.annotations | indent 12 }}
-{{- end }}
+            {{- include "hpcc.generateAnnotations" . | indent 12 }}
         spec:
           {{- include "hpcc.placementsByJobTargetType" (dict "root" .root "job" $eclAgentJobName "target" .me.name "type" "thor") | indent 10 }}
           serviceAccountName: "hpcc-agent"
@@ -154,10 +152,8 @@ data:
 {{- if hasKey $thorScope "labels" }}
 {{ toYaml $thorScope.labels | indent 12 }}
 {{- end }}
-{{- if hasKey $thorScope "annotations" }}
           annotations:
-{{ toYaml $thorScope.annotations | indent 12 }}
-{{- end }}
+            {{- include "hpcc.generateAnnotations" . | indent 12 }}
         spec:
           {{- include "hpcc.placementsByJobTargetType" (dict "root" .root "job" $thorManagerJobName "target" .me.name "type" "thor") | indent 10 }}
           serviceAccountName: hpcc-thoragent
@@ -221,10 +217,8 @@ data:
 {{- if hasKey $thorScope "labels" }}
 {{ toYaml $thorScope.labels | indent 12 }}
 {{- end }}
-{{- if hasKey $thorScope "annotations" }}
           annotations:
-{{ toYaml $thorScope.annotations | indent 12 }}
-{{- end }}
+            {{- include "hpcc.generateAnnotations" . | indent 12 }}
         spec:
           {{- include "hpcc.placementsByJobTargetType" (dict "root" .root "job" $thorWorkerJobName "target" .me.name "type" "thor") | indent 10 }}
           serviceAccountName: hpcc-default
@@ -355,9 +349,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey $commonCtx.me "annotations" }}
-{{ toYaml $commonCtx.me.annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $commonCtx.eclAgentName "target" .name "type" "thor") | indent 6 }}
       {{- include "hpcc.addImagePullSecrets" $commonCtx | nindent 6 -}}
@@ -420,9 +412,7 @@ spec:
 {{- end }}
       annotations:
         checksum/config: {{ $configSHA }}
-{{- if hasKey $commonCtx.me "annotations" }}
-{{ toYaml $commonCtx.me.annotations | indent 8 }}
-{{- end }}
+        {{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
     spec:
       {{- include "hpcc.placementsByPodTargetType" (dict "root" $ "pod" $commonCtx.thorAgentName "target" .name "type" "thor") | indent 6 }}
       {{- include "hpcc.addImagePullSecrets" $commonCtx | nindent 6 -}}

diff --git a/helm/hpcc/values.schema.json b/helm/hpcc/values.schema.json
@@ -401,6 +401,11 @@
             },
             "additionalProperties": false
           }
+        },
+        "componentAnnotations": {
+          "type": "object",
+          "additionalProperties": { "type": "string" },
+          "description": "Global component annotations, generated into all components"
         }
       },
       "additionalProperties": false
@@ -2754,6 +2759,14 @@
         "image": {
           "$ref": "#/definitions/image"
         },
+        "annotations": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        },
         "logging": {
           "$ref": "#/definitions/logging"
         },