diff --git a/charts/incubator/openhab/Chart.yaml b/charts/incubator/openhab/Chart.yaml new file mode 100644 index 00000000..21475320 --- /dev/null +++ b/charts/incubator/openhab/Chart.yaml @@ -0,0 +1,19 @@ +apiVersion: v2 +appVersion: 3.1.0 +description: openhab helm package +name: openhab +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- openhab +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/openhab +icon: https://www.openhab.org/openhab-logo-square.png +sources: +- https://hub.docker.com/r/openhab/openhab +maintainers: +- name: reitermarkus + email: me@reitermark.us +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.0.1 diff --git a/charts/incubator/openhab/README.md b/charts/incubator/openhab/README.md new file mode 100644 index 00000000..2205d61d --- /dev/null +++ b/charts/incubator/openhab/README.md @@ -0,0 +1,118 @@ +# openhab + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 3.1.0](https://img.shields.io/badge/AppVersion-3.1.0-informational?style=flat-square) + +openhab helm package + +**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 + +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install openhab k8s-at-home/openhab +``` + +## Installing the Chart + +To install the chart with the release name `openhab` + +```console +helm install openhab k8s-at-home/openhab +``` + +## Uninstalling the Chart + +To uninstall the `openhab` deployment + +```console +helm uninstall openhab +``` + +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 openhab \ + --set env.TZ="America/New York" \ + k8s-at-home/openhab +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install openhab k8s-at-home/openhab -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 | string | `nil` | environment variables. See more environment variables in the [openhab image documentation](https://hub.docker.com/r/openhab/openhab). | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"openhab/openhab"` | image repository | +| image.tag | string | `"3.1.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. Choose either -- a single volume for all data or separate volumes for each sub-directory. | +| persistence.addons | object | `{"enabled":false,"mountPath":"/openhab/addons"}` | separate volumes | +| persistence.data | object | `{"enabled":false,"subPath":[{"mountPath":"/openhab/addons","path":"addons"},{"mountPath":"/openhab/conf","path":"conf"},{"mountPath":"/openhab/userdata","path":"userdata"}]}` | single volume | +| service | object | See values.yaml | Configures service settings for the chart. | + +## 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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 + +## 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) diff --git a/charts/incubator/openhab/README.md.gotmpl b/charts/incubator/openhab/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/incubator/openhab/README.md.gotmpl @@ -0,0 +1,146 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**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)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +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). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## 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) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## 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 +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "chart.sourcesSection" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} +{{ "" }} diff --git a/charts/incubator/openhab/README_CHANGELOG.md.gotmpl b/charts/incubator/openhab/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..06ad5fb3 --- /dev/null +++ b/charts/incubator/openhab/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 +{{- end -}} diff --git a/charts/incubator/openhab/README_CONFIG.md.gotmpl b/charts/incubator/openhab/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/incubator/openhab/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/incubator/openhab/templates/NOTES.txt b/charts/incubator/openhab/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/incubator/openhab/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/incubator/openhab/templates/common.yaml b/charts/incubator/openhab/templates/common.yaml new file mode 100644 index 00000000..6cc83fdb --- /dev/null +++ b/charts/incubator/openhab/templates/common.yaml @@ -0,0 +1,18 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the hardcoded volumes */}} +{{- define "openhab.hardcodedValues" -}} +persistence: + init: + enabled: true + mountPath: /etc/cont-init.d/enable-console-logging.sh + subPath: enable-console-logging.sh + type: custom + volumeSpec: + configMap: + name: {{ printf "%v-init" (include "common.names.fullname" .) }} +{{- end -}} +{{- $_ := mergeOverwrite .Values (include "openhab.hardcodedValues" . | fromYaml) -}} + +{{ include "common.all" . }} diff --git a/charts/incubator/openhab/templates/configmap.yaml b/charts/incubator/openhab/templates/configmap.yaml new file mode 100644 index 00000000..7076eceb --- /dev/null +++ b/charts/incubator/openhab/templates/configmap.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "common.names.fullname" . }}-init + labels: + {{- include "common.labels" . | nindent 4 }} +data: + enable-console-logging.sh: | + echo 'Enabling console logging.' + sed -i -E 's|().*|\1|' /openhab/userdata/etc/log4j2.xml diff --git a/charts/incubator/openhab/values.yaml b/charts/incubator/openhab/values.yaml new file mode 100644 index 00000000..66290639 --- /dev/null +++ b/charts/incubator/openhab/values.yaml @@ -0,0 +1,70 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: openhab/openhab + # -- image tag + tag: 3.1.0 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [openhab image documentation](https://hub.docker.com/r/openhab/openhab). +# @default -- See below +env: + # -- Set the container timezone + # TZ: UTC + # EXTRA_JAVA_OPTS: -Duser.timezone=UTC + # USER_ID: 1000 + # GROUP_ID: 1000 + # OPENHAB_HTTP_PORT: 8080 + # OPENHAB_HTTPS_PORT: 8443 + # CRYPTO_POLICY: unlimited + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + enabled: true + port: 8080 + https: + enabled: true + port: 8443 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +# -- Configure persistence settings for the chart under this key. Choose either +# -- a single volume for all data or separate volumes for each sub-directory. +# @default -- See values.yaml +persistence: + # -- single volume + data: + enabled: false + subPath: + - mountPath: /openhab/addons + path: addons + - mountPath: /openhab/conf + path: conf + - mountPath: /openhab/userdata + path: userdata + + # -- separate volumes + addons: + enabled: false + mountPath: /openhab/addons + conf: + enabled: false + mountPath: /openhab/conf + userdata: + enabled: false + mountPath: /openhab/userdata