mirror of
https://github.com/nikdoof/helm-charts.git
synced 2025-12-22 14:19:27 +00:00
Andrew Williams
e6f88c5ddd
* [mqtt-exporter] New chart * Don't enable Metrics for testing * Fix linting issues
122 lines
4.4 KiB
Markdown
122 lines
4.4 KiB
Markdown
# mqtt-exporter
|
|
|
|
 
|
|
|
|
A prometheus exporter for generic MQTT metrics
|
|
|
|
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/nikdoof/helm-charts/issues/new/choose)**
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/kpetremann/mqtt-exporter>
|
|
|
|
## Requirements
|
|
|
|
Kubernetes: `>=1.16.0-0`
|
|
|
|
## Dependencies
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://library-charts.k8s-at-home.com | common | 4.2.0 |
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
helm repo add nikdoof-helm-charts https://nikdoof.github.io/helm-charts/
|
|
helm repo update
|
|
helm install mqtt-exporter nikdoof-helm-charts/mqtt-exporter
|
|
```
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `mqtt-exporter`
|
|
|
|
```console
|
|
helm install mqtt-exporter nikdoof-helm-charts/mqtt-exporter
|
|
```
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall the `mqtt-exporter` deployment
|
|
|
|
```console
|
|
helm uninstall mqtt-exporter
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
```console
|
|
helm install mqtt-exporter \
|
|
--set modem.host="192.168.1.1"\
|
|
nikdoof-helm-charts/mqtt-exporter
|
|
```
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
|
|
```console
|
|
helm install mqtt-exporter nikdoof-helm-charts/mqtt-exporter -f values.yaml
|
|
```
|
|
|
|
## Custom configuration
|
|
|
|
N/A
|
|
|
|
## Values
|
|
|
|
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| env | object | See below | environment variables. See more environment variables in the [mqtt-exporter documentation](https://mqtt-exporter.org/docs). |
|
|
| env.MQTT_ADDRESS | string | `nil` | IP or hostname of MQTT broker (default: 127.0.0.1) |
|
|
| env.MQTT_PORT | int | `1883` | TCP port of MQTT broker (default: 1883) |
|
|
| env.MQTT_TOPIC | string | `"#"` | Topic path to subscribe to (default: #) |
|
|
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
|
|
| image.repository | string | `"kpetrem/mqtt-exporter"` | image repository |
|
|
| image.tag | string | `"latest"` | image tag |
|
|
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
|
|
| metrics.enabled | bool | See values.yaml | Enable and configure a Prometheus serviceMonitor for the chart under this key. |
|
|
| metrics.prometheusRule | object | See values.yaml | Enable and configure Prometheus Rules for the chart under this key. |
|
|
| metrics.prometheusRule.rules | list | See prometheusrules.yaml | Configure additionial rules for the chart under this key. |
|
|
| metrics.serviceMonitor.interval | string | `"1m"` | |
|
|
| metrics.serviceMonitor.labels | object | `{}` | |
|
|
| metrics.serviceMonitor.scrapeTimeout | string | `"30s"` | |
|
|
| service | object | See values.yaml | Configures service settings for the chart. |
|
|
|
|
## Changelog
|
|
|
|
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
### [1.0.0]
|
|
|
|
#### Added
|
|
|
|
- Initial version
|
|
|
|
#### Changed
|
|
|
|
- N/A
|
|
|
|
#### Removed
|
|
|
|
- N/A
|
|
|
|
[1.0.0]: #100
|
|
|
|
## Support
|
|
|
|
- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose)
|
|
|
|
----------------------------------------------
|
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|