k8s-at-home/zigbee2mqtt

Chart version: 5.0.0
Api version: v2
App version: 1.17.0
Bridges events and allows you to control your Zigbee devices vi...
application
Chart Type
Active
Status
Unknown
License
2059
Downloads
https://k8s-at-home.com/charts
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install zigbee2mqtt center/k8s-at-home/zigbee2mqtt
Versions (0)

zigbee2mqtt

This is a helm chart for zigbee2mqtt.

This chart is not maintained by the upstream project and any issues with the chart should be raised here

TL;DR;

$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
$ helm install k8s-at-home/zigbee2mqtt

Installing the Chart

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

helm install --name my-release k8s-at-home/zigbee2mqtt

IMPORTANT NOTE: a zigbee controller device must be accessible on the node where this pod runs, in order for this chart to function properly.

First, you will need to mount your zigbee device into the pod, you can do so by adding the following to your values:

additionalVolumeMounts:
  - name: usb
    mountPath: /path/to/device

additionalVolumes:
  - name: usb
    hostPath:
      path: /path/to/device

Second you will need to set a nodeAffinity rule, for example:

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

… where a node with an attached zigbee controller USB device is labeled with app: zigbee-controller

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.

Read through the charts values.yaml file. It has several commented out suggested values. Additionally you can take a look at the common library values.yaml for more (advanced) configuration options.

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

helm install my-release \
  --set env.TZ="America/New_York" \
    k8s-at-home/zigbee2mqtt

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

helm install my-release k8s-at-home/zigbee2mqtt --values values.yaml 
image:
  tag: ...

NOTE

If you get

Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`

it may be because you uninstalled the chart with skipuninstall enabled, you need to manually delete the pvc or use existingClaim.


Upgrading an existing Release to a new major version

A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.

Upgrading from 2.x.x to 3.x.x

Note: It may be wise to back up your existing data incase something unexpected happens

As of 3.0.0 this chart was migrated to a centralized common library, some values in values.yaml have changed.

Examples:

  • service.port has been moved to service.port.port.
  • persistence.type has been moved to controllerType.

Refer to the common library for more configuration options.

Upgrading from 1.x.x to 2.x.x

Zigbee2MQTT has gained a native full-feature WebUI. Because of this, Zigbee2MQTTAssistant was dropped from the chart

You should delete the assistant config from your values.yaml. If you wish to use the new UI, make sure you have

frontend:
  port: 8080
experimental:
  new_api: true

in the config section, and enable the ingress in values.yaml. Because of the way this chart works, you’ll need to add this section to your configuration.yaml in zigbee2mqtt manually if you want to upgrade in-place