Adding helm values to set common labels and annotations (#153)

* Adding helm values to set common labels and annotations * Updated changelog * Migrating helm labels/annotation setup to named templates * Renaming helm fields to annotations and labels Co-authored-by: Alexandre Guitton <[email protected]>
konpyutaika · Aug 26, 2022 · 4224e53 · 4224e53
1 parent 5c8a349
commit 4224e53
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - [PR #138](https://github.com/konpyutaika/nifikop/pull/138) - **[Operator/NifiCluster]** Add ability to configure the NiFi Load Balance port.
 - [PR #144](https://github.com/konpyutaika/nifikop/pull/144) - **[Operator]** Add automatic detection of k8s prior 1.21.
+- [PR #153](https://github.com/konpyutaika/nifikop/pull/153) - **[Helm Chart]** Added helm values to set common labels and annotations.
 
 ### Changed
 

diff --git a/helm/nifikop/README.md b/helm/nifikop/README.md
@@ -29,6 +29,8 @@ The following tables lists the configurable parameters of the NiFi Operator Helm
 | `image.imagePullSecrets.name`    | Name of the secret to connect to docker registry                                                                                                                                     | -                        |
 | `certManager.enabled`            | Enable cert-manager integration                                                                                                                                                      | `true`                   |
 | `rbacEnable`                     | If true, create & use RBAC resources                                                                                                                                                 | `true`                   |
+| `labels`                         | Labels to add to all deployed resources                                                                                                                                              | `{}`                     |
+| `annotations`                         | Annotations to add to all deployed resources                                                                                                                                         | `{}`                     |
 | `resources`                      | Pod resource requests & limits                                                                                                                                                       | `{}`                     |
 | `metrics.enabled`                | deploy service for metrics                                                                                                                                                           | `false`                  |
 | `metrics.port`                   | Set port for operator metrics                                                                                                                                                        | `8081`                   |

diff --git a/helm/nifikop/templates/_functions.tpl b/helm/nifikop/templates/_functions.tpl
@@ -31,3 +31,18 @@ Return the appropriate apiVersion value to use for the capi-operator managed k8s
 {{- printf "%s" "nificlusters.nifi.konpyutaika.com/v1alpha1" -}}
 {{- end -}}
 
+{{- define "userdefined.labels" }}
+{{ if .Values.labels }}
+{{- with .Values.labels }}
+{{- toYaml . | nindent 4 }}
+{{- end}}
+{{- end}}
+{{- end }}
+
+{{- define "userdefined.annotations" }}
+{{ if .Values.annotations }}
+{{- with .Values.annotations }}
+{{- toYaml . | nindent 4 }}
+{{- end}}
+{{- end}}
+{{- end }}
diff --git a/helm/nifikop/templates/deployment.yaml b/helm/nifikop/templates/deployment.yaml
@@ -10,6 +10,9 @@ metadata:
     operator: nifi
     release: {{ .Release.Name }}
     control-plane: nifikop
+    {{- include "userdefined.labels" . }}
+  annotations:
+    {{- include "userdefined.annotations" . }}
 spec:
   selector:
     matchLabels:
@@ -24,6 +27,9 @@ spec:
         app: {{ template "nifikop.name" . }}
         operator: nifi
         release: {{ .Release.Name }}
+        {{- include "userdefined.labels" . | indent 4 }}
+      annotations:
+        {{- include "userdefined.annotations" . | indent 4 }}
     spec:
     {{- with .Values.nodeSelector }}
       nodeSelector:

diff --git a/helm/nifikop/templates/role.yaml b/helm/nifikop/templates/role.yaml
@@ -9,6 +9,9 @@ metadata:
     chart: {{ $.Chart.Name }}-{{ $.Chart.Version }}
     heritage: {{ $.Release.Service }}
     release: {{ $.Release.Name }}
+    {{- include "userdefined.labels" $_ }}
+  annotations:
+    {{- include "userdefined.annotations" $_ }}
   name: {{ template "nifikop.name" $_ }}
   namespace: {{$namespace}}
 rules:

diff --git a/helm/nifikop/templates/role_binding.yaml b/helm/nifikop/templates/role_binding.yaml
@@ -10,6 +10,9 @@ metadata:
     chart: {{ $.Chart.Name }}-{{ $.Chart.Version }}
     heritage: {{ $.Release.Service }}
     release: {{ $.Release.Name }}
+    {{- include "userdefined.labels" $_ }}
+  annotations:
+    {{- include "userdefined.annotations" $_ }}
   name: {{ template "nifikop.name" $ }}
   namespace: {{ $namespace }}
 subjects:

diff --git a/helm/nifikop/templates/service.yaml b/helm/nifikop/templates/service.yaml
@@ -10,6 +10,9 @@ metadata:
     chart: {{ .Chart.Name }}-{{ .Chart.Version }}
     heritage: {{ .Release.Service }}
     release: {{ .Release.Name }}
+    {{- include "userdefined.labels" . }}
+  annotations:
+    {{- include "userdefined.annotations" . }}
 spec:
   selector:
     app: {{ template "nifikop.name" . }}

diff --git a/helm/nifikop/templates/service_account.yaml b/helm/nifikop/templates/service_account.yaml
@@ -7,6 +7,9 @@ metadata:
     chart: {{ .Chart.Name }}-{{ .Chart.Version }}
     heritage: {{ .Release.Service }}
     release: {{ .Release.Name }}
+    {{- include "userdefined.labels" . }}
+  annotations:
+    {{- include "userdefined.annotations" . }}
   {{- if and .Values.serviceAccount .Values.serviceAccount.name}}
   name: {{ .Values.serviceAccount.name }}      
   {{- else }}

diff --git a/helm/nifikop/values.yaml b/helm/nifikop/values.yaml
@@ -13,6 +13,12 @@ vaultSecret: ""
 # set of namespaces where the operator watches resources
 namespaces: []
 
+# Optional labels to add to all deployed resources
+labels: {}
+
+# Optional annotations to add to all deployed resources
+annotations: {}
+
 ## Prometheus-operator resource limits & requests
 ## Ref: https://kubernetes.io/docs/user-guide/compute-resources/
 resources:

diff --git a/site/docs/2_setup/3_install/1_customizable_install_with_helm.md b/site/docs/2_setup/3_install/1_customizable_install_with_helm.md
@@ -38,6 +38,8 @@ The following tables lists the configurable parameters of the NiFi Operator Helm
 | `image.imagePullSecrets.name`    | Name of the secret to connect to docker registry                                                                                                                                     | -                                           |
 | `certManager.enabled`            | Enable cert-manager integration                                                                                                                                                      | `true`                                      |
 | `rbacEnable`                     | If true, create & use RBAC resources                                                                                                                                                 | `true`                                      |
+| `labels`                         | Labels to add to all deployed resources                                                                                                                                              | `{}`                                        |
+| `annotations`                    | Annotations to add to all deployed resources                                                                                                                                         | `{}`                                        |
 | `resources`                      | Pod resource requests & limits                                                                                                                                                       | `{}`                                        |
 | `metrics.enabled`                | deploy service for metrics                                                                                                                                                           | `false`                                     |
 | `metrics.port`                   | Set port for operator metrics                                                                                                                                                        | `8081`                                      |