feat: Add support for common labels and common annotations (#732)

gaganhr94 · web-flow · commit f7daa8bd5591 · 2026-02-02T22:52:44.000-05:00
#### What this PR does #### Which issue this PR fixes - fixes #723 #### Checklist - [X] [DCO](https://github.com/jaegertracing/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed - [ ] Commits are [GPG signed](https://docs.github.com/en/github/authenticating-to-github/about-commit-signature-verification) - [ ] Chart Version bumped - [ ] Title of the PR starts with chart name (`[jaeger]` or `[jaeger-operator]`) - [ ] README.md has been updated to match version/contain new values Signed-off-by: Gagan H R <hrgagan4@gmail.com>
diff --git a/charts/jaeger/Chart.yaml b/charts/jaeger/Chart.yaml
@@ -3,7 +3,7 @@ appVersion: 2.14.1
 description: A Jaeger Helm chart for Kubernetes
 name: jaeger
 type: application
-version: 4.4.5
+version: 4.4.6
 # CronJobs require v1.21
 kubeVersion: ">= 1.21-0"
 keywords:
diff --git a/charts/jaeger/ci/common-labels-annotations-values.yaml b/charts/jaeger/ci/common-labels-annotations-values.yaml
@@ -0,0 +1,17 @@
+# Test with common labels and annotations in values
+
+commonLabels:
+  common-label-1: "value-1"
+  common-label-2: "value-2"
+
+commonAnnotations:
+  example/common-annotation-1: "value-1"
+  example/common-annotation-2: "value-2"
+
+jaeger:
+  enabled: true
+  service:
+    annotations:
+      # When component annotations are present, override common annotation
+      example/common-annotation-1: "component-value-1"
+      example/common-annotation-3: "component-value-3"
diff --git a/charts/jaeger/ci/default-values.yaml b/charts/jaeger/ci/default-values.yaml
@@ -0,0 +1,5 @@
+# Test with default values
+# This ensures the chart works with minimal configuration
+
+jaeger:
+  enabled: true
diff --git a/charts/jaeger/templates/_helpers.tpl b/charts/jaeger/templates/_helpers.tpl
@@ -41,6 +41,9 @@ helm.sh/chart: {{ include "jaeger.chart" . }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- if .Values.commonLabels}}
+{{ toYaml .Values.commonLabels }}
+{{- end }}
 {{- end -}}
 
 {{/*
@@ -51,6 +54,17 @@ app.kubernetes.io/name: {{ include "jaeger.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 
+{{/*
+Merge common annotations with component-specific annotations.
+Component-specific annotations take precedence.
+*/}}
+{{- define "jaeger.annotations" -}}
+{{- $annotations := merge (dict) (.component | default dict) (.context.Values.commonAnnotations | default dict) -}}
+{{- if gt (len (keys $annotations)) 0 -}}
+{{- toYaml $annotations -}}
+{{- end -}}
+{{- end -}}
+
 {{/*
 Create the name of the spark service account to use
 */}}
diff --git a/charts/jaeger/templates/es-maintenance/es-index-cleaner-cronjob.yaml b/charts/jaeger/templates/es-maintenance/es-index-cleaner-cronjob.yaml
@@ -6,10 +6,10 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: es-index-cleaner
-{{- if .Values.esIndexCleaner.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.esIndexCleaner.annotations) }}
   annotations:
-    {{- toYaml .Values.esIndexCleaner.annotations | nindent 4 }}
-{{- end }}
+    {{- . | nindent 4 }}
+  {{- end }}
 spec:
   concurrencyPolicy: {{ .Values.esIndexCleaner.concurrencyPolicy }}
   schedule: {{ .Values.esIndexCleaner.schedule | quote }}
diff --git a/charts/jaeger/templates/es-maintenance/es-index-cleaner-service-account.yaml b/charts/jaeger/templates/es-maintenance/es-index-cleaner-service-account.yaml
@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: es-index-cleaner
-  {{- with .Values.esIndexCleaner.serviceAccount.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.esIndexCleaner.serviceAccount.annotations) }}
   annotations:
-    {{- toYaml . | nindent 4 }}
+    {{- . | nindent 4 }}
   {{- end }}
 automountServiceAccountToken: {{ .Values.esIndexCleaner.serviceAccount.automountServiceAccountToken }}
 {{ end }}
diff --git a/charts/jaeger/templates/es-maintenance/es-lookback-cronjob.yaml b/charts/jaeger/templates/es-maintenance/es-lookback-cronjob.yaml
@@ -6,10 +6,10 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: es-lookback
-{{- if .Values.esLookback.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.esLookback.annotations) }}
   annotations:
-    {{- toYaml .Values.esLookback.annotations | nindent 4 }}
-{{- end }}
+    {{- . | nindent 4 }}
+  {{- end }}
 spec:
   concurrencyPolicy: {{ .Values.esLookback.concurrencyPolicy }}
   schedule: {{ .Values.esLookback.schedule | quote }}
@@ -38,7 +38,7 @@ spec:
             {{- end }}
         spec:
           serviceAccountName: {{ template "jaeger.esLookback.serviceAccountName" . }}
-          {{- include "esLookback.imagePullSecrets" . | nindent 10 }}  
+          {{- include "esLookback.imagePullSecrets" . | nindent 10 }}
           securityContext:
             {{- toYaml .Values.esLookback.podSecurityContext | nindent 12 }}
           restartPolicy: OnFailure
diff --git a/charts/jaeger/templates/es-maintenance/es-lookback-service-account.yaml b/charts/jaeger/templates/es-maintenance/es-lookback-service-account.yaml
@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: es-lookback
-  {{- with .Values.esLookback.serviceAccount.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.esLookback.serviceAccount.annotations) }}
   annotations:
-    {{- toYaml . | nindent 4 }}
+    {{- . | nindent 4 }}
   {{- end }}
 automountServiceAccountToken: {{ .Values.esLookback.serviceAccount.automountServiceAccountToken }}
 {{ end }}
diff --git a/charts/jaeger/templates/es-maintenance/es-rollover-cronjob.yaml b/charts/jaeger/templates/es-maintenance/es-rollover-cronjob.yaml
@@ -6,10 +6,10 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: es-rollover
-{{- if .Values.esRollover.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.esRollover.annotations) }}
   annotations:
-    {{- toYaml .Values.esRollover.annotations | nindent 4 }}
-{{- end }}
+    {{- . | nindent 4 }}
+  {{- end }}
 spec:
   concurrencyPolicy: {{ .Values.esRollover.concurrencyPolicy }}
   schedule: {{ .Values.esRollover.schedule | quote }}
diff --git a/charts/jaeger/templates/es-maintenance/es-rollover-hook.yml b/charts/jaeger/templates/es-maintenance/es-rollover-hook.yml
@@ -9,9 +9,7 @@ metadata:
   annotations:
     "helm.sh/hook": pre-install,pre-upgrade
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
-    {{- if .Values.esRollover.initHook.annotations }}
-      {{- toYaml .Values.esRollover.initHook.annotations | nindent 4 }}
-    {{- end }}
+    {{- include "jaeger.annotations" (dict "context" . "component" .Values.esRollover.initHook.annotations) | nindent 4 }}
 spec:
   {{- if .Values.esRollover.initHook.activeDeadlineSeconds }}
   activeDeadlineSeconds: {{ .Values.esRollover.initHook.activeDeadlineSeconds }}
diff --git a/charts/jaeger/templates/es-maintenance/es-rollover-service-account.yaml b/charts/jaeger/templates/es-maintenance/es-rollover-service-account.yaml
@@ -11,8 +11,6 @@ metadata:
     # Must be created before the rollover init hook
     "helm.sh/hook-weight": "-10"
     "helm.sh/hook-delete-policy": before-hook-creation
-  {{- with .Values.esRollover.serviceAccount.annotations }}
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
+    {{- include "jaeger.annotations" (dict "context" . "component" .Values.esRollover.serviceAccount.annotations) | nindent 4 }}
 automountServiceAccountToken: {{ .Values.esRollover.serviceAccount.automountServiceAccountToken }}
 {{ end }}
diff --git a/charts/jaeger/templates/jaeger/jaeger-deploy.yaml b/charts/jaeger/templates/jaeger/jaeger-deploy.yaml
@@ -8,6 +8,10 @@ metadata:
     app.kubernetes.io/component: all-in-one
     prometheus.io/port: "8888"
     prometheus.io/scrape: "true"
+  {{- with include "jaeger.annotations" (dict "context" . "component" nil) }}
+  annotations:
+    {{- . | nindent 4 }}
+  {{- end }}
 spec:
   {{- if hasKey .Values.jaeger "replicas" }}
   replicas: {{ .Values.jaeger.replicas }}
diff --git a/charts/jaeger/templates/jaeger/jaeger-ingress.yaml b/charts/jaeger/templates/jaeger/jaeger-ingress.yaml
@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: all-in-one
-  {{- if .Values.jaeger.ingress.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.jaeger.ingress.annotations) }}
   annotations:
-    {{- toYaml .Values.jaeger.ingress.annotations | nindent 4 }}
+    {{- . | nindent 4 }}
   {{- end }}
 spec:
   {{- if .Values.jaeger.ingress.ingressClassName }}
diff --git a/charts/jaeger/templates/jaeger/jaeger-service-account.yaml b/charts/jaeger/templates/jaeger/jaeger-service-account.yaml
@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: all-in-one
-  {{- with .Values.jaeger.serviceAccount.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.jaeger.serviceAccount.annotations) }}
   annotations:
-    {{- toYaml . | nindent 4 }}
+    {{- . | nindent 4 }}
   {{- end }}
 automountServiceAccountToken: {{ .Values.jaeger.serviceAccount.automountServiceAccountToken }}
 {{- end -}}
diff --git a/charts/jaeger/templates/jaeger/jaeger-service.yaml b/charts/jaeger/templates/jaeger/jaeger-service.yaml
@@ -8,9 +8,9 @@ metadata:
     {{- if .Values.jaeger.service.labels }}
       {{- toYaml .Values.jaeger.service.labels | nindent 4 }}
     {{- end }}
-  {{- if .Values.jaeger.service.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.jaeger.service.annotations) }}
   annotations:
-    {{- toYaml .Values.jaeger.service.annotations | nindent 4 }}
+    {{- . | nindent 4 }}
   {{- end }}
 spec:
   type: {{ .Values.jaeger.service.type | default "ClusterIP" }}
diff --git a/charts/jaeger/templates/jaeger/jaeger-ui-config.yaml b/charts/jaeger/templates/jaeger/jaeger-ui-config.yaml
@@ -7,6 +7,10 @@ metadata:
   namespace: {{ .Release.Namespace }}
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
+  {{- if .Values.commonAnnotations }}
+  annotations:
+    {{- include "jaeger.annotations" . | nindent 4 }}
+  {{- end }}
 data:
   ui-config.json: {{ toJson .Values.uiconfig | quote }}
 {{- end -}}
diff --git a/charts/jaeger/templates/jaeger/jaeger-user-config.yaml b/charts/jaeger/templates/jaeger/jaeger-user-config.yaml
@@ -7,6 +7,10 @@ metadata:
   namespace: {{ .Release.Namespace }}
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
+  {{- if .Values.commonAnnotations }}
+  annotations:
+    {{- include "jaeger.annotations" . | nindent 4 }}
+  {{- end }}
 data:
   user-config.yaml: |
 {{ toYaml .Values.userconfig | indent 4 }}
diff --git a/charts/jaeger/templates/spark/spark-dependencies.yaml b/charts/jaeger/templates/spark/spark-dependencies.yaml
@@ -6,10 +6,10 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: spark
-{{- if .Values.spark.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.spark.annotations) }}
   annotations:
-    {{- toYaml .Values.spark.annotations | nindent 4 }}
-{{- end }}
+    {{- . | nindent 4 }}
+  {{- end }}
 spec:
   schedule: {{ .Values.spark.schedule | quote }}
   successfulJobsHistoryLimit: {{ .Values.spark.successfulJobsHistoryLimit }}
diff --git a/charts/jaeger/templates/spark/spark-service-account.yaml b/charts/jaeger/templates/spark/spark-service-account.yaml
@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "jaeger.labels" . | nindent 4 }}
     app.kubernetes.io/component: spark
-  {{- with .Values.spark.serviceAccount.annotations }}
+  {{- with include "jaeger.annotations" (dict "context" . "component" .Values.spark.serviceAccount.annotations) }}
   annotations:
-    {{- toYaml . | nindent 4 }}
+    {{- . | nindent 4 }}
   {{- end }}
 automountServiceAccountToken: {{ .Values.spark.serviceAccount.automountServiceAccountToken }}
 {{- end -}}
diff --git a/charts/jaeger/values.yaml b/charts/jaeger/values.yaml
@@ -142,6 +142,12 @@ tag: ""
 nameOverride: ""
 fullnameOverride: ""
 
+# Labels to add to all deployed resources
+commonLabels: {}
+
+# Annotations to add to all resources
+commonAnnotations: {}
+
 # ------------------------------------------------------------------------------
 # Jaeger Deployment Settings
 # https://github.com/jaegertracing/jaeger/blob/main/cmd/jaeger/Dockerfile
