[healthchecks] new chart (#681)

2025-01-23 15:39:02 +00:00 · 2021-03-16 12:27:40 +01:00 · 2021-03-16 12:27:40 +01:00 · 5b57026d00
commit 5b57026d00
parent d6fadad88f
9 changed files with 394 additions and 0 deletions
--- a/charts/healthchecks/.helmignore
+++ b/charts/healthchecks/.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
--- a/charts/healthchecks/Chart.yaml
+++ b/charts/healthchecks/Chart.yaml
@ -0,0 +1,21 @@
+apiVersion: v2
+appVersion: 1.19.0
+description: Healthchecks is a cron job monitoring service. It listens for HTTP requests and email messages ("pings") from your cron jobs and scheduled tasks ("checks"). When a ping does not arrive on time, Healthchecks sends out alerts.
+name: healthchecks
+version: 1.0.0
+keywords:
+  - cron
+  - monitoring
+  - alert
+home: https://github.com/k8s-at-home/charts/tree/master/charts/healthchecks
+icon: https://raw.githubusercontent.com/healthchecks/healthchecks/master/stuff/logo.svg?raw=true
+sources:
+  - https://github.com/healthchecks/healthchecks
+  - https://hub.docker.com/r/linuxserver/healthchecks
+maintainers:
+  - name: auricom
+    email: k8s-at-home@xpander.eml.cc
+dependencies:
+  - name: common
+    repository: https://library-charts.k8s-at-home.com
+    version: 1.0.0
--- a/charts/healthchecks/README.md
+++ b/charts/healthchecks/README.md
@ -0,0 +1,107 @@
+# healthchecks
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.19.0](https://img.shields.io/badge/AppVersion-1.19.0-informational?style=flat-square)
+
+Healthchecks is a cron job monitoring service. It listens for HTTP requests and email messages ("pings") from your cron jobs and scheduled tasks ("checks"). When a ping does not arrive on time, Healthchecks sends out alerts.
+
+**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
+
+* <https://github.com/healthchecks/healthchecks>
+* <https://hub.docker.com/r/linuxserver/healthchecks>
+
+## Requirements
+
+## 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 healthchecks k8s-at-home/healthchecks
+```
+
+## Installing the Chart
+
+To install the chart with the release name `healthchecks`
+
+```console
+helm install healthchecks k8s-at-home/healthchecks
+```
+
+## Uninstalling the Chart
+
+To uninstall the `healthchecks` deployment
+
+```console
+helm uninstall healthchecks
+```
+
+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](../common/values.yaml) from the [common library](../common).
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install healthchecks \
+  --set env.TZ="America/New York" \
+    k8s-at-home/healthchecks
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install healthchecks k8s-at-home/healthchecks -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/charts/tree/master/charts/common/)
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | Affinity settings for pod assignment of the GUI |
+| env.REGENERATE_SETTINGS | string | `"True"` | Set to true to always override the local_settings.py file with values from environment variables. Do not set to True if you have made manual modifications to this file. |
+| env.SITE_NAME | int | `8265` | The site's name (e.g., "Example Corp HealthChecks") |
+| env.SITE_ROOT | string | `"https://healthchecks.domain"` | The site's top-level URL and the port it listens to |
+| env.SUPERUSER_EMAIL | string | `"email@healthchecks.io"` | Superuser email |
+| env.SUPERUSER_PASSWORD | string | `"myVeryStrongPassword"` | Superuser password |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"linuxserver/healthchecks"` | healthchecks image |
+| image.tag | string | `"v1.19.0-ls79"` | healthchecks image tag |
+| nodeSelector | object | `{}` | Node labels for pod assignment of the GUI |
+| persistence.config | object | `{"emptyDir":false,"enabled":false,"mountpath":"/config"}` | Volume used for configuration |
+| podAnnotations | object | `{}` | Pod annotations |
+| resources | object | `{}` |  |
+| service.port.port | int | `8000` | Kubernetes port where the GUI is exposed |
+| tolerations | list | `[]` | Toleration labels for pod assignment of the GUI |
+
+## 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/charts/tree/master/charts/common/README.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).
+
+## 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)
--- a/charts/healthchecks/README.md.gotmpl
+++ b/charts/healthchecks/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](../common/values.yaml) from the [common library](../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/charts/tree/master/charts/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" . }}
--- a/charts/healthchecks/README_CHANGELOG.md.gotmpl
+++ b/charts/healthchecks/README_CHANGELOG.md.gotmpl
@ -0,0 +1,12 @@
+{{- 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/charts/tree/master/charts/common/README.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).
+
+{{- end -}}
--- a/charts/healthchecks/README_CONFIG.md.gotmpl
+++ b/charts/healthchecks/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 -}}
--- a/charts/healthchecks/templates/NOTES.txt
+++ b/charts/healthchecks/templates/NOTES.txt
@ -0,0 +1 @@
+{{- include "common.notes.defaultNotes" . -}}
--- a/charts/healthchecks/templates/common.yaml
+++ b/charts/healthchecks/templates/common.yaml
@ -0,0 +1 @@
+{{ include "common.all" . }}
--- a/charts/healthchecks/values.yaml
+++ b/charts/healthchecks/values.yaml
@ -0,0 +1,72 @@
+# Default values for healthchecks.
+
+image:
+  # -- healthchecks image
+  repository: linuxserver/healthchecks
+  # -- healthchecks image tag
+  tag: v1.19.0-ls79
+  # healthchecks image pull policy
+  pullPolicy: IfNotPresent
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #  cpu: 100m
+  #  memory: 128Mi
+  # requests:
+  #  cpu: 100m
+  #  memory: 128Mi
+
+service:
+  port:
+    # -- Kubernetes port where the GUI is exposed
+    port: 8000
+
+
+ # Please consult https://github.com/linuxserver/docker-healthchecks#parameters to see all parameters
+
+env:
+  # -- Set to true to always override the local_settings.py file with values from environment variables. Do not set to True if you have made manual modifications to this file.
+  REGENERATE_SETTINGS: "True"
+  # -- The site's top-level URL and the port it listens to
+  SITE_ROOT: https://healthchecks.domain
+  # -- The site's name (e.g., "Example Corp HealthChecks")
+  SITE_NAME: 8265
+  # -- Superuser email
+  SUPERUSER_EMAIL: email@healthchecks.io
+  # -- Superuser password
+  SUPERUSER_PASSWORD: myVeryStrongPassword
+
+# -- Node labels for pod assignment of the GUI
+nodeSelector: {}
+
+# -- Toleration labels for pod assignment of the GUI
+tolerations: []
+
+# -- Affinity settings for pod assignment of the GUI
+affinity: {}
+
+# -- Pod annotations
+podAnnotations: {}
+
+persistence:
+# -- Volume used for configuration
+  config:
+    enabled: false
+    emptyDir: false
+    mountpath: /config
+    ## Persistent Volume Storage Class
+    ## If defined, storageClassName: <storageClass>
+    ## If set to "-", storageClassName: "", which disables dynamic provisioning
+    ## If undefined (the default) or set to null, no storageClassName spec is
+    ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
+    ##   GKE, AWS & OpenStack)
+    # storageClass: "-"
+    # accessMode: ReadWriteOnce
+    # size: 1Gi
+    ## Do not delete the pvc upon helm uninstall
+    # skipuninstall: false
+    # existingClaim: ""
				`@ -0,0 +1 @@`
				`{{- include "common.notes.defaultNotes" . -}}`