[bitnami/common] Option to add "app.kubernetes.io/component" label

Signed-off-by: Dmytro Bondar <[email protected]>

Author: bonddim

bitnami/common/Chart.yaml

@@ -6,7 +6,7 @@ annotations:
   licenses: Apache-2.0
 apiVersion: v2
 # Please make sure that version and appVersion are always the same.
-appVersion: 2.29.0
+appVersion: 2.30.0
 description: A Library Helm Chart for grouping common logic between bitnami charts. This chart is not deployable by itself.
 home: https://bitnami.com
 icon: https://bitnami.com/downloads/logos/bitnami-mark.png
@@ -23,4 +23,4 @@ name: common
 sources:
   - https://github.com/bitnami/charts/tree/main/bitnami/common
 type: library
-version: 2.29.0
+version: 2.30.0

bitnami/common/templates/_affinities.tpl

@@ -71,29 +71,23 @@ Return a soft podAffinity/podAntiAffinity definition
 preferredDuringSchedulingIgnoredDuringExecution:
   - podAffinityTerm:
       labelSelector:
-        matchLabels: {{- (include "common.labels.matchLabels" ( dict "customLabels" $customLabels "context" .context )) | nindent 10 }}
-          {{- if not (empty $component) }}
-          {{ printf "app.kubernetes.io/component: %s" $component }}
-          {{- end }}
+        matchLabels: {{- (include "common.labels.matchLabels" (dict "customLabels" $customLabels "context" .context "component" $component)) | nindent 10 }}
           {{- range $key, $value := $extraMatchLabels }}
           {{ $key }}: {{ $value | quote }}
           {{- end }}
       {{- if $extraNamespaces }}
       namespaces:
         - {{ .context.Release.Namespace }}
         {{- with $extraNamespaces }}
-        {{ include "common.tplvalues.render" (dict "value" . "context" $) | nindent 8 }}
+        {{- include "common.tplvalues.render" (dict "value" . "context" $) | nindent 8 }}
         {{- end }}
       {{- end }}
       topologyKey: {{ include "common.affinities.topologyKey" (dict "topologyKey" .topologyKey) }}
     weight: 1
   {{- range $extraPodAffinityTerms }}
   - podAffinityTerm:
       labelSelector:
-        matchLabels: {{- (include "common.labels.matchLabels" ( dict "customLabels" $customLabels "context" $.context )) | nindent 10 }}
-          {{- if not (empty $component) }}
-          {{ printf "app.kubernetes.io/component: %s" $component }}
-          {{- end }}
+        matchLabels: {{- (include "common.labels.matchLabels" (dict "customLabels" $customLabels "context" $.context "component" $component)) | nindent 10 }}
           {{- range $key, $value := .extraMatchLabels }}
           {{ $key }}: {{ $value | quote }}
           {{- end }}
@@ -114,27 +108,21 @@ Return a hard podAffinity/podAntiAffinity definition
 {{- $extraNamespaces := default (list) .extraNamespaces -}}
 requiredDuringSchedulingIgnoredDuringExecution:
   - labelSelector:
-      matchLabels: {{- (include "common.labels.matchLabels" ( dict "customLabels" $customLabels "context" .context )) | nindent 8 }}
-        {{- if not (empty $component) }}
-        {{ printf "app.kubernetes.io/component: %s" $component }}
-        {{- end }}
+      matchLabels: {{- (include "common.labels.matchLabels" (dict "customLabels" $customLabels "context" .context "component" $component)) | nindent 8 }}
         {{- range $key, $value := $extraMatchLabels }}
         {{ $key }}: {{ $value | quote }}
         {{- end }}
       {{- if $extraNamespaces }}
       namespaces:
         - {{ .context.Release.Namespace }}
         {{- with $extraNamespaces }}
-        {{ include "common.tplvalues.render" (dict "value" . "context" $) | nindent 8 }}
+        {{- include "common.tplvalues.render" (dict "value" . "context" $) | nindent 8 }}
         {{- end }}
       {{- end }}
     topologyKey: {{ include "common.affinities.topologyKey" (dict "topologyKey" .topologyKey) }}
   {{- range $extraPodAffinityTerms }}
   - labelSelector:
-      matchLabels: {{- (include "common.labels.matchLabels" ( dict "customLabels" $customLabels "context" $.context )) | nindent 8 }}
-        {{- if not (empty $component) }}
-        {{ printf "app.kubernetes.io/component: %s" $component }}
-        {{- end }}
+      matchLabels: {{- (include "common.labels.matchLabels" (dict "customLabels" $customLabels "context" $.context "component" $component)) | nindent 8 }}
         {{- range $key, $value := .extraMatchLabels }}
         {{ $key }}: {{ $value | quote }}
         {{- end }}

bitnami/common/templates/_labels.tpl

@@ -7,40 +7,59 @@ SPDX-License-Identifier: APACHE-2.0
 
 {{/*
 Kubernetes standard labels
-{{ include "common.labels.standard" (dict "customLabels" .Values.commonLabels "context" $) -}}
+{{- include "common.labels.standard" $ }}
+{{- include "common.labels.standard" (dict "customLabels" .Values.commonLabels "context" $) }}
+{{- include "common.labels.standard" (dict "customLabels" .Values.commonLabels "context" $ "component" "FOO") }}
 */}}
 {{- define "common.labels.standard" -}}
-{{- if and (hasKey . "customLabels") (hasKey . "context") -}}
-{{- $default := dict "app.kubernetes.io/name" (include "common.names.name" .context) "helm.sh/chart" (include "common.names.chart" .context) "app.kubernetes.io/instance" .context.Release.Name "app.kubernetes.io/managed-by" .context.Release.Service -}}
-{{- with .context.Chart.AppVersion -}}
-{{- $_ := set $default "app.kubernetes.io/version" . -}}
-{{- end -}}
-{{ template "common.tplvalues.merge" (dict "values" (list .customLabels $default) "context" .context) }}
-{{- else -}}
-app.kubernetes.io/name: {{ include "common.names.name" . }}
-helm.sh/chart: {{ include "common.names.chart" . }}
-app.kubernetes.io/instance: {{ .Release.Name }}
-app.kubernetes.io/managed-by: {{ .Release.Service }}
-{{- with .Chart.AppVersion }}
-app.kubernetes.io/version: {{ . | quote }}
+{{- $context := default . .context -}}
+{{- $default := dict
+  "app.kubernetes.io/instance" $context.Release.Name
+  "app.kubernetes.io/managed-by" $context.Release.Service
+  "app.kubernetes.io/name" (include "common.names.name" $context)
+  "helm.sh/chart" (include "common.names.chart" $context)
+-}}
+{{- with $context.Chart.AppVersion -}}
+  {{- $_ := set $default "app.kubernetes.io/version" . -}}
 {{- end -}}
+{{- $component := dict -}}
+{{- with .component -}}
+  {{- $_ := set $component "app.kubernetes.io/component" . -}}
 {{- end -}}
+{{- /* If "component" key is present it will overwrite label from .customLabels for compatibility with selector */ -}}
+{{- include "common.tplvalues.merge" (dict "values" (compact (list $component .customLabels $default)) "context" $context) }}
 {{- end -}}
 
 {{/*
 Labels used on immutable fields such as deploy.spec.selector.matchLabels or svc.spec.selector
-{{ include "common.labels.matchLabels" (dict "customLabels" .Values.podLabels "context" $) -}}
+{{- include "common.labels.matchLabels" $ }}
+{{- include "common.labels.matchLabels" (dict "customLabels" .Values.podLabels "context" $) }}
+{{- include "common.labels.matchLabels" (dict "customLabels" .Values.podLabels "context" $ "component" "FOO") }}
 
 We don't want to loop over custom labels appending them to the selector
 since it's very likely that it will break deployments, services, etc.
 However, it's important to overwrite the standard labels if the user
 overwrote them on metadata.labels fields.
 */}}
 {{- define "common.labels.matchLabels" -}}
-{{- if and (hasKey . "customLabels") (hasKey . "context") -}}
-{{ merge (pick (include "common.tplvalues.render" (dict "value" .customLabels "context" .context) | fromYaml) "app.kubernetes.io/name" "app.kubernetes.io/instance") (dict "app.kubernetes.io/name" (include "common.names.name" .context) "app.kubernetes.io/instance" .context.Release.Name ) | toYaml }}
+{{- $context := default . .context -}}
+{{- $default := dict
+  "app.kubernetes.io/instance" $context.Release.Name
+  "app.kubernetes.io/name" (include "common.names.name" $context)
+-}}
+{{- with .component -}}
+  {{- $_ := set $default "app.kubernetes.io/component" . -}}
+{{- end -}}
+{{- if .customLabels -}}
+{{- merge
+  (pick
+    (include "common.tplvalues.render" (dict "value" .customLabels "context" $context) | fromYaml)
+    "app.kubernetes.io/name"
+    "app.kubernetes.io/instance"
+  )
+  $default | toYaml
+-}}
 {{- else -}}
-app.kubernetes.io/name: {{ include "common.names.name" . }}
-app.kubernetes.io/instance: {{ .Release.Name }}
+  {{- $default | toYaml }}
 {{- end -}}
 {{- end -}}