[influxdb-exporter] fix README (#1427)

Signed-off-by: Francesco Astegiano <francesco.astegiano@gmail.com>

charts/stable/influxdb-exporter/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
 appVersion: 0.8.1
-description: influxdb-exporter helm package
+description: An exporter for metrics in the InfluxDB format, transforms them and exposes them for consumption by Prometheus.
 name: influxdb-exporter
-version: 1.0.0
+version: 1.0.1
 kubeVersion: ">=1.16.0-0"
 keywords:
   - influxdb-exporter
@@ -19,5 +19,5 @@ dependencies:
     version: 4.3.0
 annotations:
   artifacthub.io/changes: |
-    - kind: added
+    - kind: fixed
-      description: Initial version
+      description: Add the description and custom configuration to the README.md

charts/stable/influxdb-exporter/README.md

@@ -1,14 +1,14 @@
-# influxdb-exporter
+# ${CHARTNAME}
 
-![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 0.8.1](https://img.shields.io/badge/AppVersion-0.8.1-informational?style=flat-square)
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
 
-influxdb-exporter helm package
+${CHARTNAME} helm package
 
 **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
 
 ## Source Code
 
-* <https://github.com/prometheus/influxdb_exporter>
+* <https://github.com/${CHARTNAME}/${CHARTNAME}-docker>
 
 ## Requirements
 
@@ -18,30 +18,30 @@ Kubernetes: `>=1.16.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| https://library-charts.k8s-at-home.com | common | 4.3.0 |
+| https://library-charts.k8s-at-home.com | common | 4.0.0 |
 
 ## TL;DR
 
 ```console
 helm repo add k8s-at-home https://k8s-at-home.com/charts/
 helm repo update
-helm install influxdb-exporter k8s-at-home/influxdb-exporter
+helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
 ```
 
 ## Installing the Chart
 
-To install the chart with the release name `influxdb-exporter`
+To install the chart with the release name `${CHARTNAME}`
 
 ```console
-helm install influxdb-exporter k8s-at-home/influxdb-exporter
+helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
 ```
 
 ## Uninstalling the Chart
 
-To uninstall the `influxdb-exporter` deployment
+To uninstall the `${CHARTNAME}` deployment
 
 ```console
-helm uninstall influxdb-exporter
+helm uninstall ${CHARTNAME}
 ```
 
 The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
@@ -54,15 +54,15 @@ Other values may be used from the [values.yaml](https://github.com/k8s-at-home/l
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
 
 ```console
-helm install influxdb-exporter \
+helm install ${CHARTNAME} \
   --set env.TZ="America/New York" \
-    k8s-at-home/influxdb-exporter
+    k8s-at-home/${CHARTNAME}
 ```
 
 Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
 
 ```console
-helm install influxdb-exporter k8s-at-home/influxdb-exporter -f values.yaml
+helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -f values.yaml
 ```
 
 ## Custom configuration
@@ -75,15 +75,13 @@ N/A
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| env | object | See below | environment variables. See more environment variables in the [influxdb-exporter documentation](https://influxdb-exporter.org/docs). |
+| env | object | See below | environment variables. See more environment variables in the [${CHARTNAME} documentation](https://${CHARTNAME}.org/docs). |
 | env.TZ | string | `"UTC"` | Set the container timezone |
 | image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
-| image.repository | string | `"prom/influxdb-exporter"` | image repository |
+| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | image repository |
-| image.tag | string | `"v0.8.1"` | image tag |
+| image.tag | string | `"1.0.0"` | image tag |
-| metrics.enabled | bool | See values.yaml | Enable and configure prometheus-qbittorrent-exporter sidecar and Prometheus podMonitor. |
+| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
-| metrics.serviceMonitor.interval | string | `"15s"` |  |
+| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
-| metrics.serviceMonitor.labels | object | `{}` |  |
-| metrics.serviceMonitor.scrapeTimeout | string | `"5s"` |  |
 | service | object | See values.yaml | Configures service settings for the chart. |
 
 ## Changelog
@@ -92,7 +90,7 @@ N/A
 
 #### Added
 
-* Initial version
+- Initial version
 
 #### Changed
 
@@ -102,10 +100,6 @@ N/A
 
 N/A
 
-### Older versions
-
-A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/influxdb-exporter?modal=changelog)
-
 ## Support
 
 - See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
@@ -114,4 +108,4 @@ A historical overview of changes can be found on [ArtifactHUB](https://artifacth
 - Join our [Discord](https://discord.gg/sTMX7Vh) community
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

charts/stable/influxdb-exporter/README_CONFIG.md.gotmpl

@@ -5,5 +5,21 @@
 {{- define "custom.custom.configuration" -}}
 {{ template "custom.custom.configuration.header" . }}
 
-N/A
+Override the default container `args:` with optons:
+
+    --web.listen-address=":9122"
+                          Address on which to expose metrics and web interface.
+    --web.telemetry-path="/metrics"
+                          Path under which to expose Prometheus metrics.
+    --web.exporter-telemetry-path="/metrics/exporter"
+                          Path under which to expose exporter metrics.
+    --influxdb.sample-expiry=5m
+                          How long a sample is valid for.
+    --udp.bind-address=":9122"
+                          Address on which to listen for udp packets.
+    --timestamps         Export timestamps of points.
+    --log.level=info     Only log messages with the given severity or above. One of: [debug, info, warn, error]
+    --log.format=logfmt  Output format of log messages. One of: [logfmt, json]
+
+(adapt service address/path/port accordingly)
 {{- end -}}