diff --git a/.github/ct-install.yaml b/.github/ct-install.yaml index f022f2ff..d4e146a5 100644 --- a/.github/ct-install.yaml +++ b/.github/ct-install.yaml @@ -6,14 +6,15 @@ chart-dirs: - charts/stable excluded-charts: - charts/stable/alertmanager-bot +- charts/stable/amcrest2mqtt +- charts/stable/foundryvtt - charts/stable/multus +- charts/stable/pod-gateway - charts/stable/promcord - charts/stable/reg - charts/stable/ser2sock - charts/stable/zalando-postgres-cluster - charts/stable/zigbee2mqtt -- charts/stable/foundryvtt -- charts/stable/pod-gateway chart-repos: - bitnami=https://charts.bitnami.com/bitnami - k8s-at-home-libraries=https://library-charts.k8s-at-home.com diff --git a/charts/stable/amcrest2mqtt/.helmignore b/charts/stable/amcrest2mqtt/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/amcrest2mqtt/.helmignore @@ -0,0 +1,26 @@ +# 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 +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/stable/amcrest2mqtt/Chart.yaml b/charts/stable/amcrest2mqtt/Chart.yaml new file mode 100644 index 00000000..70e6d9e5 --- /dev/null +++ b/charts/stable/amcrest2mqtt/Chart.yaml @@ -0,0 +1,19 @@ +apiVersion: v2 +appVersion: 1.0.5 +description: Expose all events from an Amcrest device to an MQTT broker +name: amcrest2mqtt +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- amcrest2mqtt +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/amcrest2mqtt +icon: https://raw.githubusercontent.com/k8s-at-home/organization/main/logo/k8s-at-home-400.png +sources: +- https://github.com/dchesterton/amcrest2mqtt +maintainers: +- name: bjw-s + email: me@bjw-s.dev +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 3.3.0 diff --git a/charts/stable/amcrest2mqtt/README.md b/charts/stable/amcrest2mqtt/README.md new file mode 100644 index 00000000..f89cf299 --- /dev/null +++ b/charts/stable/amcrest2mqtt/README.md @@ -0,0 +1,116 @@ +# amcrest2mqtt + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.5](https://img.shields.io/badge/AppVersion-1.0.5-informational?style=flat-square) + +Expose all events from an Amcrest device to an MQTT broker + +**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 | 3.3.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install amcrest2mqtt k8s-at-home/amcrest2mqtt +``` + +## Installing the Chart + +To install the chart with the release name `amcrest2mqtt` + +```console +helm install amcrest2mqtt k8s-at-home/amcrest2mqtt +``` + +## Uninstalling the Chart + +To uninstall the `amcrest2mqtt` deployment + +```console +helm uninstall amcrest2mqtt +``` + +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 amcrest2mqtt \ + --set env.TZ="America/New York" \ + k8s-at-home/amcrest2mqtt +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install amcrest2mqtt k8s-at-home/amcrest2mqtt -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 | object | See below | environment variables. See more environment variables in the [amcrest2mqtt repo](https://github.com/dchesterton/amcrest2mqtt). | +| env.AMCREST_HOST | string | `nil` | Host name used to connect to the Amcrest device | +| env.AMCREST_PASSWORD | string | `nil` | Password used to connect to the Amcrest device | +| env.AMCREST_PORT | int | `80` | Port used to connect to the Amcrest device | +| env.AMCREST_USERNAME | string | `nil` | User name used to connect to the Amcrest device | +| env.HOME_ASSISTANT | string | `"false"` | Enable Home Assistant autodiscovery | +| env.HOME_ASSISTANT_PREFIX | string | `"homeassistant"` | Home Assistant autodiscovery prefix | +| env.MQTT_HOST | int | `1883` | Host name used to connect to the MQTT broker | +| env.MQTT_PASSWORD | string | `nil` | Password used to connect to the MQTT broker | +| env.MQTT_PORT | string | `nil` | Port used to connect to the MQTT broker | +| env.MQTT_USERNAME | string | `nil` | User name used to connect to the MQTT broker | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"dchesterton/amcrest2mqtt"` | image repository | +| image.tag | string | `"1.0.5"` | image tag | + +## 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 + +[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/stable/amcrest2mqtt/README.md.gotmpl b/charts/stable/amcrest2mqtt/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/stable/amcrest2mqtt/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/stable/amcrest2mqtt/README_CHANGELOG.md.gotmpl b/charts/stable/amcrest2mqtt/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..76212e97 --- /dev/null +++ b/charts/stable/amcrest2mqtt/README_CHANGELOG.md.gotmpl @@ -0,0 +1,19 @@ +{{- 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 + +[1.0.0]: #100 +{{- end -}} diff --git a/charts/stable/amcrest2mqtt/README_CONFIG.md.gotmpl b/charts/stable/amcrest2mqtt/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/amcrest2mqtt/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/stable/amcrest2mqtt/templates/NOTES.txt b/charts/stable/amcrest2mqtt/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/amcrest2mqtt/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/amcrest2mqtt/templates/common.yaml b/charts/stable/amcrest2mqtt/templates/common.yaml new file mode 100644 index 00000000..5216d9d3 --- /dev/null +++ b/charts/stable/amcrest2mqtt/templates/common.yaml @@ -0,0 +1,25 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the hardcoded settings */}} +{{- define "amcrest2mqtt.hardcodedValues" -}} +service: + main: + enabled: false + +ingress: + main: + enabled: false + +probes: + liveness: + enabled: false + readiness: + enabled: false + startup: + enabled: false +{{- end -}} +{{- $_ := mergeOverwrite .Values (include "amcrest2mqtt.hardcodedValues" . | fromYaml) -}} + +{{/* Render the templates */}} +{{ include "common.all" . }} diff --git a/charts/stable/amcrest2mqtt/values.yaml b/charts/stable/amcrest2mqtt/values.yaml new file mode 100644 index 00000000..b26dbad4 --- /dev/null +++ b/charts/stable/amcrest2mqtt/values.yaml @@ -0,0 +1,40 @@ +# +# 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: dchesterton/amcrest2mqtt + # -- image tag + tag: 1.0.5 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [amcrest2mqtt repo](https://github.com/dchesterton/amcrest2mqtt). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + # -- Host name used to connect to the Amcrest device + AMCREST_HOST: + # -- Port used to connect to the Amcrest device + AMCREST_PORT: 80 + # -- User name used to connect to the Amcrest device + AMCREST_USERNAME: + # -- Password used to connect to the Amcrest device + AMCREST_PASSWORD: + # -- Host name used to connect to the MQTT broker + MQTT_HOST: 1883 + # -- Port used to connect to the MQTT broker + MQTT_PORT: + # -- User name used to connect to the MQTT broker + MQTT_USERNAME: + # -- Password used to connect to the MQTT broker + MQTT_PASSWORD: + # -- Enable Home Assistant autodiscovery + HOME_ASSISTANT: "false" + # -- Home Assistant autodiscovery prefix + HOME_ASSISTANT_PREFIX: "homeassistant" diff --git a/templates/chart/Chart.yaml b/templates/chart/Chart.yaml index a45cccf4..282bdfde 100644 --- a/templates/chart/Chart.yaml +++ b/templates/chart/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 1.0.0 description: ${CHARTNAME} helm package name: ${CHARTNAME} -version: 1.3.0 +version: 1.0.0 kubeVersion: ">=1.16.0-0" keywords: - ${CHARTNAME}