charts/charts/zigbee2mqtt/README.md
Piotr Maksymiuk c0da502c9e
[zigbee2mqtt] Add chart (#283)
* [zigbee2mqtt] Add chart

* remove remnants of zwave from chart

* fix lint

* one more zwave in zigbee

* set default timezone to UTC
2020-07-17 09:31:15 -04:00

2.1 KiB

zigbee2mqtt: Fully configurable Zigbee to MQTT Gateway

This is a helm chart for zigbee2mqtt

TL;DR;

$ helm repo add billimek https://billimek.com/billimek-charts/
$ helm install billimek/zigbee2mqtt

Installing the Chart

To install the chart with the release name my-release:

helm install --name my-release billimek/zigbee2mqtt

IMPORTANT NOTE: a supported Zigbee sniffer must be accessible on the node where this pod runs, in order for this chart to function properly.

A way to achieve this can be with nodeAffinity rules, for example:

affinity:
  nodeAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
      nodeSelectorTerms:
      - matchExpressions:
        - key: app
          operator: In
          values:
          - zigbee-controller

... where a node with an attached zigbee sniffer is labeled with app: zigbee-controller

Because zigbee2mqtt writes to the config file, it is impossible to manage it through this chart. The configuration options will be set as defaults on first run, and then copied to a writeable directory. It can be found in /data/configuration.yaml afterwards.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release --purge

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

Read through the values.yaml file. It has several commented out suggested values.

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

helm install --name my-release \
  --set config.mqtt.server="mqtt://mymqttbroker" \
    billimek/zigbee2mqtt

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install --name my-release -f values.yaml billimek/zigbee2mqtt