Rework labels in Opensearch chart to match standard recommendations (#37

) * feat: rework labels to match standard recommendations https://helm.sh/docs/chart_best_practices/labels/#standard-labels https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/ Signed-off-by: Scott Leggett <[email protected]> * chore: bump opensearch chart version Signed-off-by: Scott Leggett <[email protected]>
opensearch-project · Oct 19, 2021 · 09f1b4c · 09f1b4c
1 parent 00c507f
commit 09f1b4c
Show file tree

Hide file tree

Showing 13 changed files with 74 additions and 73 deletions.
diff --git a/charts/opensearch/Chart.yaml b/charts/opensearch/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.1.0
+version: 1.2.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/opensearch/templates/_helpers.tpl b/charts/opensearch/templates/_helpers.tpl
@@ -3,17 +3,52 @@
 Expand the name of the chart.
 */}}
 {{- define "opensearch.name" -}}
-{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
-{{- end -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
 
 {{/*
 Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
 */}}
 {{- define "opensearch.fullname" -}}
-{{- $name := default .Chart.Name .Values.nameOverride -}}
-{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
-{{- end -}}
+{{- if contains .Chart.Name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name .Chart.Name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "opensearch.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "opensearch.labels" -}}
+helm.sh/chart: {{ include "opensearch.chart" . }}
+{{ include "opensearch.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+app.kubernetes.io/component: {{ include "opensearch.uname" . }}
+{{- with .Values.labels }}
+{{ toYaml . }}
+{{- end }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "opensearch.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "opensearch.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
 
 {{- define "opensearch.uname" -}}
 {{- if empty .Values.fullnameOverride -}}

diff --git a/charts/opensearch/templates/configmap.yaml b/charts/opensearch/templates/configmap.yaml
@@ -4,10 +4,7 @@ kind: ConfigMap
 metadata:
   name: {{ template "opensearch.uname" . }}-config
   labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}"
-    app: "{{ template "opensearch.uname" . }}"
+    {{- include "opensearch.labels" . | nindent 4 }}
 data:
 {{- range $configName, $configYaml := .Values.config }}
   {{ $configName }}: |

diff --git a/charts/opensearch/templates/ingress.yaml b/charts/opensearch/templates/ingress.yaml
@@ -7,9 +7,7 @@ kind: Ingress
 metadata:
   name: {{ $fullName }}
   labels:
-    app: {{ .Chart.Name }}
-    release: {{ .Release.Name }}
-    heritage: {{ .Release.Service }}
+    {{- include "opensearch.labels" . | nindent 4 }}
 {{- with .Values.ingress.annotations }}
   annotations:
 {{ toYaml . | indent 4 }}

diff --git a/charts/opensearch/templates/networkpolicy.yaml b/charts/opensearch/templates/networkpolicy.yaml
@@ -2,6 +2,8 @@ apiVersion: networking.k8s.io/v1
 kind: NetworkPolicy
 metadata:
   name: {{ template "opensearch.uname" . }}-opensearch-net
+  labels:
+    {{- include "opensearch.labels" . | nindent 4 }}
 spec:
   ingress:
   - from:

diff --git a/charts/opensearch/templates/poddisruptionbudget.yaml b/charts/opensearch/templates/poddisruptionbudget.yaml
@@ -4,9 +4,11 @@ apiVersion: policy/v1beta1
 kind: PodDisruptionBudget
 metadata:
   name: "{{ template "opensearch.uname" . }}-pdb"
+  labels:
+    {{- include "opensearch.labels" . | nindent 4 }}
 spec:
   maxUnavailable: {{ .Values.maxUnavailable }}
   selector:
     matchLabels:
-      app: "{{ template "opensearch.uname" . }}"
+      {{- include "opensearch.selectorLabels" . | nindent 6 }}
 {{- end }}
diff --git a/charts/opensearch/templates/podsecuritypolicy.yaml b/charts/opensearch/templates/podsecuritypolicy.yaml
@@ -5,10 +5,7 @@ kind: PodSecurityPolicy
 metadata:
   name: {{ default $fullName .Values.podSecurityPolicy.name | quote }}
   labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    app: {{ $fullName | quote }}
+    {{- include "opensearch.labels" . | nindent 4 }}
 spec:
 {{ toYaml .Values.podSecurityPolicy.spec | indent 2 }}
 {{- if .Values.sysctl.enabled }}

diff --git a/charts/opensearch/templates/role.yaml b/charts/opensearch/templates/role.yaml
@@ -4,11 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   name: {{ $fullName | quote }}
-  labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    app: {{ $fullName | quote }}
+    {{- include "opensearch.labels" . | nindent 4 }}
 rules:
   - apiGroups:
       - extensions

diff --git a/charts/opensearch/templates/rolebinding.yaml b/charts/opensearch/templates/rolebinding.yaml
@@ -5,10 +5,7 @@ kind: RoleBinding
 metadata:
   name: {{ $fullName | quote }}
   labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    app: {{ $fullName | quote }}
+    {{- include "opensearch.labels" . | nindent 4 }}
 subjects:
   - kind: ServiceAccount
     {{- if eq .Values.rbac.serviceAccountName "" }}

diff --git a/charts/opensearch/templates/securityconfig.yaml b/charts/opensearch/templates/securityconfig.yaml
@@ -5,9 +5,7 @@ metadata:
   name: {{ include "opensearch.uname" . }}-securityconfig
   namespace: {{ .Release.Namespace }}
   labels:
-    app: {{ .Chart.Name }}
-    release: {{ .Release.Name }}
-    heritage: {{ .Release.Service }}
+    {{- include "opensearch.labels" . | nindent 4 }}
 type: Opaque
 stringData:
 {{- range $key, $val := .Values.securityConfig.config.data }}

diff --git a/charts/opensearch/templates/service.yaml b/charts/opensearch/templates/service.yaml
@@ -8,10 +8,7 @@ metadata:
   name: {{ template "opensearch.uname" . }}
 {{- end }}
   labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}"
-    app: "{{ template "opensearch.uname" . }}"
+    {{- include "opensearch.labels" . | nindent 4 }}
 {{- if .Values.service.labels }}
 {{ toYaml .Values.service.labels | indent 4}}
 {{- end }}
@@ -20,9 +17,7 @@ metadata:
 spec:
   type: {{ .Values.service.type }}
   selector:
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}"
-    app: "{{ template "opensearch.uname" . }}"
+    {{- include "opensearch.selectorLabels" . | nindent 4 }}
   ports:
   - name: {{ .Values.service.httpPortName | default "http" }}
     protocol: TCP
@@ -53,10 +48,7 @@ metadata:
   name: {{ template "opensearch.uname" . }}-headless
 {{- end }}
   labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}"
-    app: "{{ template "opensearch.uname" . }}"
+    {{- include "opensearch.labels" . | nindent 4 }}
 {{- if .Values.service.labelsHeadless }}
 {{ toYaml .Values.service.labelsHeadless | indent 4 }}
 {{- end }}
@@ -67,7 +59,7 @@ spec:
   # Create endpoints also if the related pod isn't ready
   publishNotReadyAddresses: true
   selector:
-    app: "{{ template "opensearch.uname" . }}"
+    {{- include "opensearch.selectorLabels" . | nindent 4 }}
   ports:
   - name: {{ .Values.service.httpPortName | default "http" }}
     port: {{ .Values.httpPort }}

diff --git a/charts/opensearch/templates/serviceaccount.yaml b/charts/opensearch/templates/serviceaccount.yaml
@@ -8,13 +8,10 @@ metadata:
   {{- else }}
   name: {{ .Values.rbac.serviceAccountName | quote }}
   {{- end }}
+  labels:
+    {{- include "opensearch.labels" . | nindent 4 }}
   annotations:
     {{- with .Values.rbac.serviceAccountAnnotations }}
     {{- toYaml . | nindent 4 }}
     {{- end }}
-  labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
-    app: {{ $fullName | quote }}
 {{- end -}}
diff --git a/charts/opensearch/templates/statefulset.yaml b/charts/opensearch/templates/statefulset.yaml
@@ -4,22 +4,14 @@ kind: StatefulSet
 metadata:
   name: {{ template "opensearch.uname" . }}
   labels:
-    heritage: {{ .Release.Service | quote }}
-    release: {{ .Release.Name | quote }}
-    chart: "{{ .Chart.Name }}"
-    app: "{{ template "opensearch.uname" . }}"
-    {{- range $key, $value := .Values.labels }}
-    {{ $key }}: {{ $value | quote }}
-    {{- end }}
+    {{- include "opensearch.labels" . | nindent 4 }}
   annotations:
     majorVersion: "{{ include "opensearch.majorVersion" . }}"
 spec:
   serviceName: {{ template "opensearch.uname" . }}-headless
   selector:
     matchLabels:
-      release: {{ .Release.Name | quote }}
-      chart: "{{ .Chart.Name }}"
-      app: "{{ template "opensearch.uname" . }}"
+      {{- include "opensearch.selectorLabels" . | nindent 6 }}
   replicas: {{ .Values.replicas }}
   podManagementPolicy: {{ .Values.podManagementPolicy }}
   updateStrategy:
@@ -30,12 +22,7 @@ spec:
       name: {{ template "opensearch.uname" . }}
     {{- if .Values.persistence.labels.enabled }}
       labels:
-        release: {{ .Release.Name | quote }}
-        chart: "{{ .Chart.Name }}"
-        app: "{{ template "opensearch.uname" . }}"
-        {{- range $key, $value := .Values.labels }}
-        {{ $key }}: {{ $value | quote }}
-        {{- end }}
+        {{- include "opensearch.labels" . | nindent 8 }}
     {{- end }}
     {{- with .Values.persistence.annotations  }}
       annotations:
@@ -61,12 +48,7 @@ spec:
     metadata:
       name: "{{ template "opensearch.uname" . }}"
       labels:
-        release: {{ .Release.Name | quote }}
-        chart: "{{ .Chart.Name }}"
-        app: "{{ template "opensearch.uname" . }}"
-        {{- range $key, $value := .Values.labels }}
-        {{ $key }}: {{ $value | quote }}
-        {{- end }}
+        {{- include "opensearch.labels" . | nindent 8 }}
       annotations:
         {{- range $key, $value := .Values.podAnnotations }}
         {{ $key }}: {{ $value | quote }}
@@ -113,10 +95,14 @@ spec:
           requiredDuringSchedulingIgnoredDuringExecution:
           - labelSelector:
               matchExpressions:
-              - key: app
+              - key: app.kubernetes.io/instance
                 operator: In
                 values:
-                - "{{ template "opensearch.uname" .}}"
+                - {{ .Release.Name }}
+              - key: app.kubernetes.io/name
+                operator: In
+                values:
+                - {{ include "opensearch.name" . }}
             topologyKey: {{ .Values.antiAffinityTopologyKey }}
       {{- else if eq .Values.antiAffinity "soft" }}
         podAntiAffinity:
@@ -126,10 +112,14 @@ spec:
               topologyKey: {{ .Values.antiAffinityTopologyKey }}
               labelSelector:
                 matchExpressions:
-                - key: app
+                - key: app.kubernetes.io/instance
+                  operator: In
+                  values:
+                  - {{ .Release.Name }}
+                - key: app.kubernetes.io/name
                   operator: In
                   values:
-                  - "{{ template "opensearch.uname" . }}"
+                  - {{ include "opensearch.name" . }}
       {{- end }}
       {{- with .Values.nodeAffinity }}
         nodeAffinity: