Skip to content

Commit b2b59c3

Browse files
gbartolinigbartolini
authored
docs: move Grafana dashboard in the charts project (#3766)
The Grafana dashboard is now officially part of the Helm charts project. This patch updates the documentation to point to the official new resource. Closes #3765 Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
1 parent dde5dad commit b2b59c3

5 files changed

Lines changed: 13 additions & 12940 deletions

File tree

‎docs/src/monitoring.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -745,15 +745,12 @@ section for context:
745745
NOTE: this does not include inter-operation with notification services. Please refer
746746
to the [Prometheus documentation](https://prometheus.io/docs/alerting/latest/alertmanager/).
747747
- `podmonitor.yaml`: a `PodMonitor` for the CloudNativePG Operator deployment.
748-
- `grafana-configmap.yaml`: a ConfigMap containing the definition of the sample
749-
CloudNativePG Dashboard. Note the labels in the definition, which ensure that
750-
the Grafana deployment will find the ConfigMap.
751748

752-
In addition, we provide the "raw" sources for the Grafana dashboard and the
753-
Prometheus alert rules, for your reference:
749+
In addition, we provide the "raw" sources for the Prometheus alert rules in the
750+
`alerts.yaml` file.
754751

755-
- `alerts.yaml`: Prometheus rules with alerts
756-
- `grafana-dashboard.json`: the CloudNativePG dashboard as a native Grafana JSON.
752+
The [Grafana dashboard](https://github.com/cloudnative-pg/charts/blob/main/charts/cloudnative-pg/monitoring/grafana-dashboard.json)
753+
is now part of the official Helm Chart project.
757754

758755
Note that, for the configuration of `kube-prometheus-stack`, other fields and
759756
settings are available over what we provide in `kube-stack-config.yaml`.

‎docs/src/operator_capability_levels.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -563,6 +563,11 @@ or `Secret` objects using a syntax that's compatible with
563563
CloudNativePG provides a set of basic monitoring queries for
564564
PostgreSQL that can be integrated and adapted to your context.
565565

566+
### Grafana dashboard
567+
568+
CloudNativePG comes with a Grafana dashboard that you can use as a base to
569+
monitor all critical aspects of a PostgreSQL cluster, and customize.
570+
566571
### Standard output logging of PostgreSQL error messages in JSON format
567572

568573
Every log message is delivered to standard output in JSON format. The first level is the

‎docs/src/quickstart.md‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -302,15 +302,10 @@ kubectl port-forward svc/prometheus-community-grafana 3000:80
302302
And access Grafana locally at [`http://localhost:3000/`](http://localhost:3000/)
303303
providing the credentials `admin` as username, `prom-operator` as password (defined in `kube-stack-config.yaml`).
304304

305-
We can now install our sample Grafana dashboard:
306-
307-
``` sh
308-
kubectl apply -f \
309-
https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/docs/src/samples/monitoring/grafana-configmap.yaml
310-
```
311-
312-
Which will be picked up by the Grafana page in a few seconds. You should now
313-
see the `CloudNativePG` dashboard.
305+
CloudNativePG provides a default dashboard for Grafana as part of the official
306+
[Helm chart](https://github.com/cloudnative-pg/charts). You can download the
307+
[grafana-dashboard.json](https://github.com/cloudnative-pg/charts/blob/main/charts/cloudnative-pg/monitoring/grafana-dashboard.json)
308+
file and manually importing it via the GUI.
314309

315310
!!! Warning
316311
Some graphs in the previous dashboard make use of metrics that are in alpha stage by the time

0 commit comments

Comments
 (0)