nikdoof/helm-charts
1
0
Fork 0
mirror of https://github.com/nikdoof/helm-charts.git synced 2025-12-11 12:42:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
helm-charts/charts/mqtt-exporter
History

README.md

mqtt-exporter

Version: 1.0.0 AppVersion: 1.0.0

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

Source Code

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository Name Version
https://library-charts.k8s-at-home.com common 4.2.0

TL;DR

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

helm install mqtt-exporter nikdoof-helm-charts/mqtt-exporter

Uninstalling the Chart

To uninstall the mqtt-exporter deployment

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 file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

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.

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

Key Type Default Description
env object See below environment variables. See more environment variables in the mqtt-exporter documentation.
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.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.0

Added

  • Initial version

Changed

  • N/A

Removed

  • N/A

Support

Autogenerated from chart metadata using helm-docs v1.5.0