[KYUUBI #3980] [K8S][HELM] Use recommended labels in helm chart

### _Why are the changes needed?_ The changes are needed to be compliant with official Kubernetes and Helm recommendations: - https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/ - https://helm.sh/docs/chart_best_practices/labels/#standard-labels ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #3980 from dnskr/helm_recommended_labels. Closes #3980 937da0e [dnskr] [K8S][HELM] Use recommended labels in helm chart Authored-by: dnskr <dnskrv88@gmail.com> Signed-off-by: Cheng Pan <chengpan@apache.org>
apache · Dec 15, 2022 · ff6b792 · ff6b792
1 parent b5590b8
commit ff6b792
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 14 deletions.
diff --git a/docker/helm/templates/kyuubi-configmap.yaml b/docker/helm/templates/kyuubi-configmap.yaml
@@ -20,7 +20,11 @@ kind: ConfigMap
 metadata:
   name: {{ .Release.Name }}-kyuubi-defaults
   labels:
-    app: {{ template "kyuubi.name" . }}
+    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
 data:
   kyuubi-defaults.conf: |
     #

diff --git a/docker/helm/templates/kyuubi-deployment.yaml b/docker/helm/templates/kyuubi-deployment.yaml
@@ -20,20 +20,22 @@ kind: Deployment
 metadata:
   name: {{ .Release.Name }}
   labels:
-    app: {{ template "kyuubi.name" . }}
-    release: {{ .Release.Name }}
-    heritage: {{ .Release.Service }}
+    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
 spec:
   replicas: {{ .Values.replicaCount }}
   selector:
     matchLabels:
-      app: {{ template "kyuubi.name" . }}
-      release: {{ .Release.Name }}
+      app.kubernetes.io/name: {{ .Chart.Name }}
+      app.kubernetes.io/instance: {{ .Release.Name }}
   template:
     metadata:
       labels:
-        app: {{ template "kyuubi.name" . }}
-        release: {{ .Release.Name }}
+        app.kubernetes.io/name: {{ .Chart.Name }}
+        app.kubernetes.io/instance: {{ .Release.Name }}
     spec:
       {{- with .Values.imagePullSecrets }}
       imagePullSecrets: {{- toYaml . | nindent 8 }}

diff --git a/docker/helm/templates/kyuubi-role.yaml b/docker/helm/templates/kyuubi-role.yaml
@@ -21,6 +21,10 @@ kind: Role
 metadata:
   name: {{ .Release.Name }}
   labels:
-    app: {{ template "kyuubi.name" . }}
+    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
 rules: {{- toYaml .Values.rbac.rules | nindent 2 }}
 {{- end }}
diff --git a/docker/helm/templates/kyuubi-rolebinding.yaml b/docker/helm/templates/kyuubi-rolebinding.yaml
@@ -21,7 +21,11 @@ kind: RoleBinding
 metadata:
   name: {{ .Release.Name }}
   labels:
-    app: {{ template "kyuubi.name" . }}
+    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
 subjects:
   - kind: ServiceAccount
     name: {{ .Values.serviceAccount.name | default .Release.Name }}

diff --git a/docker/helm/templates/kyuubi-service.yaml b/docker/helm/templates/kyuubi-service.yaml
@@ -20,7 +20,11 @@ kind: Service
 metadata:
   name: {{ .Release.Name }}
   labels:
-    app: {{ template "kyuubi.name" . }}
+    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
   {{- with .Values.service.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}
@@ -33,5 +37,5 @@ spec:
       protocol: TCP
   type: {{ .Values.service.type }}
   selector:
-    app: {{ template "kyuubi.name" . }}
-    release: {{ .Release.Name }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
diff --git a/docker/helm/templates/kyuubi-serviceaccount.yaml b/docker/helm/templates/kyuubi-serviceaccount.yaml
@@ -21,5 +21,9 @@ kind: ServiceAccount
 metadata:
   name: {{ .Values.serviceAccount.name | default .Release.Name }}
   labels:
-    app: {{ template "kyuubi.name" . }}
+    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}