From 1335a5687ec145e9c37f1695e8e8e71b1169a707 Mon Sep 17 00:00:00 2001 From: Anders Brujordet Date: Sat, 20 Mar 2021 13:26:10 +0100 Subject: [PATCH] [magic-mirror] Adding the magic-mirror chart (#696) Signed-off-by: brujoand --- charts/stable/magic-mirror/.helmignore | 26 ++++ charts/stable/magic-mirror/Chart.yaml | 19 +++ charts/stable/magic-mirror/README.md | 123 +++++++++++++++ charts/stable/magic-mirror/README.md.gotmpl | 145 ++++++++++++++++++ .../magic-mirror/README_CHANGELOG.md.gotmpl | 27 ++++ .../magic-mirror/README_CONFIG.md.gotmpl | 11 ++ .../stable/magic-mirror/templates/NOTES.txt | 1 + .../stable/magic-mirror/templates/common.yaml | 53 +++++++ .../magic-mirror/templates/configmap.yaml | 20 +++ charts/stable/magic-mirror/values.yaml | 51 ++++++ 10 files changed, 476 insertions(+) create mode 100644 charts/stable/magic-mirror/.helmignore create mode 100644 charts/stable/magic-mirror/Chart.yaml create mode 100644 charts/stable/magic-mirror/README.md create mode 100644 charts/stable/magic-mirror/README.md.gotmpl create mode 100644 charts/stable/magic-mirror/README_CHANGELOG.md.gotmpl create mode 100644 charts/stable/magic-mirror/README_CONFIG.md.gotmpl create mode 100644 charts/stable/magic-mirror/templates/NOTES.txt create mode 100644 charts/stable/magic-mirror/templates/common.yaml create mode 100644 charts/stable/magic-mirror/templates/configmap.yaml create mode 100644 charts/stable/magic-mirror/values.yaml diff --git a/charts/stable/magic-mirror/.helmignore b/charts/stable/magic-mirror/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/magic-mirror/.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/magic-mirror/Chart.yaml b/charts/stable/magic-mirror/Chart.yaml new file mode 100644 index 00000000..fb8787b1 --- /dev/null +++ b/charts/stable/magic-mirror/Chart.yaml @@ -0,0 +1,19 @@ +apiVersion: v2 +appVersion: v2.14.0 +description: magic-mirror helm package +name: magic-mirror +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- magic-mirror +home: https://github.com/k8s-at-home/charts/tree/master/charts/magic-mirror +sources: +- https://github.com/MichMich/MagicMirror +- https://hub.docker.com/r/bastilimbach/docker-magicmirror +maintainers: +- name: brujoand + email: anders@brujordet.no +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 1.0.0 diff --git a/charts/stable/magic-mirror/README.md b/charts/stable/magic-mirror/README.md new file mode 100644 index 00000000..8ee35a4d --- /dev/null +++ b/charts/stable/magic-mirror/README.md @@ -0,0 +1,123 @@ +# magic-mirror + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: v2.14.0](https://img.shields.io/badge/AppVersion-v2.14.0-informational?style=flat-square) + +magic-mirror 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 | 1.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install magic-mirror k8s-at-home/magic-mirror +``` + +## Installing the Chart + +To install the chart with the release name `magic-mirror` + +```console +helm install magic-mirror k8s-at-home/magic-mirror +``` + +## Uninstalling the Chart + +To uninstall the `magic-mirror` deployment + +```console +helm uninstall magic-mirror +``` + +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 magic-mirror \ + --set env.TZ="America/New York" \ + k8s-at-home/magic-mirror +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install magic-mirror k8s-at-home/magic-mirror -f values.yaml +``` + +## Custom configuration + +The default login details (change ASAP) are: + +* password:deluge + +## 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 | +|-----|------|---------|-------------| +| config | string | `""` | | +| custom_css | string | `""` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"bastilimbach/docker-magicmirror"` | | +| image.tag | string | `"v2.14.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/opt/magic_mirror/modules/custom"` | | +| service.port.port | int | `8080` | | +| 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). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## 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/magic-mirror/README.md.gotmpl b/charts/stable/magic-mirror/README.md.gotmpl new file mode 100644 index 00000000..c21f99b3 --- /dev/null +++ b/charts/stable/magic-mirror/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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/magic-mirror/README_CHANGELOG.md.gotmpl b/charts/stable/magic-mirror/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..457def03 --- /dev/null +++ b/charts/stable/magic-mirror/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 + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/stable/magic-mirror/README_CONFIG.md.gotmpl b/charts/stable/magic-mirror/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..831898cc --- /dev/null +++ b/charts/stable/magic-mirror/README_CONFIG.md.gotmpl @@ -0,0 +1,11 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +The default login details (change ASAP) are: + +* password:deluge +{{- end -}} diff --git a/charts/stable/magic-mirror/templates/NOTES.txt b/charts/stable/magic-mirror/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/magic-mirror/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/magic-mirror/templates/common.yaml b/charts/stable/magic-mirror/templates/common.yaml new file mode 100644 index 00000000..99ed37c8 --- /dev/null +++ b/charts/stable/magic-mirror/templates/common.yaml @@ -0,0 +1,53 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the configMaps to the additionalVolumes */}} +{{- define "magicmirror.configmap.volume" -}} +name: magic-mirror-config +configMap: + name: {{ template "common.names.fullname" . }}-config +{{- end -}} + +{{- define "magicmirror.css.volume" -}} +name: magic-mirror-css +configMap: + name: {{ template "common.names.fullname" . }}-css +{{- end -}} + +{{- $volume := include "magicmirror.configmap.volume" . | fromYaml -}} +{{- if $volume -}} + {{- $additionalVolumes := append .Values.additionalVolumes $volume }} + {{- $_ := set .Values "additionalVolumes" (deepCopy $additionalVolumes) -}} +{{- end -}} + +{{- $volume := include "magicmirror.css.volume" . | fromYaml -}} +{{- if $volume -}} + {{- $additionalVolumes := append .Values.additionalVolumes $volume }} + {{- $_ := set .Values "additionalVolumes" (deepCopy $additionalVolumes) -}} +{{- end -}} + +{{/* Append the configMap volumes to the additionalVolumeMounts */}} +{{- define "magicmirror.configmap.volumeMount" -}} +name: magic-mirror-config +mountPath: /opt/magic_mirror/config/config.js +subPath: config.js +{{- end -}} + +{{- define "magicmirror.css.volumeMount" -}} +name: magic-mirror-css +mountPath: /opt/magic_mirror/css/custom.css +subPath: custom.css +{{- end -}} + +{{- $volumeMount := include "magicmirror.configmap.volumeMount" . | fromYaml -}} +{{- if $volumeMount -}} + {{- $additionalVolumeMounts := append .Values.additionalVolumeMounts $volumeMount }} + {{- $_ := set .Values "additionalVolumeMounts" (deepCopy $additionalVolumeMounts) -}} +{{- end -}} + +{{- $volumeMount := include "magicmirror.css.volumeMount" . | fromYaml -}} +{{- if $volumeMount -}} + {{- $additionalVolumeMounts := append .Values.additionalVolumeMounts $volumeMount }} + {{- $_ := set .Values "additionalVolumeMounts" (deepCopy $additionalVolumeMounts) -}} +{{- end -}} +{{ include "common.all" . }} diff --git a/charts/stable/magic-mirror/templates/configmap.yaml b/charts/stable/magic-mirror/templates/configmap.yaml new file mode 100644 index 00000000..66fbaa64 --- /dev/null +++ b/charts/stable/magic-mirror/templates/configmap.yaml @@ -0,0 +1,20 @@ +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ template "common.names.fullname" . }}-config + labels: + {{- include "common.labels" . | nindent 4 }} +data: + config.js: | + {{- .Values.config | nindent 4 }} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ template "common.names.fullname" . }}-css + labels: + {{- include "common.labels" . | nindent 4 }} +data: + custom.css: | + {{- .Values.custom_css | nindent 4 }} diff --git a/charts/stable/magic-mirror/values.yaml b/charts/stable/magic-mirror/values.yaml new file mode 100644 index 00000000..403ee285 --- /dev/null +++ b/charts/stable/magic-mirror/values.yaml @@ -0,0 +1,51 @@ +# 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: + repository: bastilimbach/docker-magicmirror + pullPolicy: IfNotPresent + tag: v2.14.0 + +strategy: + type: Recreate + +service: + port: + port: 8080 + +ingress: + enabled: false + +persistence: + data: + enabled: false + mountPath: "/opt/magic_mirror/modules/custom" + +# Contents of your custom.css +custom_css: "" + +# Contents of your config.js +config: | + var config = { + address: "0.0.0.0", + port: 8080, + ipWhitelist: [], + language: "en", + timeFormat: 24, + units: "metric", + modules: [], + }; + + /*************** DO NOT EDIT THE LINE BELOW ***************/ + if (typeof module !== "undefined") {module.exports = config;} + +env: {} + ## Optional ENV Vars that can be set. + ## All values below are the current default values. + # PUID: "1000" + # PGID: "1000" + # TZ: "Europe/Oslo" + # UMASK_SET: "022"