Merge pull request #14 from small-hack/add-dconz-as-subchart

convert `homeAssistant.configuration` type to in-line yaml, add initial deconz chart, clean up home assistant values.yaml, add pre-commit

Author: jessebot

.github/workflows/release.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Set up Helm
         uses: azure/[email protected]
         with:
-          version: v3.11.1
+          version: v3.14.3
 
       - name: Run chart-releaser
         uses: helm/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.13.1
+    hooks:
+      - id: helm-docs

README.md

@@ -1,10 +1,12 @@
-# home assistant helm chart
+# Home Assistant helm chart
 <a href="https://github.com/small-hack/home-assistant-chart/releases"><img src="https://img.shields.io/github/v/release/small-hack/home-assistant-chart?style=plastic&labelColor=blue&color=green&logo=GitHub&logoColor=white"></a><br />
-Who doesn't need more home assistant helm charts?
+Who doesn't need more home assistant helm charts? This is a generic home assistant chart with basic features. It was written for use via [this Argo CD app](https://github.com/small-hack/argocd-apps/tree/main/home-assistant) which we deploy on metal with [`smol-k8s-lab`](https://github.com/small-hack/smol-k8s-lab).
 
 #### Features
 
-- Put a default configuration.yaml in place of your choosing.
+- Put a default configuration.yaml in place of your choosing with either:
+  - your own ConfigMap
+  - specifying an in-line yaml string for us to render as a ConfigMap for you
 - Kept up to date by RenovateBot
 
 ## TLDR
@@ -20,17 +22,49 @@ helm show values home-assistant/home-assistant > values.yaml
 helm install --namespace home-assistant --create-namespace home-assistant/home-assistant --values values.yaml
 ```
 
-## tips
+## Tips
 
-### Using your own configuration.yaml
 
-make sure your ConfigMap has a key called `configuration.yaml` with in-line yaml data like this:
+### Unit system, Temp Unit, and Time Zone
+
+```yaml
+homeAssistant:
+  configuration: |
+    homeassistant:
+      time_zone: Europe/Amsterdam
+      temperature_unit: C
+      unit_system: metric
+```
+
+### Making Ingress Nginx work for public domains
+
+I had to add the IP range of the k8s cluster to my trusted proxies in my home assistant `configuration.yaml` (also since this was public, I needed to declare an `external_url`).
+This is what I added to my `values.yaml` to do that through this chart:
+
+```yaml
+homeAssistant:
+  configuration: |
+    # this sets your extenral url
+    homeassistant:
+      external_url: 'https://iot.examplesforgooddogs.com'
+
+    # this enables proxies such as the ingress nginx controller
+    http:
+      use_x_forwarded_for: true
+      trusted_proxies:
+        - 10.0.0.0/8
+```
+
+
+### Using an existing ConfigMap for configuration.yaml
+
+For the ConfigMap, make sure your ConfigMap has a key called `configuration.yaml` with in-line yaml data like this:
 
 ```yaml
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: home-assistant
+  name: my-home-assistant-configmap
   namespace: home-assistant
 data:
   configuration.yaml: |
@@ -40,10 +74,25 @@ data:
       use_x_forwarded_for: true
 ```
 
+Then, you'd specify the name of your ConfigMap in your `values.yaml` like this:
 
-### External Devices
+```yaml
+homeAssistant:
+  existingConfigMap: "my-home-assistant-configmap"
+```
+
+
+### USB Devices
+
+If you're on metal, make sure your device is accessible, which in the case of a USB device e.g. conbee II, will require you to install the [generic device plugin](https://github.com/squat/generic-device-plugin):
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/squat/generic-device-plugin/main/manifests/generic-device-plugin.yaml
+```
+
+#### Values.yaml
 
-tip from pajikos/home-assistant for passing in usb devices via values.yaml:
+Tip from [pajikos/home-assistant](https://github.com/pajikos/home-assistant) for passing in USB devices via `values.yaml`:
 
 ```yaml
 volumes:
@@ -58,5 +107,16 @@ volumeMounts:
     name: usb
 ```
 
-## status
-demo and toy. feel free to submit PRs and Issues
+### Mobile config
+
+If you're new to home assistant, you may be wondering how you connect to the companion app on your phone. This requires you to put a key with no value called `mobile:` in the `configuration.yaml`. This would break your values.yaml depending on the gitops solution you're using, so we take the configuration as an in-line yaml block string instead like this:
+
+```yaml
+homeAssistant:
+  configuration: |
+    # this has no value
+    mobile:
+```
+
+## Status
+Seemingly stable. Feel free to submit PRs and Issues though :)

charts/deconz/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/deconz/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: deconz
+description: A Helm chart for deconz on Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "2.26.1"

charts/deconz/README.md

@@ -0,0 +1,59 @@
+# deconz
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.26.1](https://img.shields.io/badge/AppVersion-2.26.1-informational?style=flat-square)
+
+A Helm chart for deconz on Kubernetes
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | affinity for the pod e.g. to attract it to a specific node in the cluster nodeAffinity:   requiredDuringSchedulingIgnoredDuringExecution:     nodeSelectorTerms:       - matchExpressions:         - key: 'usb'           operator: In           values:             - 'true' |
+| autoscaling.enabled | bool | `false` |  |
+| autoscaling.maxReplicas | int | `100` |  |
+| autoscaling.minReplicas | int | `1` |  |
+| autoscaling.targetCPUUtilizationPercentage | int | `80` |  |
+| deconz.devicePath | string | `"/dev/ttyACM0"` | Override the location where deCONZ looks for the RaspBee/Conbee device. Becomes DECONZ_DEVICE: "" Examples: /dev/ttyUSB0 (conbee1), /dev/ttyACM0 (conbee2) |
+| deconz.gid | string | `"0"` | GID for the container user, becomes DECONZ_GID in the env vars |
+| deconz.startVerbose | int | `1` | becomes DECONZ_START_VERBOSE. set to 0 to turn off extra logging |
+| deconz.timeZone | string | `"Europe/Amsterdam"` | becomes TZ env var. this is the timezone |
+| deconz.uid | string | `"0"` | UID for the container user, becomes DECONZ_UID in the env vars |
+| deconz.webPort | string | `"8080"` | becomes DECONZ_WEB_PORT in env vars. |
+| deconz.wsPort | string | `"8443"` | becomes DECONZ_WS_PORT. may be useful to set to: "10001" |
+| extraEnv | object | `{}` | extra environment variables you want to pass to the deconz pod |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"deconzcommunity/deconz"` |  |
+| image.tag | string | `""` |  |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `"nginx"` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"chart-example.local"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| livenessProbe.httpGet.path | string | `"/"` |  |
+| livenessProbe.httpGet.port | string | `"http"` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| podAnnotations | object | `{}` |  |
+| podLabels | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| readinessProbe.httpGet.path | string | `"/"` |  |
+| readinessProbe.httpGet.port | string | `"http"` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext.capabilities.add[0] | string | `"NET_BIND_SERVICE"` |  |
+| service.port | int | `80` |  |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` |  |
+| serviceAccount.automount | bool | `true` |  |
+| serviceAccount.create | bool | `true` |  |
+| serviceAccount.name | string | `""` |  |
+| tolerations | list | `[]` | tolerations for tainted nodes, example:  - key: usb    operator: Equal    value: true    effect: NoSchedule |
+| volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. exmaple:   - mountPath: /dev/ttyACM0    name: usb |
+| volumes | list | `[]` | Additional volumes on the output Deployment definition. example:   - hostPath:       path: >-         /dev/serial/...       type: CharDevice     name: usb |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)

charts/deconz/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "dconz.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 --namespace {{ .Release.Namespace }} svc -w {{ include "dconz.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "dconz.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  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 "dconz.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

charts/deconz/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "dconz.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 "dconz.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 "dconz.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "dconz.labels" -}}
+helm.sh/chart: {{ include "dconz.chart" . }}
+{{ include "dconz.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "dconz.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "dconz.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "dconz.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "dconz.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}