build: create resources with k8s recommended labels

Adding Recommended Labels on the rook resources, for better visuals and management of k8s object Closes: rook#8400 Signed-off-by: parth-gr <paarora@redhat.com>
parth-gr · Sep 14, 2021 · 4cd58d5 · 4cd58d5
1 parent 235d5a3
commit 4cd58d5
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 42 deletions.
diff --git a/cluster/charts/rook-ceph/templates/_helpers.tpl b/cluster/charts/rook-ceph/templates/_helpers.tpl
@@ -18,9 +18,17 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 {{/*
 Define imagePullSecrets option to pass to all service accounts
 */}}
-{{- define "imagePullSecrets" }}
+{{- define "imagePullSecrets" -}}
 {{- if .Values.imagePullSecrets -}}
 imagePullSecrets:
 {{ toYaml .Values.imagePullSecrets }}
 {{- end -}}
 {{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "rook-ceph.labels" -}}
+app.kubernetes.io/operator: {{ "rook" -}}
+app.kubernetes.io/storage-backend: {{ "ceph" -}}
+{{- end -}}
diff --git a/cluster/charts/rook-ceph/templates/clusterrole.yaml b/cluster/charts/rook-ceph/templates/clusterrole.yaml
@@ -4,8 +4,8 @@ apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: rook-ceph-system
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
   # Most resources are represented by a string representation of their name, such as “pods”, just as it appears in the URL for the relevant API endpoint.
   # However, some Kubernetes APIs involve a “subresource”, such as the logs for a pod. [...]
@@ -24,8 +24,8 @@ kind: ClusterRole
 metadata:
   name: rook-ceph-cluster-mgmt
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
 - apiGroups:
   - ""
@@ -54,8 +54,8 @@ kind: ClusterRole
 metadata:
   name: rook-ceph-global
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
 - apiGroups:
   - ""
@@ -174,8 +174,8 @@ apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: rook-ceph-mgr-cluster
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
 - apiGroups:
   - ""
@@ -226,9 +226,8 @@ kind: ClusterRole
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: rook-ceph-object-bucket
-  labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
 - apiGroups:
   - ""
@@ -272,8 +271,8 @@ kind: ClusterRole
 metadata:
   name: rook-ceph-agent-mount
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
 - apiGroups:
   - ""
@@ -458,8 +457,8 @@ kind: ClusterRole
 metadata:
   name: 'psp:rook'
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 rules:
 - apiGroups:

diff --git a/cluster/charts/rook-ceph/templates/clusterrolebinding.yaml b/cluster/charts/rook-ceph/templates/clusterrolebinding.yaml
@@ -4,8 +4,8 @@ apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: rook-ceph-system
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole
@@ -21,8 +21,8 @@ apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: rook-ceph-global
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 roleRef:
   apiGroup: rbac.authorization.k8s.io
@@ -120,8 +120,8 @@ kind: ClusterRoleBinding
 metadata:
   name: rook-ceph-system-psp
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 roleRef:
   apiGroup: rbac.authorization.k8s.io
@@ -138,8 +138,8 @@ metadata:
   name: rook-ceph-default-psp
   namespace: {{ .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 roleRef:
   apiGroup: rbac.authorization.k8s.io
@@ -155,8 +155,8 @@ kind: ClusterRoleBinding
 metadata:
   name: rook-ceph-system-psp-users
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 roleRef:
   apiGroup: rbac.authorization.k8s.io

diff --git a/cluster/charts/rook-ceph/templates/deployment.yaml b/cluster/charts/rook-ceph/templates/deployment.yaml
@@ -3,8 +3,8 @@ kind: Deployment
 metadata:
   name: rook-ceph-operator
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 spec:
   replicas: 1

diff --git a/cluster/charts/rook-ceph/templates/role.yaml b/cluster/charts/rook-ceph/templates/role.yaml
@@ -6,8 +6,8 @@ metadata:
   name: rook-ceph-system
   namespace:  {{  .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
 rules:
 - apiGroups:
   - ""

diff --git a/cluster/charts/rook-ceph/templates/rolebinding.yaml b/cluster/charts/rook-ceph/templates/rolebinding.yaml
@@ -6,8 +6,7 @@ metadata:
   name: rook-ceph-system
   namespace: {{ .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role

diff --git a/cluster/charts/rook-ceph/templates/serviceaccount.yaml b/cluster/charts/rook-ceph/templates/serviceaccount.yaml
@@ -5,8 +5,8 @@ metadata:
   name: rook-ceph-system
   namespace:  {{  .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 {{ template "imagePullSecrets" . }}
 ---
@@ -17,8 +17,8 @@ metadata:
   name: rook-ceph-osd
   namespace:  {{  .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 {{ template "imagePullSecrets" . }}
 ---
@@ -29,8 +29,8 @@ metadata:
   name: rook-ceph-mgr
   namespace:  {{  .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 {{ template "imagePullSecrets" . }}
 ---
@@ -40,8 +40,8 @@ metadata:
   name: rook-ceph-cmd-reporter
   namespace:  {{  .Release.Namespace }}
   labels:
-    operator: rook
-    storage-backend: ceph
+     {{- include "rook-ceph.labels" . | nindent 4 }}
+
     chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"
 {{ template "imagePullSecrets" . }}
 ---

diff --git a/tests/integration/ceph_base_file_test.go b/tests/integration/ceph_base_file_test.go
@@ -555,8 +555,8 @@ kind: ClusterRoleBinding
 metadata:
   name: rook-ceph-agent-mount
   labels:
-    operator: rook
-    storage-backend: ceph
+    app.kubernetes.io/operator: rook
+    app.kubernetes.io/storage-backend: ceph
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole