feat: add modular, multi-region monitoring stack (#38)

Introduce Prometheus and Grafana operators for modular deployments across
multi-region playground clusters.  The new `monitoring/setup.sh` script
installs the monitoring stack either for all detected cnpg-playground clusters
(when invoked with no arguments) or only for explicitly provided region names.

Additionally, the CNPG demo now automatically creates PodMonitor resources for
PostgreSQL clusters when the corresponding CRD is present in the target Kind
cluster.

Signed-off-by: Daniel Chambre <smiyc@pm.me>
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>

Author: smiyc

.gitignore

@@ -30,5 +30,4 @@
 go.work
 
 # minio data directories
-minio-eu
-minio-us
+minio-*

README.md

@@ -155,6 +155,14 @@ You can also remove specific clusters by passing the region names as arguments.
 ./scripts/teardown.sh it
 ```
 
+## Monitoring with Prometheus and Grafana
+
+The [`monitoring`](./monitoring/) directory provides instructions and resources
+for setting up a monitoring environment based on Prometheus and Grafana.
+Although this component is optional, it is highly recommended—especially for
+demonstration and learning purposes—as it offers valuable insight into the
+system’s behavior and performance.
+
 ## Demonstration with CNPG Playground
 
 The **CNPG Playground** offers a great environment for exploring the

demo/README.md

@@ -20,7 +20,10 @@ secondary (Disaster Recovery) cluster through the
 To follow this demonstration, ensure the following are installed on your system:
 
 1. **CNPG Playground**: Refer to the [installation guide](../README.md) for
-  setup instructions.
+  setup instructions. If you intend to use Prometheus together with the Grafana
+  dashboards, make sure that you also deploy the [monitoring](../monitoring/)
+  environment.
+
 2. **`cmctl` (cert-manager CLI)**: Required for secure communication between
   the operator and the `barman-cloud` plugin, which is used for backup and
   recovery with MinIO object stores.

demo/setup.sh

@@ -29,6 +29,12 @@ git_repo_root=$(git rev-parse --show-toplevel)
 kube_config_path=${git_repo_root}/k8s/kube-config.yaml
 demo_yaml_path=${git_repo_root}/demo/yaml
 
+check_crd_existence() {
+    # Check if the CRD exists in the cluster
+    kubectl get crd "$1" &> /dev/null
+    return $?
+}
+
 legacy=
 if [ "${LEGACY:-}" = "true" ]; then
    legacy="-legacy"
@@ -103,6 +109,13 @@ for region in eu us; do
    kubectl apply --context kind-k8s-${region} -f \
      ${demo_yaml_path}/${region}/pg-${region}${legacy}.yaml
 
+   # Create the PodMonitor if Prometheus has been installed
+   if check_crd_existence podmonitors.monitoring.coreos.com
+   then
+     kubectl apply --context kind-k8s-${region} -f \
+       ${demo_yaml_path}/${region}/pg-${region}-podmonitor.yaml
+   fi
+
    # Wait for the cluster to be ready
    kubectl wait --context kind-k8s-${region} \
      --timeout 30m \

monitoring/README.md

@@ -0,0 +1,68 @@
+# Monitoring
+
+This directory enables monitoring of your CloudNativePG clusters using the official
+[CloudNativePG Grafana Dashboard](https://github.com/cloudnative-pg/grafana-dashboards).
+The included script installs both the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator)
+and the [Grafana Operator](https://github.com/grafana/grafana-operator),
+and deploys the dashboard on top of your existing playground environment.
+
+---
+
+## Setup
+
+To install monitoring components for the environment you previously created (by
+default consisting of two regions: `eu` and `us`), simply run:
+
+```bash
+./setup.sh
+```
+
+You may also specify one or more region names to match a customised setup:
+
+```bash
+# Monitoring setup for clusters named 'it' and 'de'
+./setup.sh it de
+
+# Monitoring setup for a single-region environment
+./setup.sh local
+```
+
+The script will automatically deploy Prometheus, Grafana, and the CloudNativePG dashboard in each region provided.
+
+---
+
+## Accessing the Dashboard
+
+Once installation completes, you can access Grafana via port forwarding.
+The `setup.sh` script prints the exact commands needed.
+For the default two-region environment, they look similar to:
+
+```bash
+kubectl port-forward service/grafana-service 3000:3000 -n grafana --context kind-k8s-eu
+kubectl port-forward service/grafana-service 3001:3000 -n grafana --context kind-k8s-us
+```
+
+After forwarding the port, open your browser at:
+
+```
+http://localhost:3000
+```
+
+Log in using:
+
+- **Username:** `admin`
+- **Password:** `admin`
+
+Grafana will prompt you to choose a new password at first login.
+
+
+You can find the dashboard under `Home > Dashboards > grafana > CloudNativePG`.
+
+![dashboard](image.png)
+
+## PodMonitor
+
+To enable Prometheus to scrape metrics from your PostgreSQL pods, you must
+create a `PodMonitor` resource as described in the
+[documentation](https://cloudnative-pg.io/documentation/current/monitoring/#creating-a-podmonitor).
+

monitoring/grafana/grafana_dashboard.yaml

@@ -0,0 +1,10 @@
+apiVersion: grafana.integreatly.org/v1beta1
+kind: GrafanaDashboard
+metadata:
+  name: cloudnativepg-dashboard
+  namespace: grafana
+spec:
+  instanceSelector:
+    matchLabels:
+      dashboards: "grafana"
+  url: "https://raw.githubusercontent.com/cloudnative-pg/grafana-dashboards/refs/heads/main/charts/cluster/grafana-dashboard.json"

monitoring/grafana/grafana_datasource.yaml

@@ -0,0 +1,19 @@
+apiVersion: grafana.integreatly.org/v1beta1
+kind: GrafanaDatasource
+metadata:
+  name: prometheus
+  namespace: grafana
+spec:
+  instanceSelector:
+    matchLabels:
+      dashboards: grafana
+  allowCrossNamespaceImport: true
+  datasource:
+    access: proxy
+    database: prometheus
+    jsonData:
+      timeInterval: 5s
+      tlsSkipVerify: true
+    name: DS_PROMETHEUS
+    type: prometheus
+    url: http://prometheus-operated.prometheus-operator.svc.cluster.local:9090

monitoring/grafana/grafana_instance.yaml

@@ -0,0 +1,19 @@
+apiVersion: grafana.integreatly.org/v1beta1
+kind: Grafana
+metadata:
+  name: grafana
+  labels:
+    dashboards: "grafana"
+spec:
+  config:
+    log:
+      mode: "console"
+    security:
+      admin_user: admin
+      admin_password: admin
+  deployment:
+    spec:
+      template:
+        spec:
+          nodeSelector:
+            node-role.kubernetes.io/infra: ""

monitoring/grafana/kustomization.yaml

@@ -0,0 +1,7 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+ - grafana_instance.yaml
+ - grafana_datasource.yaml
+ - grafana_dashboard.yaml
+namespace: grafana