[ENHANCEMENT] Refactoring Kubernetes labels (#19)

* Update: Refactoring Kubernetes labels Signed-off-by: Nicolas Lamirault <[email protected]> * [DOC] Generate README with additional label objects Signed-off-by: Ronny Trommer <[email protected]> --------- Signed-off-by: Nicolas Lamirault <[email protected]> Signed-off-by: Ronny Trommer <[email protected]> Co-authored-by: Nicolas Lamirault <[email protected]>
perses · Aug 21, 2024 · 5e60e7a · 5e60e7a
1 parent 14cc255
commit 5e60e7a
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 0 deletions.
diff --git a/charts/perses/README.md b/charts/perses/README.md
@@ -28,6 +28,7 @@ helm delete my-release
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
+| additionalLabels | object | `{}` |  |
 | annotations | object | `{}` | Statefulset Annotations |
 | config | object | `{"annotations":{},"database":{"file":{"extension":"json","folder":"/perses"},"sql":{}},"important_dashboards":[],"provisioning":{"folders":["/etc/perses/datasources"]},"schemas":{"datasources_path":"/etc/perses/cue/schemas/datasources","interval":"5m","panels_path":"/etc/perses/cue/schemas/panels","queries_path":"/etc/perses/cue/schemas/queries","variables_path":"/etc/perses/cue/schemas/variables"},"security":{"cookie":{"same_site":"lax","secure":false},"enableAuth":false,"readOnly":false}}` | Perses configuration file ref: https://github.com/perses/perses/blob/main/docs/user-guides/configuration.md |
 | config.annotations | object | `{}` | Annotations for config |

diff --git a/charts/perses/templates/_helpers.tpl b/charts/perses/templates/_helpers.tpl
@@ -39,7 +39,11 @@ helm.sh/chart: {{ include "perses.chart" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
+app.kubernetes.io/part-of: {{ include "perses.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- if .Values.additionalLabels }}
+{{ toYaml .Values.additionalLabels }}
+{{- end }}
 {{- end }}
 
 {{/*

diff --git a/charts/perses/templates/config.yaml b/charts/perses/templates/config.yaml
@@ -4,6 +4,7 @@ metadata:
   name: {{ include "perses.fullname" . }}
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: configuration
   {{- with .Values.config.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

diff --git a/charts/perses/templates/datasources.yaml b/charts/perses/templates/datasources.yaml
@@ -5,6 +5,7 @@ metadata:
   name: {{ include "perses.fullname" . }}-datasources
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: configuration
 data:
   {{- range $.Values.datasources }}
   {{ .metadata.name | lower }}.json: |-

diff --git a/charts/perses/templates/ingress.yaml b/charts/perses/templates/ingress.yaml
@@ -5,6 +5,7 @@ metadata:
   name: {{ include "perses.fullname" . }}
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: networking
   {{- with .Values.ingress.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

diff --git a/charts/perses/templates/pvc.yaml b/charts/perses/templates/pvc.yaml
@@ -5,6 +5,7 @@ metadata:
   name: {{ include "perses.fullname" . }}
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: storage
   {{- with .Values.persistence.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

diff --git a/charts/perses/templates/service.yaml b/charts/perses/templates/service.yaml
@@ -4,6 +4,7 @@ metadata:
   name: {{ include "perses.fullname" . }}
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: networking
     {{- with .Values.service.labels }}
     {{- toYaml . | nindent 4 }}
     {{- end }}

diff --git a/charts/perses/templates/serviceaccount.yaml b/charts/perses/templates/serviceaccount.yaml
@@ -5,6 +5,7 @@ metadata:
   name: {{ include "perses.serviceAccountName" . }}
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: iam
   {{- with .Values.serviceAccount.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

diff --git a/charts/perses/templates/statefulset.yaml b/charts/perses/templates/statefulset.yaml
@@ -4,6 +4,7 @@ metadata:
   name: {{ include "perses.fullname" . }}
   labels:
     {{- include "perses.labels" . | nindent 4 }}
+    app.kubernetes.io/component: workload
   {{- with .Values.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

diff --git a/charts/perses/values.schema.json b/charts/perses/values.schema.json
@@ -31,6 +31,9 @@
         "pullPolicy"
       ]
     },
+    "additionalLabels": {
+      "type": "object"
+    },
     "service": {
       "type": "object",
       "additionalProperties": false,

diff --git a/charts/perses/values.yaml b/charts/perses/values.yaml
@@ -20,6 +20,9 @@ image:
   # -- Default image pull policy
   pullPolicy: IfNotPresent
 
+additionalLabels: {}
+  # app: perses
+
 # -- Service account for Perses to use.
 serviceAccount:
   # -- Specifies whether a service account should be created