From 74ad76c16456726b58ee0936a80b03c386f80bac Mon Sep 17 00:00:00 2001 From: Markus Pesch Date: Mon, 25 Nov 2024 17:49:56 +0100 Subject: [PATCH] doc(README): add important deployment note --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f205120..956609c 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,12 @@ chart is tested for deployment scenarios with ArgoCD. 1. A helm chart repository must be configured, to pull the helm charts from. 2. All available parameters are [here](#parameters). The parameters can be defined via the helm `--set` flag or directly as part of a `values.yaml` file. The following example defines the `prometheus-exporter` repository and use the - `--set` flag for a basic deployment. By default is neither a serviceMonitor nor a podMonitor enabled. + `--set` flag for a basic deployment. + +> [!IMPORTANT] +> By default is neither a serviceMonitor nor a podMonitor enabled. Use `prometheus.metrics.serviceMonitor.enabled=true` +> or `prometheus.metrics.podMonitor.enabled=true` to enable one monitor deployment. Deploying both monitors at the same +> time is not possible. ```bash helm repo add prometheus-exporter https://charts.cryptic.systems/prometheus-exporter