feat(helm): add grafana dashboard (#4686)

* feat(helm): add grafana dashboard

Signed-off-by: Devin Buhl <devin@buhl.casa>

* escape non-helm template values

Signed-off-by: Devin Buhl <devin@buhl.casa>

* fix: use tpl ext on dashboard

Signed-off-by: Devin Buhl <devin@buhl.casa>

* fix: move dashboard to files folder

Signed-off-by: Devin Buhl <devin@buhl.casa>

---------

Signed-off-by: Devin Buhl <devin@buhl.casa>

deploy/charts/external-secrets/README.md

@@ -110,6 +110,10 @@ The command removes all the Kubernetes components associated with the chart and
 | global.nodeSelector | object | `{}` |  |
 | global.tolerations | list | `[]` |  |
 | global.topologySpreadConstraints | list | `[]` |  |
+| grafanaDashboard.annotations | object | `{}` | Annotations that ConfigMaps can have to get configured in Grafana, See: sidecar.dashboards.folderAnnotation for specifying the dashboard folder. https://github.com/grafana/helm-charts/tree/main/charts/grafana |
+| grafanaDashboard.enabled | bool | `false` | If true creates a Grafana dashboard. |
+| grafanaDashboard.sidecarLabel | string | `"grafana_dashboard"` | Label that ConfigMaps should have to be loaded as dashboards. |
+| grafanaDashboard.sidecarLabelValue | string | `"1"` | Label value that ConfigMaps should have to be loaded as dashboards. |
 | hostNetwork | bool | `false` | Run the controller on the host network |
 | image.flavour | string | `""` | The flavour of tag you want to use There are different image flavours available, like distroless and ubi. Please see GitHub release notes for image tags for these flavors. By default, the distroless image is used. |
 | image.pullPolicy | string | `"IfNotPresent"` |  |

deploy/charts/external-secrets/templates/grafana-dashboard.yaml

@@ -0,0 +1,16 @@
+{{- if .Values.grafanaDashboard.enabled }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "external-secrets.fullname" . }}-dashboard
+  namespace: {{ include "external-secrets.namespace" . }}
+  labels:
+    {{ .Values.grafanaDashboard.sidecarLabel }}: {{ .Values.grafanaDashboard.sidecarLabelValue | quote }}
+    {{- include "external-secrets.labels" . | nindent 4 }}
+  {{- with .Values.grafanaDashboard.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+data:
+  external-secrets.json: {{ .Files.Get "files/monitoring/grafana-dashboard.json" | toJson }}
+{{- end }}

deploy/charts/external-secrets/values.schema.json

@@ -356,6 +356,24 @@
             },
             "type": "object"
         },
+        "grafanaDashboard": {
+            "properties": {
+                "annotations": {
+                    "properties": {},
+                    "type": "object"
+                },
+                "enabled": {
+                    "type": "boolean"
+                },
+                "sidecarLabel": {
+                    "type": "string"
+                },
+                "sidecarLabelValue": {
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "hostNetwork": {
             "type": "boolean"
         },

deploy/charts/external-secrets/values.yaml

@@ -229,6 +229,21 @@ metrics:
     # -- Additional service annotations
     annotations: {}
 
+grafanaDashboard:
+  # -- If true creates a Grafana dashboard.
+  enabled: false
+
+  # -- Label that ConfigMaps should have to be loaded as dashboards.
+  sidecarLabel: "grafana_dashboard"
+
+  # -- Label value that ConfigMaps should have to be loaded as dashboards.
+  sidecarLabelValue: "1"
+
+  # -- Annotations that ConfigMaps can have to get configured in Grafana,
+  # See: sidecar.dashboards.folderAnnotation for specifying the dashboard folder.
+  # https://github.com/grafana/helm-charts/tree/main/charts/grafana
+  annotations: {}
+
 nodeSelector: {}
 
 tolerations: []