mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-23 23:49:12 +00:00
chore: Auto-update chart README [skip ci]
This commit is contained in:
parent
93b52f1910
commit
b68d5ca4e6
@ -4,13 +4,7 @@
|
|||||||
|
|
||||||
Simple and generic Prometheus exporter for MQTT. Tested with Mosquitto MQTT and Xiaomi sensors.
|
Simple and generic Prometheus exporter for MQTT. Tested with Mosquitto MQTT and Xiaomi sensors.
|
||||||
|
|
||||||
**Homepage:** <https://github.com/k8s-at-home/charts/tree/master/charts/stable/mqtt-exporter>
|
**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)**
|
||||||
|
|
||||||
## Maintainers
|
|
||||||
|
|
||||||
| Name | Email | Url |
|
|
||||||
| ---- | ------ | --- |
|
|
||||||
| philipp | phil@hellmi.de | |
|
|
||||||
|
|
||||||
## Source Code
|
## Source Code
|
||||||
|
|
||||||
@ -21,12 +15,65 @@ Simple and generic Prometheus exporter for MQTT. Tested with Mosquitto MQTT and
|
|||||||
|
|
||||||
Kubernetes: `>=1.16.0-0`
|
Kubernetes: `>=1.16.0-0`
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
| Repository | Name | Version |
|
| Repository | Name | Version |
|
||||||
|------------|------|---------|
|
|------------|------|---------|
|
||||||
| https://library-charts.k8s-at-home.com | common | 4.4.2 |
|
| https://library-charts.k8s-at-home.com | common | 4.4.2 |
|
||||||
|
|
||||||
|
## TL;DR
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
||||||
|
helm repo update
|
||||||
|
helm install mqtt-exporter k8s-at-home/mqtt-exporter
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing the Chart
|
||||||
|
|
||||||
|
To install the chart with the release name `mqtt-exporter`
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install mqtt-exporter k8s-at-home/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 env.TZ="America/New York" \
|
||||||
|
k8s-at-home/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 k8s-at-home/mqtt-exporter -f values.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
## Custom configuration
|
||||||
|
|
||||||
|
N/A
|
||||||
|
|
||||||
## Values
|
## 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 |
|
| Key | Type | Default | Description |
|
||||||
|-----|------|---------|-------------|
|
|-----|------|---------|-------------|
|
||||||
| env | object | See below | environment variables. See [image docs](https://developer.us-1.veritone.com/machinebox/overview) for more details. |
|
| env | object | See below | environment variables. See [image docs](https://developer.us-1.veritone.com/machinebox/overview) for more details. |
|
||||||
@ -58,5 +105,32 @@ Kubernetes: `>=1.16.0-0`
|
|||||||
| securityContext.runAsUser | int | `65534` | |
|
| securityContext.runAsUser | int | `65534` | |
|
||||||
| service | object | See values.yaml | Configures service settings for the chart. |
|
| service | object | See values.yaml | Configures service settings for the chart. |
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
### Version 1.0.0
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
* Initial version
|
||||||
|
|
||||||
|
#### Changed
|
||||||
|
|
||||||
|
N/A
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
N/A
|
||||||
|
|
||||||
|
### Older versions
|
||||||
|
|
||||||
|
A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/mqtt-exporter?modal=changelog)
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
||||||
|
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
||||||
|
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
||||||
|
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
||||||
|
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
|
||||||
|
Loading…
Reference in New Issue
Block a user