From 4b2a66670132b179427f505303a2651bec35ce17 Mon Sep 17 00:00:00 2001 From: Roger Rumao Date: Wed, 29 Dec 2021 17:58:53 -0600 Subject: [PATCH] [alertmanager-discord] Add new chart (#1329) --- .github/ct-install.yaml | 1 + .../stable/alertmanager-discord/.helmignore | 27 ++++ charts/stable/alertmanager-discord/Chart.yaml | 22 +++ charts/stable/alertmanager-discord/README.md | 120 ++++++++++++++ .../alertmanager-discord/README.md.gotmpl | 146 ++++++++++++++++++ .../README_CHANGELOG.md.gotmpl | 27 ++++ .../README_CONFIG.md.gotmpl | 9 ++ .../alertmanager-discord/templates/NOTES.txt | 1 + .../templates/common.yaml | 1 + .../stable/alertmanager-discord/values.yaml | 62 ++++++++ 10 files changed, 416 insertions(+) create mode 100644 charts/stable/alertmanager-discord/.helmignore create mode 100644 charts/stable/alertmanager-discord/Chart.yaml create mode 100644 charts/stable/alertmanager-discord/README.md create mode 100644 charts/stable/alertmanager-discord/README.md.gotmpl create mode 100644 charts/stable/alertmanager-discord/README_CHANGELOG.md.gotmpl create mode 100644 charts/stable/alertmanager-discord/README_CONFIG.md.gotmpl create mode 100644 charts/stable/alertmanager-discord/templates/NOTES.txt create mode 100644 charts/stable/alertmanager-discord/templates/common.yaml create mode 100644 charts/stable/alertmanager-discord/values.yaml diff --git a/.github/ct-install.yaml b/.github/ct-install.yaml index 7f544aca..9be88664 100644 --- a/.github/ct-install.yaml +++ b/.github/ct-install.yaml @@ -6,6 +6,7 @@ chart-dirs: - charts/stable excluded-charts: - charts/stable/alertmanager-bot +- charts/stable/alertmanager-discord - charts/stable/amcrest2mqtt - charts/stable/foundryvtt - charts/stable/heimdall diff --git a/charts/stable/alertmanager-discord/.helmignore b/charts/stable/alertmanager-discord/.helmignore new file mode 100644 index 00000000..c82e15d7 --- /dev/null +++ b/charts/stable/alertmanager-discord/.helmignore @@ -0,0 +1,27 @@ +# 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 +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/stable/alertmanager-discord/Chart.yaml b/charts/stable/alertmanager-discord/Chart.yaml new file mode 100644 index 00000000..5a34f140 --- /dev/null +++ b/charts/stable/alertmanager-discord/Chart.yaml @@ -0,0 +1,22 @@ +apiVersion: v2 +appVersion: 1.0.3 +description: Webhook for Prometheus Alertmanager to listen for notifications and pushes them to Discord channel +name: alertmanager-discord +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- alertmanager +- discord +- alerting +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/alertmanager-discord +icon: https://raw.githubusercontent.com/prometheus/prometheus.github.io/master/assets/prometheus_logo-cb55bb5c346.png +sources: +- https://github.com/rogerrum/alertmanager-discord +- https://hub.docker.com/r/rogerrum/alertmanager-discord +maintainers: +- name: rogerrum + email: rogerrum@gmail.com +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.2.0 diff --git a/charts/stable/alertmanager-discord/README.md b/charts/stable/alertmanager-discord/README.md new file mode 100644 index 00000000..b081ced0 --- /dev/null +++ b/charts/stable/alertmanager-discord/README.md @@ -0,0 +1,120 @@ +# alertmanager-discord + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.3](https://img.shields.io/badge/AppVersion-1.0.3-informational?style=flat-square) + +Webhook for Prometheus Alertmanager to listen for notifications and pushes them to Discord channel + +**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.19.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.2.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install alertmanager-discord k8s-at-home/alertmanager-discord +``` + +## Installing the Chart + +To install the chart with the release name `alertmanager-discord` + +```console +helm install alertmanager-discord k8s-at-home/alertmanager-discord +``` + +## Uninstalling the Chart + +To uninstall the `alertmanager-discord` deployment + +```console +helm uninstall alertmanager-discord +``` + +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 alertmanager-discord \ + --set env.TZ="America/New York" \ + k8s-at-home/alertmanager-discord +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install alertmanager-discord k8s-at-home/alertmanager-discord -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 [image docs](https://github.com/metalmatze/alertmanager-bot) for more configuration options. | +| env.DISCORD_USERNAME | string | `"Alertmanager"` | Discord Username | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"rogerrum/alertmanager-discord"` | image repository | +| image.tag | string | `"1.0.3"` | image tag | +| ingress | object | Disabled | 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. | +| probes | object | Disabled | Configures probes for the chart. Normally this does not need to be modified. | +| service.main.enabled | bool | `true` | | +| service.main.ports.http.port | int | `9094` | | + +## 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/commonREADME.md#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/alertmanager-discord/README.md.gotmpl b/charts/stable/alertmanager-discord/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/stable/alertmanager-discord/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/alertmanager-discord/README_CHANGELOG.md.gotmpl b/charts/stable/alertmanager-discord/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..d456fa08 --- /dev/null +++ b/charts/stable/alertmanager-discord/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/commonREADME.md#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/alertmanager-discord/README_CONFIG.md.gotmpl b/charts/stable/alertmanager-discord/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/alertmanager-discord/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/alertmanager-discord/templates/NOTES.txt b/charts/stable/alertmanager-discord/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/alertmanager-discord/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/alertmanager-discord/templates/common.yaml b/charts/stable/alertmanager-discord/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/alertmanager-discord/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/alertmanager-discord/values.yaml b/charts/stable/alertmanager-discord/values.yaml new file mode 100644 index 00000000..5c59edd2 --- /dev/null +++ b/charts/stable/alertmanager-discord/values.yaml @@ -0,0 +1,62 @@ +# +# 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: rogerrum/alertmanager-discord + # -- image tag + tag: 1.0.3 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See [image docs](https://github.com/metalmatze/alertmanager-bot) for more configuration options. +# @default -- See below +env: + # -- Discord Username + DISCORD_USERNAME: "Alertmanager" +# -- Discord Avatar icon +# DISCORD_AVATAR_URL: "https://avatars3.githubusercontent.com/u/3380462" +# -- Enable Verbose mode (log request and responses) +# VERBOSE: "ON" +# -- Discord Webhook - Can be used from envValueFrom secrets +# DISCORD_WEBHOOK="" +# DISCORD_WEBHOOK: +# valueFrom: +# secretKeyRef: +# name: alertmanager-discord-secret +# key: DISCORD_WEBHOOK + + +# -- Configures service settings for the chart. Normally this does not need to be modified. +service: + main: + enabled: true + ports: + http: + port: 9094 + +# -- Enable and configure ingress settings for the chart under this key. +# @default -- Disabled +ingress: + main: + enabled: false + +# -- Configures probes for the chart. Normally this does not need to be modified. +# @default -- Disabled +probes: + liveness: + enabled: false + readiness: + enabled: false + startup: + enabled: false + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + data: + enabled: false