Add Kubernetes-recommended labels to Helm chart

chart/docs/customizing-labels.rst

@@ -24,6 +24,28 @@ Customizing Pod Labels
 The Helm Chart allows you to customize labels for your Airflow objects. You can set global labels that apply to all objects and pods defined in the chart,
 as well as component-specific labels for individual Airflow components.
 
+Default Labels
+~~~~~~~~~~~~~~
+
+Resources managed directly by the Airflow chart include the following Kubernetes-recommended labels by default:
+
+.. code-block:: yaml
+
+   app.kubernetes.io/part-of: airflow
+   app.kubernetes.io/name: airflow
+   app.kubernetes.io/instance: <Helm release name>
+   app.kubernetes.io/version: <Airflow application version>
+   helm.sh/chart: <chart name>-<chart version>
+   app.kubernetes.io/managed-by: <Helm release service>
+
+Resources with a component label also include ``app.kubernetes.io/component`` with the same value. Pod templates include
+``app.kubernetes.io/part-of``, ``app.kubernetes.io/name``, ``app.kubernetes.io/instance``,
+``app.kubernetes.io/version``, and ``app.kubernetes.io/component``.
+
+The chart's workload, service, policy, and autoscaling selectors use ``app.kubernetes.io/part-of``,
+``app.kubernetes.io/instance``, and ``app.kubernetes.io/component`` instead of the legacy ``tier``, ``release``, and
+``component`` labels removed in chart 2.0.
+
 Global Labels
 ~~~~~~~~~~~~~
 

chart/docs/customizing-workers.rst

@@ -107,9 +107,11 @@ As an example, let's say you want to set ``priorityClassName`` on your workers:
      metadata:
        name: placeholder-name
        labels:
-         tier: airflow
-         component: worker
-         release: {{ .Release.Name }}
+         app.kubernetes.io/name: airflow
+         app.kubernetes.io/part-of: airflow
+         app.kubernetes.io/component: worker
+         app.kubernetes.io/instance: {{ .Release.Name }}
+         app.kubernetes.io/version: {{ .Chart.AppVersion }}
      spec:
        priorityClassName: high-priority
        containers:

chart/files/pod-template-file.kubernetes-helm-yaml

@@ -36,9 +36,7 @@ kind: Pod
 metadata:
   name: placeholder-name
   labels:
-    tier: airflow
-    component: worker
-    release: {{ .Release.Name }}
+    {{- include "airflow.standardPodLabels" (dict "root" . "component" "worker") | nindent 4 }}
     {{- if or .Values.labels .Values.workers.kubernetes.labels }}
       {{- mustMerge .Values.workers.kubernetes.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}

chart/templates/_helpers.yaml

@@ -37,6 +37,47 @@ If release name contains chart name it will be used as a full name.
   {{- end }}
 {{- end }}
 
+{{/*
+Sanitize a value for use as a Kubernetes label value.
+*/}}
+{{- define "airflow.labelValue" -}}
+  {{- . | toString | replace "+" "_" | trunc 63 | trimAll "-_." -}}
+{{- end }}
+
+{{/*
+Kubernetes recommended labels for chart resources.
+*/}}
+{{- define "airflow.standardLabels" -}}
+  {{- $root := .root -}}
+  {{- $labels := dict
+    "app.kubernetes.io/instance" (include "airflow.labelValue" $root.Release.Name)
+    "app.kubernetes.io/managed-by" (include "airflow.labelValue" $root.Release.Service)
+    "app.kubernetes.io/name" (include "airflow.labelValue" $root.Chart.Name)
+    "app.kubernetes.io/part-of" "airflow"
+    "app.kubernetes.io/version" (include "airflow.labelValue" $root.Chart.AppVersion)
+    "helm.sh/chart" (include "airflow.labelValue" (printf "%s-%s" $root.Chart.Name $root.Chart.Version))
+  -}}
+  {{- with .component }}
+    {{- $_ := set $labels "app.kubernetes.io/component" (include "airflow.labelValue" .) -}}
+  {{- end }}
+  {{- toYaml $labels -}}
+{{- end }}
+
+{{/*
+Kubernetes recommended labels for chart-managed pods.
+*/}}
+{{- define "airflow.standardPodLabels" -}}
+  {{- $root := .root -}}
+  {{- $labels := dict
+    "app.kubernetes.io/component" (include "airflow.labelValue" (required "component is required for standard pod labels" .component))
+    "app.kubernetes.io/instance" (include "airflow.labelValue" $root.Release.Name)
+    "app.kubernetes.io/name" (include "airflow.labelValue" $root.Chart.Name)
+    "app.kubernetes.io/part-of" "airflow"
+    "app.kubernetes.io/version" (include "airflow.labelValue" $root.Chart.AppVersion)
+  -}}
+  {{- toYaml $labels -}}
+{{- end }}
+
 {{- define "airflow.serviceAccountName" -}}
   {{ if .Values.fullnameOverride }}
     {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}

chart/templates/api-server/api-server-deployment.yaml

@@ -35,11 +35,7 @@ kind: Deployment
 metadata:
   name: {{ include "airflow.fullname" . }}-api-server
   labels:
-    tier: airflow
-    component: api-server
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "api-server") | nindent 4 }}
     {{- with .Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
@@ -71,15 +67,13 @@ spec:
     {{- end }}
   selector:
     matchLabels:
-      tier: airflow
-      component: api-server
-      release: {{ .Release.Name }}
+      app.kubernetes.io/part-of: airflow
+      app.kubernetes.io/component: api-server
+      app.kubernetes.io/instance: {{ .Release.Name }}
   template:
     metadata:
       labels:
-        tier: airflow
-        component: api-server
-        release: {{ .Release.Name }}
+        {{- include "airflow.standardPodLabels" (dict "root" . "component" "api-server") | nindent 8 }}
         {{- if or .Values.labels .Values.apiServer.labels }}
           {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 8 }}
         {{- end }}
@@ -123,7 +117,7 @@ spec:
           - podAffinityTerm:
               labelSelector:
                 matchLabels:
-                  component: api-server
+                  app.kubernetes.io/component: api-server
               topologyKey: kubernetes.io/hostname
             weight: 100
         {{- end }}

chart/templates/api-server/api-server-hpa.yaml

@@ -26,11 +26,7 @@ kind: HorizontalPodAutoscaler
 metadata:
   name: {{ include "airflow.fullname" . }}-api-server
   labels:
-    tier: airflow
-    component: api-server-horizontalpodautoscaler
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "api-server-horizontalpodautoscaler") | nindent 4 }}
     deploymentName: {{ .Release.Name }}-api-server
     {{- if or .Values.labels .Values.apiServer.labels }}
       {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}

chart/templates/api-server/api-server-httproute.yaml

@@ -36,11 +36,7 @@ kind: HTTPRoute
 metadata:
   name: {{ $fullname }}-api-server-httproute
   labels:
-    tier: airflow
-    component: airflow-api-server-httproute
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "airflow-api-server-httproute") | nindent 4 }}
     {{- if or .Values.labels .Values.apiServer.labels .Values.apiServer.httpRoute.labels }}
       {{- mustMerge .Values.apiServer.httpRoute.labels .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}

chart/templates/api-server/api-server-ingress.yaml

@@ -30,11 +30,7 @@ kind: Ingress
 metadata:
   name: {{ $fullname }}-ingress
   labels:
-    tier: airflow
-    component: airflow-ingress
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "airflow-ingress") | nindent 4 }}
     {{- if or .Values.labels .Values.apiServer.labels }}
       {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}

chart/templates/api-server/api-server-networkpolicy.yaml

@@ -26,20 +26,16 @@ kind: NetworkPolicy
 metadata:
   name: {{ include "airflow.fullname" . }}-api-server-policy
   labels:
-    tier: airflow
-    component: airflow-api-server-policy
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "airflow-api-server-policy") | nindent 4 }}
     {{- if or .Values.labels .Values.apiServer.labels }}
       {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}
 spec:
   podSelector:
     matchLabels:
-      tier: airflow
-      component: api-server
-      release: {{ .Release.Name }}
+      app.kubernetes.io/part-of: airflow
+      app.kubernetes.io/component: api-server
+      app.kubernetes.io/instance: {{ .Release.Name }}
   policyTypes:
     - Ingress
   {{- if .Values.apiServer.networkPolicy.ingress.from }}

chart/templates/api-server/api-server-poddisruptionbudget.yaml

@@ -26,19 +26,15 @@ kind: PodDisruptionBudget
 metadata:
   name: {{ include "airflow.fullname" . }}-api-server-pdb
   labels:
-    tier: airflow
-    component: api-server
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "api-server") | nindent 4 }}
     {{- if or .Values.labels .Values.apiServer.labels }}
       {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}
 spec:
   selector:
     matchLabels:
-      tier: airflow
-      component: api-server
-      release: {{ .Release.Name }}
+      app.kubernetes.io/part-of: airflow
+      app.kubernetes.io/component: api-server
+      app.kubernetes.io/instance: {{ .Release.Name }}
   {{- toYaml .Values.apiServer.podDisruptionBudget.config | nindent 2 }}
 {{- end }}

chart/templates/api-server/api-server-service.yaml

@@ -26,11 +26,7 @@ kind: Service
 metadata:
   name: {{ include "airflow.fullname" . }}-api-server
   labels:
-    tier: airflow
-    component: api-server
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "api-server") | nindent 4 }}
     {{- if or .Values.labels .Values.apiServer.labels }}
       {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}
@@ -40,9 +36,9 @@ metadata:
 spec:
   type: {{ .Values.apiServer.service.type }}
   selector:
-    tier: airflow
-    component: api-server
-    release: {{ .Release.Name }}
+    app.kubernetes.io/part-of: airflow
+    app.kubernetes.io/component: api-server
+    app.kubernetes.io/instance: {{ .Release.Name }}
   ports:
   {{ range .Values.apiServer.service.ports }}
     -

chart/templates/api-server/api-server-serviceaccount.yaml

@@ -27,11 +27,7 @@ automountServiceAccountToken: {{ .Values.apiServer.serviceAccount.automountServi
 metadata:
   name: {{ include "apiServer.serviceAccountName" . }}
   labels:
-    tier: airflow
-    component: api-server
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "api-server") | nindent 4 }}
     {{- if or .Values.labels .Values.apiServer.labels }}
       {{- mustMerge .Values.apiServer.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}

chart/templates/cleanup/cleanup-cronjob.yaml

@@ -33,11 +33,7 @@ kind: CronJob
 metadata:
   name: {{ include "airflow.fullname" . }}-cleanup
   labels:
-    tier: airflow
-    component: airflow-cleanup-pods
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "airflow-cleanup-pods") | nindent 4 }}
     {{- with .Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
@@ -60,9 +56,7 @@ spec:
       template:
         metadata:
           labels:
-            tier: airflow
-            component: airflow-cleanup-pods
-            release: {{ .Release.Name }}
+            {{- include "airflow.standardPodLabels" (dict "root" . "component" "airflow-cleanup-pods") | nindent 12 }}
             {{- if or .Values.labels .Values.cleanup.labels }}
               {{- mustMerge .Values.cleanup.labels .Values.labels | toYaml | nindent 12 }}
             {{- end }}

chart/templates/cleanup/cleanup-serviceaccount.yaml

@@ -27,11 +27,7 @@ automountServiceAccountToken: {{ .Values.cleanup.serviceAccount.automountService
 metadata:
   name: {{ include "cleanup.serviceAccountName" . }}
   labels:
-    tier: airflow
-    component: airflow-cleanup-pods
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "airflow-cleanup-pods") | nindent 4 }}
     {{- if or .Values.labels .Values.cleanup.labels }}
       {{- mustMerge .Values.cleanup.labels .Values.labels | toYaml | nindent 4 }}
     {{- end }}

chart/templates/configmaps/api-server-configmap.yaml

@@ -26,11 +26,7 @@ kind: ConfigMap
 metadata:
   name: {{ template "airflow_api_server_config_configmap_name" . }}
   labels:
-    tier: airflow
-    component: config
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "config") | nindent 4 }}
     {{- with .Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}

chart/templates/configmaps/configmap.yaml

@@ -25,11 +25,7 @@ kind: ConfigMap
 metadata:
   name: {{ template "airflow_config" . }}
   labels:
-    tier: airflow
-    component: config
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "config") | nindent 4 }}
     {{- with .Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end -}}

chart/templates/configmaps/extra-configmaps.yaml

@@ -28,10 +28,7 @@ kind: ConfigMap
 metadata:
   name: {{ tpl $configMapName $Global | quote }}
   labels:
-    tier: airflow
-    release: {{ $Global.Release.Name }}
-    chart: "{{ $Global.Chart.Name }}-{{ $Global.Chart.Version }}"
-    heritage: {{ $Global.Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" $Global) | nindent 4 }}
     {{- with $Global.Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}

chart/templates/configmaps/otel-collector-configmap.yaml

@@ -26,11 +26,7 @@ kind: ConfigMap
 metadata:
   name: {{ include "airflow.fullname" . }}-otel-collector
   labels:
-    tier: airflow
-    component: config
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "config") | nindent 4 }}
     {{- with .Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}

chart/templates/configmaps/statsd-configmap.yaml

@@ -26,11 +26,7 @@ kind: ConfigMap
 metadata:
   name: {{ include "airflow.fullname" . }}-statsd
   labels:
-    tier: airflow
-    component: config
-    release: {{ .Release.Name }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    heritage: {{ .Release.Service }}
+    {{- include "airflow.standardLabels" (dict "root" . "component" "config") | nindent 4 }}
     {{- with .Values.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}