From cca755d4af90aa2ffa5b245407c438959ebf8acc Mon Sep 17 00:00:00 2001 From: Lilly Sell Date: Wed, 3 Dec 2025 09:29:39 +0100 Subject: [PATCH] docs(monitoring.md): Correct references and wordings in monitoring documentation --- docs/monitoring.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/monitoring.md b/docs/monitoring.md index 922b4aa1..233d2a49 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -23,8 +23,7 @@ openDesk includes integration with Prometheus-based monitoring. Together with [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack), you can easily leverage the full potential of the open-source cloud-native observability stack. -Before enabling the following options, you need to install the respective custom resource definitions (CRDs) from the kube-prometheus-stack -repository or Prometheus operator. +Before enabling the following options, you need to install the respective custom resource definitions (CRDs) from the kube-prometheus-stack repository which should at least include the Prometheus Operator. # Defaults @@ -33,14 +32,16 @@ All configurable options and their defaults can be found in # Metrics -To deploy `podMonitor` and `serviceMonitor` custom resources, enable it by: +To deploy `podMonitor` and `serviceMonitor` custom resources, enable them by: ```yaml -prometheus: - serviceMonitors: - enabled: true - podMonitors: - enabled: true +monitoring: + prometheus: + serviceMonitors: + enabled: true + podMonitors: + enabled: true +``` ``` # Alerts @@ -51,19 +52,23 @@ Some of these are created by our partners while others are defined in [opendesk- All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.PrometheusRule) and can be enabled like this: ```yaml -prometheus: - prometheusRules: - enabled: true +monitoring: + prometheus: + prometheusRules: + enabled: true ``` # Dashboards for Grafana -To deploy optional Grafana dashboards with ConfigMaps, enable the functionality with: +If your Grafana instance is deployed via kube-prometheus-stack, or you have deployed the [Sidecar for datasources](https://github.com/grafana/helm-charts/blob/main/charts/grafana/README.md#sidecar-for-datasources), openDesk can make dashboards available via ConfigMap resources. + +Enable the functionality with the following snippet: ```yaml -grafana: - dashboards: - enabled: true +monitoring: + grafana: + dashboards: + enabled: true ``` Please find further details in the [related Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-dashboards).