charts/charts/stable/zwavejs2mqtt
renovate[bot] 2491875d71
chore(deps): update helm chart common to v2.3.1 (#802)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-04-19 10:57:28 +02:00
..
templates [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01:00
.helmignore [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01:00
Chart.yaml chore(deps): update helm chart common to v2.3.1 (#802) 2021-04-19 10:57:28 +02:00
README_CHANGELOG.md.gotmpl [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01:00
README_CONFIG.md.gotmpl [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01:00
README.md chore(deps): update helm chart common to v2.2.0 (#763) 2021-04-07 16:24:08 -04:00
README.md.gotmpl [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01:00
values.yaml [zwavejs2mqtt] Update image and add websocket port example (#749) 2021-04-01 14:17:51 -04:00

zwavejs2mqtt

Version: 3.3.0 AppVersion: 3.0.3

Fully configurable Zwave to MQTT Gateway and Control Panel

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 2.2.0

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install zwavejs2mqtt k8s-at-home/zwavejs2mqtt

Installing the Chart

To install the chart with the release name zwavejs2mqtt

helm install zwavejs2mqtt k8s-at-home/zwavejs2mqtt

Uninstalling the Chart

To uninstall the zwavejs2mqtt deployment

helm uninstall zwavejs2mqtt

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 zwavejs2mqtt \
  --set env.TZ="America/New York" \
    k8s-at-home/zwavejs2mqtt

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

helm install zwavejs2mqtt k8s-at-home/zwavejs2mqtt -f values.yaml

Custom configuration

IMPORTANT NOTE: a zwave 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 zwave 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:
          - zwave-controller

... where a node with an attached zwave controller USB device is labeled with app: zwave-controller

Values

Important: When deploying an application Helm chart you can add more values from our common library chart here

Key Type Default Description
additionalVolumeMounts list []
additionalVolumes list []
env object {}
image.pullPolicy string "IfNotPresent"
image.repository string "zwavejs/zwavejs2mqtt"
image.tag string "3.0.3"
ingress.enabled bool false
persistence.config.emptyDir.enabled bool false
persistence.config.enabled bool false
persistence.config.mountPath string "/usr/src/app/store"
probes.liveness.enabled bool true
probes.readiness.enabled bool true
probes.startup.enabled bool false
service.port.port int 8091
strategy.type string "Recreate"

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

  • N/A

Changed

  • N/A

Removed

  • N/A

Support


Autogenerated from chart metadata using helm-docs v1.5.0