From 1bf86d16d1e544add171c190de0e12c59a23df0b Mon Sep 17 00:00:00 2001 From: Gerald Wu Date: Tue, 5 Jul 2022 09:57:41 +0000 Subject: [PATCH] [ntfy] Add ntfy chart (#1689) * [ntfy] Add ntfy chart Signed-off-by: geraldwuhoo --- charts/stable/ntfy/.helmignore | 26 +++++ charts/stable/ntfy/Chart.yaml | 24 +++++ charts/stable/ntfy/README.md | 111 +++++++++++++++++++++ charts/stable/ntfy/README_CONFIG.md.gotmpl | 9 ++ charts/stable/ntfy/templates/NOTES.txt | 1 + charts/stable/ntfy/templates/common.yaml | 1 + charts/stable/ntfy/values.yaml | 50 ++++++++++ 7 files changed, 222 insertions(+) create mode 100644 charts/stable/ntfy/.helmignore create mode 100644 charts/stable/ntfy/Chart.yaml create mode 100644 charts/stable/ntfy/README.md create mode 100644 charts/stable/ntfy/README_CONFIG.md.gotmpl create mode 100644 charts/stable/ntfy/templates/NOTES.txt create mode 100644 charts/stable/ntfy/templates/common.yaml create mode 100644 charts/stable/ntfy/values.yaml diff --git a/charts/stable/ntfy/.helmignore b/charts/stable/ntfy/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/ntfy/.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/ntfy/Chart.yaml b/charts/stable/ntfy/Chart.yaml new file mode 100644 index 00000000..dd4fd8e2 --- /dev/null +++ b/charts/stable/ntfy/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +appVersion: v1.27.2 +description: "Send push notifications to your phone or desktop using PUT/POST" +name: ntfy +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: + - ntfy + - notification +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/ntfy +icon: https://raw.githubusercontent.com/binwiederhier/ntfy/main/web/public/static/img/ntfy.png +sources: + - https://github.com/binwiederhier/ntfy +maintainers: + - name: geraldwuhoo + email: gerald@geraldwu.com +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 4.4.2 +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial version diff --git a/charts/stable/ntfy/README.md b/charts/stable/ntfy/README.md new file mode 100644 index 00000000..46c07049 --- /dev/null +++ b/charts/stable/ntfy/README.md @@ -0,0 +1,111 @@ +# ntfy + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +ntfy 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.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install ntfy k8s-at-home/ntfy +``` + +## Installing the Chart + +To install the chart with the release name `ntfy` + +```console +helm install ntfy k8s-at-home/ntfy +``` + +## Uninstalling the Chart + +To uninstall the `ntfy` deployment + +```console +helm uninstall ntfy +``` + +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 ntfy \ + --set env.TZ="America/New York" \ + k8s-at-home/ntfy +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install ntfy k8s-at-home/ntfy -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 [ntfy documentation](https://ntfy.org/docs). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"ntfy/ntfy"` | image repository | +| image.tag | string | chart.appVersion | 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. | +| service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +### Version 1.0.0 + +#### Added + +- Initial version + +#### Changed + +N/A + +#### Fixed + +N/A + +## 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/ntfy/README_CONFIG.md.gotmpl b/charts/stable/ntfy/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/ntfy/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/ntfy/templates/NOTES.txt b/charts/stable/ntfy/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/ntfy/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/ntfy/templates/common.yaml b/charts/stable/ntfy/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/ntfy/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/ntfy/values.yaml b/charts/stable/ntfy/values.yaml new file mode 100644 index 00000000..56a595ee --- /dev/null +++ b/charts/stable/ntfy/values.yaml @@ -0,0 +1,50 @@ +# +# 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: binwiederhier/ntfy + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [ntfy documentation](https://ntfy.org/docs). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + +# -- Configures command args to run the docker image in server mode +# @default -- See values.yaml +args: + - serve + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 80 + +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. +# @default -- See values.yaml +persistence: + cache: + enabled: false + mountPath: /var/cache/ntfy + config: + enabled: false + mountPath: /etc/ntfy