feat: add additional deployment metadata labels (#225)

Co-authored-by: Ronny Bräunlich <[email protected]>
apache · Jan 11, 2024 · 57b7ce6 · 57b7ce6
1 parent 8c79a4b
commit 57b7ce6
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/HelmSetup.md b/HelmSetup.md
@@ -176,21 +176,23 @@ Some useful parameters for the chart, you could also check them in values.yaml
 | lake.encryptionSecret.secretName          | the k8s secret name for ENCRYPTION_SECRET                                             | ""                       |
 | lake.encryptionSecret.secret              | the secret for ENCRYPTION_SECRET                                                      | ""                       |
 | lake.encryptionSecret.autoCreateSecret    | whether let the helm chart create the secret                                          | true                     |
-| lake.extraLabels                          | extra labels for lake's statefulset                                                   | {}                       |
+| lake.extraLabels                          | extra labels for lake's deployment template                                           | {}                       |
 | lake.securityContext                      | pod security context values                                                           | {}                       |
 | lake.containerSecurityContext             | container security context values                                                     | {}                       |
 | lake.livenessProbe                        | container livenessprobe                                                               | see Values.yaml          |
 | lake.readinessProbe                       | container readinessProbe                                                              | {}                       |
+| lake.deployment.extraLabels               | extra labels for lake's deployment metadata                                           | {}                       |
 | ui.image.repository                       | repository for ui's image                                                             | apache/devlake-config-ui |
 | ui.image.pullPolicy                       | pullPolicy for ui's image                                                             | Always                   |
 | ui.basicAuth.enabled                      | If the basic auth in ui is enabled                                                    | false                    |
 | ui.basicAuth.user                         | The user name for the basic auth                                                      | "admin"                  |
 | ui.basicAuth.password                     | The password for the basic auth                                                       | "admin"                  |
 | ui.basicAuth.autoCreateSecret             | If let the helm chart create the secret                                               | true                     |
 | ui.basicAuth.secretName                   | The basic auth secret name                                                            | ""                       |
-| ui.extraLabels                            | extra labels for ui's statefulset                                                     | {}                       |
+| ui.extraLabels                            | extra labels for ui's deployment template                                             | {}                       |
 | ui.securityContext                        | pod security context values                                                           | {}                       |
 | ui.containerSecurityContext               | container security context values                                                     | {}                       |
+| ui.deployment.extraLabels                 | extra labels for ui's deployment metadata                                             | {}                       |
 | service.type                              | Service type for exposed service                                                      | NodePort                 |
 | service.uiPort                            | Node port for config ui                                                               | 32001                    |
 | service.ingress.enabled                   | If enable ingress                                                                     | false                    |
@@ -293,4 +295,4 @@ helm install devlake devlake/devlake \
 
 ## 6 Troubleshooting
 
-If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
+If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
diff --git a/charts/devlake/templates/deployments.yaml b/charts/devlake/templates/deployments.yaml
@@ -22,6 +22,9 @@ metadata:
   name: {{ include "devlake.fullname" . }}-ui
   labels:
     {{- include "devlake.labels" . | nindent 4 }}
+    {{- with .Values.ui.deployment.extraLabels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   replicas: 1
   selector:
@@ -102,6 +105,9 @@ metadata:
   name: {{ include "devlake.fullname" . }}-lake
   labels:
   {{- include "devlake.labels" . | nindent 4 }}
+  {{- with .Values.lake.deployment.extraLabels }}
+  {{- toYaml . | nindent 4 }}
+  {{- end }}
 spec:
   replicas: 1
   selector:

diff --git a/charts/devlake/values.yaml b/charts/devlake/values.yaml
@@ -218,6 +218,9 @@ lake:
 
   readinessProbe: {}
 
+  deployment:
+    extraLabels: {}
+
 ui:
   image:
     repository: devlake.docker.scarf.sh/apache/devlake-config-ui
@@ -262,6 +265,9 @@ ui:
     #   drop:
     #       - all
 
+  deployment:
+    extraLabels: {}
+
 # alpine image for some init containers
 alpine:
   image: