From 7ce70de51cc5b1ad2eaea5e5287563e0ca65b176 Mon Sep 17 00:00:00 2001
From: Markus Pesch <markus.pesch@cryptic.systems>
Date: Mon, 2 Dec 2024 13:54:02 +0100
Subject: [PATCH] doc(README): deploy Grafana dashboard

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index c20a5ee..a7383c9 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,22 @@ replaced:
 +   --set 'prometheus.metrics.serviceMonitor.tlsConfig.keyFile=/etc/prometheus/tls/tls.key'
 ```
 
+### Grafana dashboard
+
+The helm chart includes Grafana dashboards. These can be deployed as a configMap by activating Grafana integration. It
+is assumed that the dashboard is consumed by Grafana or a sidecar container itself and that the dashboard is stored in
+the Grafana container file system so that it is subsequently available to the user. The
+[kube-prometheus-stack](https://artifacthub.io/packages/helm/prometheus-community/kube-prometheus-stack) deployment
+makes this possible.
+
+```bash
+helm install prometheus-postgres-exporter prometheus-exporters/prometheus-postgres-exporter \
+  --set 'config.database.secret.databaseUsername=postgres' \
+  --set 'config.database.secret.databasePassword=postgres' \
+  --set 'config.database.secret.databaseConnectionUrl="postgres.example.local:5432/postgres?ssl=disable"' \
+  --set 'grafana.enabled=true'
+```
+
 ## Parameters
 
 ### Global