You've already forked prometheus-fail2ban-exporter-charts
chore: update repository structure
Some checks failed
Helm / helm-lint (push) Successful in 6s
Helm / helm-unittest (push) Successful in 14s
Generate README / generate-parameters (push) Successful in 33s
Markdown linter / markdown-link-checker (push) Successful in 18s
Release / publish-chart (push) Failing after 5s
Markdown linter / markdown-lint (push) Successful in 32s
Some checks failed
Helm / helm-lint (push) Successful in 6s
Helm / helm-unittest (push) Successful in 14s
Generate README / generate-parameters (push) Successful in 33s
Markdown linter / markdown-link-checker (push) Successful in 18s
Release / publish-chart (push) Failing after 5s
Markdown linter / markdown-lint (push) Successful in 32s
This commit is contained in:
64
README.md
64
README.md
@@ -21,7 +21,8 @@ separate [chapter](#argocd).
|
||||
|
||||
## Helm: configuration and installation
|
||||
|
||||
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. The helm charts can either be pulled from
|
||||
the classic helm chart repository or OCI registry.
|
||||
2. All available [parameters](#parameters) are documented in detail below. 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.
|
||||
@@ -32,7 +33,7 @@ separate [chapter](#argocd).
|
||||
> time is not possible.
|
||||
|
||||
```bash
|
||||
helm repo add prometheus-exporters https://charts.cryptic.systems/prometheus-exporters
|
||||
helm repo add prometheus-exporters https://git.cryptic.systems/api/packages/volker.raschek/helm
|
||||
helm repo update
|
||||
CHART_VERSION=0.4.21
|
||||
helm install --version "${CHART_VERSION}" prometheus-fail2ban-exporter prometheus-exporters/prometheus-fail2ban-exporter \
|
||||
@@ -40,6 +41,18 @@ helm install --version "${CHART_VERSION}" prometheus-fail2ban-exporter prometheu
|
||||
--set 'prometheus.metrics.serviceMonitor.enabled=true'
|
||||
```
|
||||
|
||||
Alternatively, the deployment of the helm charts can also be done via an OCI registry:
|
||||
|
||||
```bash
|
||||
CHART_VERSION=0.5.9
|
||||
helm install "oci://git.cryptic.systems/volker.raschek/prometheus-fail2ban-exporter:${CHART_VERSION}" \
|
||||
--set 'config.database.secret.databaseUsername=postgres' \
|
||||
--set 'config.database.secret.databasePassword=postgres' \
|
||||
--set 'config.database.secret.databaseConnectionUrl="postgres.example.local:5432/postgres?ssl=disable"' \
|
||||
--set 'prometheus.metrics.enabled=true' \
|
||||
--set 'prometheus.metrics.serviceMonitor.enabled=true'
|
||||
```
|
||||
|
||||
Instead of passing all parameters via the *set* flag, it is also possible to define them as part of the `values.yaml`.
|
||||
The following command downloads the `values.yaml` for a specific version of this chart. Please keep in mind, that the
|
||||
version of the chart must be in sync with the `values.yaml`. Newer *minor* versions can have new features. New *major*
|
||||
@@ -93,53 +106,6 @@ helm install --version "${CHART_VERSION}" prometheus-fail2ban-exporter prometheu
|
||||
--set 'daemonSet.fail2banExporter.resources.limits.cpu=1000m'
|
||||
```
|
||||
|
||||
<!--
|
||||
#### TLS authentication and encryption
|
||||
|
||||
The first example shows how to deploy the metric exporter with TLS encryption. The verification of the custom TLS
|
||||
certification will be skipped by Prometheus.
|
||||
|
||||
> [!WARNING]
|
||||
> The secret `Prometheus-fail2banql-exporter-http` containing the TLS certificate is already present. The keys `ca.crt`,
|
||||
> `TLS.key` and `TLS.crt` of the secret can be mounted into the container filesystem for TLS authentication / encryption.
|
||||
|
||||
```bash
|
||||
helm install Prometheus-fail2ban-exporter Prometheus-exporters/Prometheus-fail2ban-exporter \
|
||||
--set 'daemonSet.volumes[0].name=TLS' \
|
||||
--set 'daemonSet.volumes[0].secret.secretName=Prometheus-fail2banql-exporter-http' \
|
||||
--set 'daemonSet.fail2banExporter.volumeMounts[0].name=TLS' \
|
||||
--set 'daemonSet.fail2banExporter.volumeMounts[0].mountPath=/etc/Prometheus-fail2ban-exporter/TLS' \
|
||||
--set 'daemonSet.fail2banExporter.volumeMounts[0].readOnly=true' \
|
||||
--set 'Prometheus.metrics.enabled=true' \
|
||||
--set 'Prometheus.metrics.serviceMonitor.enabled=true' \
|
||||
--set 'Prometheus.metrics.serviceMonitor.scheme=https' \
|
||||
--set 'Prometheus.metrics.serviceMonitor.tlsConfig.insecureSkipVerify=true'
|
||||
```
|
||||
|
||||
If the Prometheus pod has a TLS certificate mounted and is also signed by the private key of the CA which issued the TLS
|
||||
certificate for the metrics exporter - TLS certificate verification can be enabled. The following flags must be
|
||||
replaced:
|
||||
|
||||
```diff
|
||||
helm install Prometheus-fail2ban-exporter Prometheus-exporters/Prometheus-fail2ban-exporter \
|
||||
--set 'config.webConfig.secret.webConfig.cert_file=/etc/Prometheus-fail2ban-exporter/TLS/TLS.crt' \
|
||||
--set 'config.webConfig.secret.webConfig.client_ca_file=/etc/Prometheus-fail2ban-exporter/TLS/ca.crt' \
|
||||
--set 'config.webConfig.secret.webConfig.key_file=/etc/Prometheus-fail2ban-exporter/TLS/TLS.key'
|
||||
--set 'daemonSet.volumes[0].name=TLS' \
|
||||
--set 'daemonSet.volumes[0].secret.secretName=Prometheus-fail2banql-exporter-http' \
|
||||
--set 'daemonSet.fail2banExporter.volumeMounts[0].name=TLS' \
|
||||
--set 'daemonSet.fail2banExporter.volumeMounts[0].mountPath=/etc/Prometheus-fail2ban-exporter/TLS' \
|
||||
--set 'daemonSet.fail2banExporter.volumeMounts[0].readOnly=true' \
|
||||
--set 'Prometheus.metrics.enabled=true' \
|
||||
--set 'Prometheus.metrics.serviceMonitor.enabled=true' \
|
||||
--set 'Prometheus.metrics.serviceMonitor.scheme=https' \
|
||||
- --set 'Prometheus.metrics.serviceMonitor.tlsConfig.insecureSkipVerify=true' \
|
||||
+ --set 'Prometheus.metrics.serviceMonitor.tlsConfig.caFile=/etc/Prometheus/TLS/ca.crt' \
|
||||
+ --set 'Prometheus.metrics.serviceMonitor.tlsConfig.certFile=/etc/Prometheus/TLS/TLS.crt' \
|
||||
+ --set 'Prometheus.metrics.serviceMonitor.tlsConfig.keyFile=/etc/Prometheus/TLS/TLS.key'
|
||||
```
|
||||
-->
|
||||
|
||||
#### Grafana dashboard
|
||||
|
||||
The helm chart includes Grafana dashboards. These can be deployed as a configMap by activating Grafana integration. It
|
||||
|
||||
Reference in New Issue
Block a user