master-group/charts
2
0
Fork 0
mirror of https://github.com/k8s-at-home/charts.git synced 2025-02-02 23:39:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

[influxdb-exporter] fix README (#1427)

Browse Source 
Signed-off-by: Francesco Astegiano <francesco.astegiano@gmail.com>
This commit is contained in:
Francesco Astegiano 2022-02-21 19:34:51 +01:00 committed by GitHub
parent eacbf95b91
commit 00ba361853
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
charts/stable/influxdb-exporter/Chart.yaml
View File

@ -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
description: Initial version
- kind: fixed
description: Add the description and custom configuration to the README.md

46
charts/stable/influxdb-exporter/README.md
View File

@ -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.tag | string | `"v0.8.1"` | image tag |
| metrics.enabled | bool | See values.yaml | Enable and configure prometheus-qbittorrent-exporter sidecar and Prometheus podMonitor. |
| metrics.serviceMonitor.interval | string | `"15s"` | |
| metrics.serviceMonitor.labels | object | `{}` | |
| metrics.serviceMonitor.scrapeTimeout | string | `"5s"` | |
| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | image repository |
| image.tag | string | `"1.0.0"` | image tag |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
| 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)

18
charts/stable/influxdb-exporter/README_CONFIG.md.gotmpl
View File

@ -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 -}}