doc(README): add important deployment note

This commit is contained in:
Markus Pesch 2024-11-25 17:49:56 +01:00
parent 93a878824d
commit 74ad76c164
Signed by: volker.raschek
GPG Key ID: 852BCC170D81A982

View File

@ -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. 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 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 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 ```bash
helm repo add prometheus-exporter https://charts.cryptic.systems/prometheus-exporter helm repo add prometheus-exporter https://charts.cryptic.systems/prometheus-exporter