feat(helm): refactoring Kubernetes recommanded labels

templates/helm/templates/_helpers.tpl.tpl

@@ -61,3 +61,30 @@ SEDREPLACERULES
 {{ "{{- end -}}" }}
 {{ "{{ join \",\" $list }}" }}
 {{ "{{- end -}}" }}
+
+{{ "{{/*" }}
+{{ "Kubernetes recommended labels for all resources" }}
+{{ "*/}}" }}
+{{ DefineTemplate "app.labels" }}
+app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
+app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
+app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
+app.kubernetes.io/component: {{ .ControllerName }}-controller
+app.kubernetes.io/part-of: {{ IncludeTemplate "app.name" }}
+app.kubernetes.io/managed-by: Helm
+helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+k8s-app: {{ IncludeTemplate "app.name" }}
+{{ "{{- if .Values.commonLabels }}" }}
+{{ "{{- range $key, $value := .Values.commonLabels }}" }}
+{{ "{{ $key }}: {{ $value | quote }}" }}
+{{ "{{- end }}" }}
+{{ "{{- end }}" }}
+{{ "{{- end -}}" }}
+
+{{ "{{/*" }}
+{{ "Selector labels for matching pods" }}
+{{ "*/}}" }}
+{{ DefineTemplate "app.selectorLabels" }}
+app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
+app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
+{{ "{{- end -}}" }}

templates/helm/templates/caches-role-binding.yaml.tpl

@@ -3,12 +3,7 @@ kind: ClusterRoleBinding
 metadata:
   name: {{ IncludeTemplate "app.fullname" }}-namespaces-cache
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 roleRef:
   kind: ClusterRole
   apiGroup: rbac.authorization.k8s.io
@@ -24,12 +19,7 @@ metadata:
   name: {{ IncludeTemplate "app.fullname" }}-configmaps-cache
   namespace: {{ "{{ .Release.Namespace }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 roleRef:
   kind: Role
   apiGroup: rbac.authorization.k8s.io

templates/helm/templates/caches-role.yaml.tpl

@@ -3,12 +3,7 @@ kind: ClusterRole
 metadata:
   name: {{ IncludeTemplate "app.fullname" }}-namespaces-cache
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 rules:
 - apiGroups:
   - ""
@@ -25,12 +20,7 @@ metadata:
   name: {{ IncludeTemplate "app.fullname" }}-configmaps-cache
   namespace: {{ "{{ .Release.Namespace }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 rules:
 - apiGroups:
   - ""

templates/helm/templates/cluster-role-binding.yaml.tpl

@@ -4,12 +4,7 @@ kind: ClusterRoleBinding
 metadata:
   name: {{ IncludeTemplate "app.fullname" }}-rolebinding
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 roleRef:
   kind: ClusterRole
   apiGroup: rbac.authorization.k8s.io
@@ -34,12 +29,7 @@ metadata:
   name: {{ "{{ $fullname }}" }}-{{ "{{ . }}" }}
   namespace: {{ "{{ . }}" }}
   labels:
-    app.kubernetes.io/name: {{ "{{ $fullname }}" }}
-    app.kubernetes.io/instance: {{ "{{ $.Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ $appVersion }}" }}
-    k8s-app: {{ "{{ $fullname }}" }}
-    helm.sh/chart: {{ "{{ $chartVersion }}" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 roleRef:
   kind: Role
   apiGroup: rbac.authorization.k8s.io

templates/helm/templates/cluster-role-controller.yaml.tpl

@@ -9,12 +9,7 @@ kind: ClusterRole
 metadata:
   name: {{ IncludeTemplate "app.fullname" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
   {{ "{{- range $key, $value := $labels }}" }}
     {{ "{{ $key }}: {{ $value | quote }}" }}
   {{ "{{- end }}" }}
@@ -30,12 +25,7 @@ metadata:
   name: {{ "{{ $fullname }}" }}-{{ "{{ . }}" }}
   namespace: {{ "{{ . }}" }}
   labels:
-    app.kubernetes.io/name: {{ "{{ $fullname }}" }}
-    app.kubernetes.io/instance: {{ "{{ $.Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ $appVersion }}" }}
-    k8s-app: {{ "{{ $fullname }}" }}
-    helm.sh/chart: {{ "{{ $chartVersion }}" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
   {{ "{{- range $key, $value := $labels }}" }}
     {{ "{{ $key }}: {{ $value | quote }}" }}
   {{ "{{- end }}" }}

templates/helm/templates/deployment.yaml.tpl

@@ -4,18 +4,12 @@ metadata:
   name: {{ IncludeTemplate "app.fullname" }}
   namespace: {{ "{{ .Release.Namespace }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 spec:
   replicas: {{ "{{ .Values.deployment.replicas }}" }}
   selector:
     matchLabels:
-      app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-      app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
+      {{ IncludeTemplate "app.selectorLabels" | nindent 6 }}
   template:
     metadata:
 {{ "{{- if .Values.deployment.annotations }}" }}
@@ -25,10 +19,7 @@ spec:
       {{ "{{- end }}" }}
 {{ "{{- end }}" }}
       labels:
-        app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-        app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-        app.kubernetes.io/managed-by: Helm
-        k8s-app: {{ IncludeTemplate "app.name" }}
+        {{ IncludeTemplate "app.selectorLabels" | nindent 8 }}
 {{ "{{- range $key, $value := .Values.deployment.labels }}" }}
         {{ "{{ $key }}: {{ $value | quote }}" }}
 {{ "{{- end }}" }}
@@ -148,7 +139,7 @@ spec:
         {{ "{{- if .Values.deployment.extraEnvVars -}}" }}
           {{ "{{ toYaml .Values.deployment.extraEnvVars | nindent 8 }}" }}
         {{ "{{- end }}" }}
-        {{  "{{- if or .Values.aws.credentials.secretName .Values.deployment.extraVolumeMounts }}" }} 
+        {{  "{{- if or .Values.aws.credentials.secretName .Values.deployment.extraVolumeMounts }}" }}
         volumeMounts:
         {{ "{{- if .Values.aws.credentials.secretName }}" }}
           - name: {{ "{{ .Values.aws.credentials.secretName }}" }}

templates/helm/templates/leader-election-role-binding.yaml.tpl

@@ -9,12 +9,7 @@ metadata:
   namespace: {{ "{{ .Release.Namespace }}" }}
 {{ "{{ end }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role

templates/helm/templates/leader-election-role.yaml.tpl

@@ -9,12 +9,7 @@ metadata:
   namespace: {{ "{{ .Release.Namespace }}" }}
 {{ "{{ end }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 rules:
 - apiGroups:
   - coordination.k8s.io

templates/helm/templates/metrics-service.yaml.tpl

@@ -5,18 +5,10 @@ metadata:
   name: {{ "{{ .Chart.Name | trimSuffix \"-chart\" | trunc 44 }}-controller-metrics" }}
   namespace: {{ "{{ .Release.Namespace }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 spec:
   selector:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    k8s-app: {{ IncludeTemplate "app.name" }}
+    {{ IncludeTemplate "app.selectorLabels" | nindent 4 }}
 {{ "{{- range $key, $value := .Values.deployment.labels }}" }}
     {{ "{{ $key }}: {{ $value | quote }}" }}
 {{ "{{- end }}" }}

templates/helm/templates/role-reader.yaml.tpl

@@ -6,12 +6,7 @@ metadata:
   name: {{ IncludeTemplate "app.fullname" }}-reader
   namespace: {{ "{{ .Release.Namespace }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 rules:
 - apiGroups:
   - {{ .APIGroup }}

templates/helm/templates/role-writer.yaml.tpl

@@ -6,12 +6,7 @@ metadata:
   name: {{ IncludeTemplate "app.fullname" }}-writer
   namespace: {{ "{{ .Release.Namespace }}" }}
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
 rules:
 - apiGroups:
   - {{ .APIGroup }}

templates/helm/templates/service-account.yaml.tpl

@@ -3,12 +3,7 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   labels:
-    app.kubernetes.io/name: {{ IncludeTemplate "app.name" }}
-    app.kubernetes.io/instance: {{ "{{ .Release.Name }}" }}
-    app.kubernetes.io/managed-by: Helm
-    app.kubernetes.io/version: {{ "{{ .Chart.AppVersion | quote }}" }}
-    k8s-app: {{ IncludeTemplate "app.name" }}
-    helm.sh/chart: {{ IncludeTemplate "chart.name-version" }}
+    {{ IncludeTemplate "app.labels" | nindent 4 }}
   name: {{ IncludeTemplate "service-account.name" }}
   namespace: {{ "{{ .Release.Namespace }}" }}
   annotations:

templates/helm/values.yaml.tpl

@@ -11,6 +11,9 @@ image:
 nameOverride: ""
 fullnameOverride: ""
 
+# Additional labels to add to all resources
+commonLabels: {}
+
 deployment:
   annotations: {}
   labels: {}