fix(values): add parameter documentation

README.md

@@ -1,4 +1,4 @@
-# prometheus-fail2ban-charts
+# Prometheus Fail2Ban exporter
 
 [![Build Status](https://drone.cryptic.systems/api/badges/volker.raschek/prometheus-fail2ban-exporter-charts/status.svg)](https://drone.cryptic.systems/volker.raschek/prometheus-fail2ban-exporter-charts)
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/volker-raschek)](https://artifacthub.io/packages/search?repo=volker-raschek)
@@ -22,3 +22,59 @@ All [configuration
 options](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/blob/235d34114bdf6c99f8b8154240c007b2491248ea/cfg/cfg.go#L12)
 can be defined in the `values.yml` file below the `config` section. Alternatively can be the options passed via the
 `--set` flag of the `helm install` command.
+
+## Parameters
+
+### Affinity
+
+| Name       | Description                                    | Value |
+| ---------- | ---------------------------------------------- | ----- |
+| `affinity` | Affinity for the postgres-exporter deployment. | `{}`  |
+
+### Configuration
+
+
+### Image
+
+| Name               | Description                                              | Value                                                             |
+| ------------------ | -------------------------------------------------------- | ----------------------------------------------------------------- |
+| `image.repository` | Image repository, eg. `library/busybox`.                 | `git.cryptic.systems/volker.raschek/prometheus-fail2ban-exporter` |
+| `image.pullPolicy` | Image pull policy.                                       | `Always`                                                          |
+| `image.tag`        | Custom image tag, eg. `0.1.0`. Defaults to `appVersion`. | `""`                                                              |
+| `imagePullSecrets` | Secret to use for pulling the image.                     | `[]`                                                              |
+
+### Ingress
+
+
+### NodeSelector
+
+
+### PodAnnotations
+
+
+### PodPriorityClassName
+
+
+### PodSecurityContext
+
+
+### Resources
+
+
+### SecurityContext
+
+
+### Service
+
+
+### ServiceMonitor
+
+
+### Tolerations
+
+
+### VolumeMounts
+
+
+### Volume
+

values.yaml

@@ -2,11 +2,17 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
+## @param nameOverride Individual release name suffix.
+## @param fullnameOverride Override the complete release name logic.
 nameOverride: ""
 fullnameOverride: ""
 
+## @section Affinity
+## @param affinity Affinity for the postgres-exporter deployment.
 affinity: {}
 
+## @section Configuration
+## @skip config Skip individual postgres exporter configuration.
 config: {}
   # F2B_COLLECTOR_SOCKET
   # Path to the fail2ban socket inside the container filesystem.
@@ -32,14 +38,21 @@ config: {}
   # Alternative listen address instead of 0.0.0.0/0 and ::/0.
   # F2B_WEB_LISTEN_ADDRESS: ""
 
+## @section Image
+## @param image.repository Image repository, eg. `library/busybox`.
+## @param image.pullPolicy Image pull policy.
+## @param image.tag Custom image tag, eg. `0.1.0`. Defaults to `appVersion`.
 image:
   repository: git.cryptic.systems/volker.raschek/prometheus-fail2ban-exporter
   pullPolicy: Always
   # Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
+## @param imagePullSecrets Secret to use for pulling the image.
 imagePullSecrets: []
 
+## @section Ingress
+## @skip ingress Skip individual ingress configuration.
 ingress:
   enabled: false
   className: "nginx"
@@ -58,15 +71,25 @@ ingress:
     hosts:
     - "your-hostname"
 
+## @section NodeSelector
+## @skip nodeSelector Skip individual nodeSelector configuration.
 nodeSelector: {}
 
+## @section PodAnnotations
+## @skip podAnnotations Skip individual podAnnotations configuration.
 podAnnotations: {}
 
+## @section PodPriorityClassName
+## @skip podPriorityClassName Skip individual podPriorityClassName configuration.
 podPriorityClassName: ""
 
+## @section PodSecurityContext
+## @skip podSecurityContext Skip individual PodSecurityContext configuration.
 podSecurityContext: {}
   # fsGroup: 2000
 
+## @section Resources
+## @skip resources Skip individual resource configuration.
 resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little
@@ -79,6 +102,8 @@ resources: {}
   #   cpu: 100m
   #   memory: 128Mi
 
+## @section SecurityContext
+## @skip securityContext Skip individual securityContext configuration.
 securityContext: {}
   # capabilities:
   #   drop:
@@ -87,12 +112,14 @@ securityContext: {}
   # runAsNonRoot: true
   # runAsUser: 1000
 
+## @section Service
+## @skip service Skip individual service configuration.
 service:
   type: ClusterIP
   port: 9191
 
-# Deploy a serviceMonitor to scrape the metrics automatically via prometheus
+## @section ServiceMonitor
-# operator.
+## @skip serviceMonitor Skip individual serviceMonitor configuration.
 serviceMonitor:
   enabled: false
   annotations: {}
@@ -104,12 +131,18 @@ serviceMonitor:
   tlsConfig:
     insecureSkipVerify: false
 
+## @section Tolerations
+## @skip tolerations Skip individual tolerations configuration.
 tolerations: []
 
+## @section VolumeMounts
+## @skip volumeMounts Skip individual volumeMounts configuration.
 volumeMounts:
 - name: socket
   mountPath: /var/run/fail2ban/fail2ban.sock
 
+## @section Volume
+## @skip volumes Skip individual volume configuration.
 volumes:
 - name: socket
   hostPath: