mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-24 16:09:08 +00:00
e853c19868
* chore(deps): update helm chart common to v2.2.0 * Remove node taints * [CI] Remove taints * docs: update helm-docs * Update README.md * fix: bump non-common charts by patch * fix: update whoogle to new common version Co-authored-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: ᗪєνιη ᗷυнʟ <onedr0p@users.noreply.github.com> Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev> Co-authored-by: Devin Buhl <devin.kray@gmail.com>
127 lines
4.8 KiB
Markdown
127 lines
4.8 KiB
Markdown
# deconz
|
|
|
|
 
|
|
|
|
deCONZ is an easy to use control software, with which you can set up and control Zigbee networks of any size without further programming effort.
|
|
|
|
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/dresden-elektronik/deconz-rest-plugin>
|
|
* <https://github.com/marthoc/docker-deconz>
|
|
|
|
## Requirements
|
|
|
|
Kubernetes: `>=1.16.0-0`
|
|
|
|
## Dependencies
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://library-charts.k8s-at-home.com | common | 2.2.0 |
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
helm repo update
|
|
helm install deconz k8s-at-home/deconz
|
|
```
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `deconz`
|
|
|
|
```console
|
|
helm install deconz k8s-at-home/deconz
|
|
```
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall the `deconz` deployment
|
|
|
|
```console
|
|
helm uninstall deconz
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
```console
|
|
helm install deconz \
|
|
--set env.TZ="America/New York" \
|
|
k8s-at-home/deconz
|
|
```
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
|
|
```console
|
|
helm install deconz k8s-at-home/deconz -f values.yaml
|
|
```
|
|
|
|
## Custom configuration
|
|
|
|
N/A
|
|
|
|
## Values
|
|
|
|
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| env.DECONZ_VNC_MODE | int | `1` | |
|
|
| env.DECONZ_VNC_PORT | int | `5900` | |
|
|
| env.DECONZ_WEB_PORT | int | `80` | |
|
|
| env.DECONZ_WS_PORT | int | `443` | |
|
|
| env.TZ | string | `"UTC"` | |
|
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
|
| image.repository | string | `"marthoc/deconz"` | |
|
|
| image.tag | string | `"amd64-2.10.03"` | |
|
|
| ingress.enabled | bool | `false` | |
|
|
| persistence.config.enabled | bool | `false` | |
|
|
| persistence.config.mountPath | string | `"/root/.local/share/dresden-elektronik/deCONZ"` | |
|
|
| service.additionalPorts[0].name | string | `"websocket"` | |
|
|
| service.additionalPorts[0].port | int | `443` | |
|
|
| service.additionalPorts[1].name | string | `"vnc"` | |
|
|
| service.additionalPorts[1].port | int | `5900` | |
|
|
| service.port.port | int | `80` | |
|
|
| 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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
### [3.0.0]
|
|
|
|
#### Migration !breaking change!
|
|
|
|
This version migrates the chart to the common dependency. If you have used prior versions that had version labels
|
|
attached to the volume template of the `StatefulSet`, you will need to remove the `StatefulSet` manually prior to update
|
|
or the update will fail until it's removed.
|
|
|
|
If you used auto provisioning on the config volume, a new volume will be created upon update. It is recommended to **backup**
|
|
the prior configuration using Phoscon App (deCONZ frontend) and restore it on a fresh installation (default password on fresh installation: `delight`).
|
|
This will preserve all devices, settings and access tokens. The configuration can also be restored by copying files over from the old volume.
|
|
|
|
#### Changed
|
|
|
|
- Initial release using common chart
|
|
|
|
## Support
|
|
|
|
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
|
|
----------------------------------------------
|
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) |