diff --git a/charts/zwave2mqtt/Chart.yaml b/charts/zwave2mqtt/Chart.yaml index 7f0ec689..d779387f 100644 --- a/charts/zwave2mqtt/Chart.yaml +++ b/charts/zwave2mqtt/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v2 -appVersion: 4.0.3 +appVersion: 4.0.6 description: Fully configurable Zwave to MQTT gateway and Control Panel using NodeJS and Vue name: zwave2mqtt -version: 4.0.0 +version: 5.0.0 keywords: - zwave - mqtt @@ -14,3 +14,7 @@ sources: maintainers: - name: billimek email: jeff@billimek.com +dependencies: + - name: common + repository: https://k8s-at-home.com/charts/ + version: ^1.4.0 diff --git a/charts/zwave2mqtt/README.md b/charts/zwave2mqtt/README.md index 281bc911..cce759dd 100644 --- a/charts/zwave2mqtt/README.md +++ b/charts/zwave2mqtt/README.md @@ -1,6 +1,6 @@ -# zwave2mqtt: Fully configurable Zwave to MQTT Gateway and Control Panel +# zwave2mqtt -This is a helm chart for [zwave2mqtt](https://github.com/OpenZWave/Zwave2Mqtt) +This is a helm chart for [zwave2mqtt](https://zwave2mqtt.org/). ## TL;DR; @@ -19,7 +19,20 @@ helm install --name my-release k8s-at-home/zwave2mqtt **IMPORTANT NOTE:** a zwave controller device 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: +First, you will need to mount your zwave device into the pod, you can do so by adding the following to your values: + +```yaml +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: ```yaml affinity: @@ -45,31 +58,49 @@ 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](https://github.com/k8s-at-home/charts/blob/master/charts/zwave2mqtt/values.yaml) file. It has several commented out suggested values. +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/zwave2mqtt/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - ```console -helm install --name my-release \ - --set rtspPassword="nosecrets" \ +helm install my-release \ + --set env.TZ="America/New_York" \ k8s-at-home/zwave2mqtt ``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, ```console -helm install --name my-release -f values.yaml stable/zwave2mqtt +helm install my-release k8s-at-home/zwave2mqtt --values values.yaml ``` +```yaml +image: + tag: ... +``` + +--- +**NOTE** + +If you get +```console +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 2.2.2 -> 3.0.0) indicates that there is an -incompatible breaking change needing manual actions. +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 3.x.x to 4.x.x +### Upgrading from 4.x.x to 5.x.x -Upgrading to this release it is suggested to enable the flag in Settings > Zwave > Auto update database +As of 5.0.0 this chart was migrated to a centralized [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library, some values in `values.yaml` have changed. -In order to use an updated configuration for the devices, you have to send a refreshNodeInfo to that node +Examples: + +* `service.port` has been moved to `service.port.port`. +* `persistence.type` has been moved to `controllerType`. + +Refer to the [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library for more configuration options. diff --git a/charts/zwave2mqtt/ci/ct-values.yaml b/charts/zwave2mqtt/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/zwave2mqtt/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/zwave2mqtt/templates/NOTES.txt b/charts/zwave2mqtt/templates/NOTES.txt index 3ddd4247..90f7b653 100644 --- a/charts/zwave2mqtt/templates/NOTES.txt +++ b/charts/zwave2mqtt/templates/NOTES.txt @@ -1,19 +1 @@ -1. Get the application URL by running these commands: -{{- if .Values.ingress.enabled }} -{{- range .Values.ingress.hosts }} - http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }} -{{- end }} -{{- else if contains "NodePort" .Values.service.type }} - export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "zwave2mqtt.fullname" . }}) - export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") - echo http://$NODE_IP:$NODE_PORT -{{- else if contains "LoadBalancer" .Values.service.type }} - NOTE: It may take a few minutes for the LoadBalancer IP to be available. - You can watch the status of by running 'kubectl get svc -w {{ include "zwave2mqtt.fullname" . }}' - export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "zwave2mqtt.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') - echo http://$SERVICE_IP:{{ .Values.service.port }} -{{- else if contains "ClusterIP" .Values.service.type }} - export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "zwave2mqtt.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - echo "Visit http://127.0.0.1:5000 to use your application" - kubectl port-forward $POD_NAME 5000:5000 -{{- end }} +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/zwave2mqtt/templates/_helpers.tpl b/charts/zwave2mqtt/templates/_helpers.tpl deleted file mode 100644 index 35caaafb..00000000 --- a/charts/zwave2mqtt/templates/_helpers.tpl +++ /dev/null @@ -1,45 +0,0 @@ -{{/* vim: set filetype=mustache: */}} -{{/* -Expand the name of the chart. -*/}} -{{- define "zwave2mqtt.name" -}} -{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} -{{- end -}} - -{{/* -Create a default fully qualified app name. -We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). -If release name contains chart name it will be used as a full name. -*/}} -{{- define "zwave2mqtt.fullname" -}} -{{- if .Values.fullnameOverride -}} -{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} -{{- else -}} -{{- $name := default .Chart.Name .Values.nameOverride -}} -{{- if contains $name .Release.Name -}} -{{- .Release.Name | trunc 63 | trimSuffix "-" -}} -{{- else -}} -{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} -{{- end -}} -{{- end -}} -{{- end -}} - -{{/* -Create chart name and version as used by the chart label. -*/}} -{{- define "zwave2mqtt.chart" -}} -{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} -{{- end -}} - -{{/* -Common labels -*/}} -{{- define "zwave2mqtt.labels" -}} -app.kubernetes.io/name: {{ include "zwave2mqtt.name" . }} -helm.sh/chart: {{ include "zwave2mqtt.chart" . }} -app.kubernetes.io/instance: {{ .Release.Name }} -{{- if .Chart.AppVersion }} -app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} -{{- end }} -app.kubernetes.io/managed-by: {{ .Release.Service }} -{{- end -}} diff --git a/charts/zwave2mqtt/templates/common.yaml b/charts/zwave2mqtt/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/zwave2mqtt/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/zwave2mqtt/templates/deployment.yaml b/charts/zwave2mqtt/templates/deployment.yaml deleted file mode 100644 index 0da042e3..00000000 --- a/charts/zwave2mqtt/templates/deployment.yaml +++ /dev/null @@ -1,92 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: {{ include "zwave2mqtt.fullname" . }} - labels: -{{ include "zwave2mqtt.labels" . | indent 4 }} -spec: - replicas: 1 - revisionHistoryLimit: 3 - strategy: - type: {{ .Values.strategyType }} - selector: - matchLabels: - app.kubernetes.io/name: {{ include "zwave2mqtt.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - template: - metadata: - labels: - app.kubernetes.io/name: {{ include "zwave2mqtt.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - {{- if .Values.podAnnotations }} - annotations: - {{- range $key, $value := .Values.podAnnotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} - spec: - {{- with .Values.imagePullSecrets }} - imagePullSecrets: - {{- toYaml . | nindent 8 }} - {{- end }} - containers: - - name: {{ .Chart.Name }} - image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" - imagePullPolicy: {{ .Values.image.pullPolicy }} - securityContext: - privileged: true - ports: - - name: http - containerPort: 8091 - protocol: TCP - livenessProbe: - httpGet: - path: / - port: http - scheme: HTTP - initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }} - failureThreshold: {{ .Values.probes.liveness.failureThreshold }} - timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }} - readinessProbe: - httpGet: - path: / - port: http - scheme: HTTP - initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }} - failureThreshold: {{ .Values.probes.readiness.failureThreshold }} - timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }} - env: - {{- if .Values.timezone }} - - name: TZ - value: "{{ .Values.timezone }}" - {{- end }} - volumeMounts: - - mountPath: {{ .Values.device }} - name: usb - - mountPath: /usr/src/app/store - name: config - resources: - {{- toYaml .Values.resources | nindent 12 }} - volumes: - - name: config - {{- if .Values.persistence.enabled }} - persistentVolumeClaim: - claimName: {{ if .Values.persistence.existingClaim }}{{ .Values.persistence.existingClaim }}{{- else }}{{ template "zwave2mqtt.fullname" . }}{{- end }} - {{- else }} - emptyDir: {} - {{- end }} - - name: usb - hostPath: - path: {{ .Values.device }} - {{- with .Values.nodeSelector }} - nodeSelector: - {{- toYaml . | nindent 8 }} - {{- end }} - {{- with .Values.affinity }} - affinity: - {{- toYaml . | nindent 8 }} - {{- end }} - {{- with .Values.tolerations }} - tolerations: - {{- toYaml . | nindent 8 }} - {{- end }} diff --git a/charts/zwave2mqtt/templates/ingress.yaml b/charts/zwave2mqtt/templates/ingress.yaml deleted file mode 100644 index 883c3d38..00000000 --- a/charts/zwave2mqtt/templates/ingress.yaml +++ /dev/null @@ -1,35 +0,0 @@ -{{- if .Values.ingress.enabled -}} -{{- $fullName := include "zwave2mqtt.fullname" . -}} -{{- $ingressPath := .Values.ingress.path -}} -apiVersion: extensions/v1beta1 -kind: Ingress -metadata: - name: {{ $fullName }} - labels: -{{ include "zwave2mqtt.labels" . | indent 4 }} - {{- with .Values.ingress.annotations }} - annotations: - {{- toYaml . | nindent 4 }} - {{- end }} -spec: -{{- if .Values.ingress.tls }} - tls: - {{- range .Values.ingress.tls }} - - hosts: - {{- range .hosts }} - - {{ . | quote }} - {{- end }} - secretName: {{ .secretName }} - {{- end }} -{{- end }} - rules: - {{- range .Values.ingress.hosts }} - - host: {{ . | quote }} - http: - paths: - - path: {{ $ingressPath }} - backend: - serviceName: {{ $fullName }} - servicePort: http - {{- end }} -{{- end }} \ No newline at end of file diff --git a/charts/zwave2mqtt/templates/pvc.yaml b/charts/zwave2mqtt/templates/pvc.yaml deleted file mode 100644 index 5af59c05..00000000 --- a/charts/zwave2mqtt/templates/pvc.yaml +++ /dev/null @@ -1,29 +0,0 @@ - -{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }} -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: {{ template "zwave2mqtt.fullname" . }} - {{- if .Values.persistence.skipuninstall }} - annotations: - "helm.sh/resource-policy": keep - {{- end }} - labels: - app.kubernetes.io/name: {{ include "zwave2mqtt.name" . }} - helm.sh/chart: {{ include "zwave2mqtt.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -spec: - accessModes: - - {{ .Values.persistence.accessMode | quote }} - resources: - requests: - storage: {{ .Values.persistence.size | quote }} -{{- if .Values.persistence.storageClass }} -{{- if (eq "-" .Values.persistence.storageClass) }} - storageClassName: "" -{{- else }} - storageClassName: "{{ .Values.persistence.storageClass }}" -{{- end }} -{{- end }} -{{- end -}} \ No newline at end of file diff --git a/charts/zwave2mqtt/templates/service.yaml b/charts/zwave2mqtt/templates/service.yaml deleted file mode 100644 index 3e63a222..00000000 --- a/charts/zwave2mqtt/templates/service.yaml +++ /dev/null @@ -1,49 +0,0 @@ -apiVersion: v1 -kind: Service -metadata: - name: {{ template "zwave2mqtt.fullname" . }} - labels: -{{ include "zwave2mqtt.labels" . | indent 4 }} -{{- if .Values.service.labels }} -{{ toYaml .Values.service.labels | indent 4 }} -{{- end }} -{{- with .Values.service.annotations }} - annotations: -{{ toYaml . | indent 4 }} -{{- end }} -spec: -{{- if (or (eq .Values.service.type "ClusterIP") (empty .Values.service.type)) }} - type: ClusterIP - {{- if .Values.service.clusterIP }} - clusterIP: {{ .Values.service.clusterIP }} - {{end}} -{{- else if eq .Values.service.type "LoadBalancer" }} - type: {{ .Values.service.type }} - {{- if .Values.service.loadBalancerIP }} - loadBalancerIP: {{ .Values.service.loadBalancerIP }} - {{- end }} - {{- if .Values.service.loadBalancerSourceRanges }} - loadBalancerSourceRanges: -{{ toYaml .Values.service.loadBalancerSourceRanges | indent 4 }} - {{- end -}} -{{- else }} - type: {{ .Values.service.type }} -{{- end }} -{{- if .Values.service.externalIPs }} - externalIPs: -{{ toYaml .Values.service.externalIPs | indent 4 }} -{{- end }} - {{- if .Values.service.externalTrafficPolicy }} - externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }} - {{- end }} - ports: - - name: http - port: {{ .Values.service.port }} - protocol: TCP - targetPort: http -{{ if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }} - nodePort: {{.Values.service.nodePort}} -{{ end }} - selector: - app.kubernetes.io/name: {{ include "zwave2mqtt.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} \ No newline at end of file diff --git a/charts/zwave2mqtt/values.yaml b/charts/zwave2mqtt/values.yaml index 7e60fe48..8a16bf87 100644 --- a/charts/zwave2mqtt/values.yaml +++ b/charts/zwave2mqtt/values.yaml @@ -1,105 +1,58 @@ # Default values for zwave2mqtt. -# This is a YAML-formatted file. -# Declare variables to be passed into your templates. - -# upgrade strategy type (e.g. Recreate or RollingUpdate) -strategyType: Recreate image: repository: robertslando/zwave2mqtt - tag: 4.0.3 pullPolicy: IfNotPresent + tag: 4.0.6 -# timezone to run the service as -# timezone: "America/New York" +strategy: + type: Recreate -# device where the zwave device can be accessed -device: "/dev/ttyASM0" - -imagePullSecrets: [] -nameOverride: "" -fullnameOverride: "" - -# Probes configuration -probes: - liveness: - initialDelaySeconds: 30 - failureThreshold: 5 - timeoutSeconds: 10 - readiness: - initialDelaySeconds: 30 - failureThreshold: 5 - timeoutSeconds: 10 - -persistence: - enabled: false - ## zwave2mqtt configuration data Persistent Volume Storage Class - ## If defined, storageClassName: - ## If set to "-", storageClassName: "", which disables dynamic provisioning - ## If undefined (the default) or set to null, no storageClassName spec is - ## set, choosing the default provisioner. (gp2 on AWS, standard on - ## GKE, AWS & OpenStack) - ## - # storageClass: "-" - ## - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable - # existingClaim: your-claim - accessMode: ReadWriteOnce - size: 1Gi - ## Do not delete the pvc upon helm uninstall - skipuninstall: false +env: + OZW_AUTO_UPDATE_CONFIG: true service: - type: ClusterIP - port: 8091 - ## Specify the nodePort value for the LoadBalancer and NodePort service types. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport - ## - # nodePort: - ## Provide any additional annotations which may be required. This can be used to - ## set the LoadBalancer service type to internal only. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer - ## - annotations: {} - labels: {} - ## Use loadBalancerIP to request a specific static IP, - ## otherwise leave blank - ## - loadBalancerIP: - # loadBalancerSourceRanges: [] - ## Set the externalTrafficPolicy in the Service to either Cluster or Local - # externalTrafficPolicy: Cluster + port: + port: 8091 -ingress: - enabled: false - annotations: {} - # kubernetes.io/ingress.class: nginx - # kubernetes.io/tls-acme: "true" - path: / - hosts: - - chart-example.local - tls: [] - # - secretName: chart-example-tls - # hosts: - # - chart-example.local +securityContext: + privileged: true -resources: {} - # We usually recommend not to specify default resources and to leave this as a conscious - # choice for the user. This also increases chances charts run on environments with little - # resources, such as Minikube. If you do want to specify resources, uncomment the following - # lines, adjust them as necessary, and remove the curly braces after 'resources:'. - # limits: - # cpu: 100m - # memory: 128Mi - # requests: - # cpu: 100m - # memory: 128Mi +persistence: + config: + enabled: false + emptyDir: false + mountPath: /usr/src/app/store + ## Persistent Volume Storage Class + ## If defined, storageClassName: + ## If set to "-", storageClassName: "", which disables dynamic provisioning + ## If undefined (the default) or set to null, no storageClassName spec is + ## set, choosing the default provisioner. (gp2 on AWS, standard on + ## GKE, AWS & OpenStack) + # storageClass: "-" + # accessMode: ReadWriteOnce + # size: 1Gi + ## Do not delete the pvc upon helm uninstall + # skipuninstall: false + # existingClaim: "" -nodeSelector: {} +# Path to your zwave device in the container +additionalVolumeMounts: + - name: usb + mountPath: /dev/serial/by-id/usb-0658_0200-if00 -tolerations: [] +# Path to your zwave device on the host +additionalVolumes: + - name: usb + hostPath: + path: /dev/serial/by-id/usb-0658_0200-if00 -affinity: {} - -podAnnotations: {} +# affinity: +# nodeAffinity: +# requiredDuringSchedulingIgnoredDuringExecution: +# nodeSelectorTerms: +# - matchExpressions: +# - key: app +# operator: In +# values: +# - zwave-controller