feat(helm): Add commonLabels and commonAnnotations (#870)

* Add commonLabels and commonAnnotations

* Bump chart to 0.14.0 & update README.md

---------

Co-authored-by: Niel De Boever <niel@Niels-MacBook-Pro-3.local>

Author: NielDB

helm/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: sql-exporter
 description: Database-agnostic SQL exporter for Prometheus
 type: application
-version: 0.13.5
+version: 0.14.0
 appVersion: 0.18.6
 keywords:
   - exporter

helm/README.md

@@ -1,6 +1,6 @@
 # sql-exporter
 
-![Version: 0.13.5](https://img.shields.io/badge/Version-0.13.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.18.6](https://img.shields.io/badge/AppVersion-0.18.6-informational?style=flat-square)
+![Version: 0.14.0](https://img.shields.io/badge/Version-0.14.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.18.6](https://img.shields.io/badge/AppVersion-0.18.6-informational?style=flat-square)
 
 Database-agnostic SQL exporter for Prometheus
 
@@ -52,6 +52,8 @@ as an example.
 |-----|------|---------|-------------|
 | nameOverride | string | `""` | Provide a name in place of `sql-exporter` |
 | fullnameOverride | string | `""` | String to fully override "sql-exporter.fullname" |
+| commonLabels | object | `{}` | Common labels to add to all deployed resources |
+| commonAnnotations | object | `{}` | Common annotations to add to all the deployed resources |
 | image.repository | string | `"burningalchemist/sql_exporter"` | Image repository |
 | image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
 | image.tag | string | `appVersion` value from `Chart.yaml` | Image tag |

helm/templates/_helpers.tpl

@@ -51,6 +51,9 @@ helm.sh/chart: {{ include "sql-exporter.chart" . }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- if .Values.commonLabels }}
+{{ toYaml .Values.commonLabels }}
+{{- end }}
 {{- end }}
 
 {{/*
@@ -61,6 +64,15 @@ app.kubernetes.io/name: {{ include "sql-exporter.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
 
+{{/*
+Common annotations
+*/}}
+{{- define "sql-exporter.annotations" -}}
+{{- if .Values.commonAnnotations }}
+{{ toYaml .Values.commonAnnotations }}
+{{- end }}
+{{- end }}
+
 {{/*
 Create the name of the service account to use
 */}}

helm/templates/configmap.collectors.yaml

@@ -5,6 +5,8 @@ metadata:
   name: {{ include "sql-exporter.fullname" . }}
   labels:
     {{- include "sql-exporter.labels" . | nindent 4 }}
+  annotations:
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
 data:
   {{- range $k, $v := .Values.collectorFiles }}
   {{ $k }}: |-

helm/templates/deployment.yaml

@@ -4,6 +4,8 @@ metadata:
   name: {{ include "sql-exporter.fullname" . }}
   labels:
     {{- include "sql-exporter.labels" . | nindent 4 }}
+  annotations:
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
 spec:
   replicas: {{ .Values.replicaCount }}
   selector:

helm/templates/ingress.yaml

@@ -8,10 +8,11 @@ metadata:
     {{- with .Values.ingress.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
-  {{- with .Values.ingress.annotations }}
   annotations:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
+    {{- with .Values.ingress.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   {{- if .Values.ingress.ingressClassName }}
   ingressClassName: {{ .Values.ingress.ingressClassName }}

helm/templates/secret.configuration.yaml

@@ -8,6 +8,8 @@ metadata:
   name: {{ include "sql-exporter.fullname" . }}
   labels:
     {{- include "sql-exporter.labels" . | nindent 4 }}
+  annotations:
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
 type: Opaque
 stringData:
   sql_exporter.yml: |-

helm/templates/secret.tls.yaml

@@ -8,6 +8,8 @@ metadata:
   name: {{ include "sql-exporter.tls.name" . }}
   labels:
     {{- include "sql-exporter.labels" . | nindent 4 }}
+  annotations:
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
 type: Opaque
 data:
   tls.crt: {{ (tpl (.Values.ingress.tls.crt | required "crt is required if you want to create tls secret.") .) | required "crt is required if you want to create tls secret." | b64enc | quote }}

helm/templates/service.yaml

@@ -7,10 +7,11 @@ metadata:
     {{- with .Values.service.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
-  {{- with .Values.service.annotations }}
   annotations:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
+    {{- with .Values.service.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   type: {{ .Values.service.type }}
   ports:

helm/templates/serviceaccount.yaml

@@ -3,14 +3,15 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ template "sql-exporter.fullname" . }}
-  {{- with .Values.serviceAccount.annotations}}
-  annotations:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
   labels:
+    {{- include "sql-exporter.labels" . | nindent 4 }}
     {{- with .Values.serviceAccount.labels }}
-    {{- toYaml . | nindent 4 }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
+  annotations:
+    {{- include "sql-exporter.annotations" . | nindent 4 }}
+    {{- with .Values.serviceAccount.annotations}}
+      {{- toYaml . | nindent 4 }}
     {{- end }}
-    {{- include "sql-exporter.labels" . | nindent 4 }}
 automountServiceAccountToken: {{ default "false" .Values.serviceAccount.automountServiceAccountToken }}
 {{- end }}