From cfd656a76fc952bda859a00869481434258c37cc Mon Sep 17 00:00:00 2001 From: nchilder Date: Tue, 26 Apr 2022 02:10:24 -0400 Subject: [PATCH] [nightscout] Add chart nightscout (#1515) * add nightscout/cgm-remote-monitor chart Signed-off-by: Nick Childers --- charts/stable/nightscout/.helmignore | 26 ++++ charts/stable/nightscout/Chart.yaml | 23 ++++ charts/stable/nightscout/README.md | 116 ++++++++++++++++++ .../stable/nightscout/README_CONFIG.md.gotmpl | 9 ++ charts/stable/nightscout/templates/NOTES.txt | 1 + .../stable/nightscout/templates/common.yaml | 1 + charts/stable/nightscout/values.yaml | 50 ++++++++ 7 files changed, 226 insertions(+) create mode 100644 charts/stable/nightscout/.helmignore create mode 100644 charts/stable/nightscout/Chart.yaml create mode 100644 charts/stable/nightscout/README.md create mode 100644 charts/stable/nightscout/README_CONFIG.md.gotmpl create mode 100644 charts/stable/nightscout/templates/NOTES.txt create mode 100644 charts/stable/nightscout/templates/common.yaml create mode 100644 charts/stable/nightscout/values.yaml diff --git a/charts/stable/nightscout/.helmignore b/charts/stable/nightscout/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/nightscout/.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/nightscout/Chart.yaml b/charts/stable/nightscout/Chart.yaml new file mode 100644 index 00000000..7910a2e7 --- /dev/null +++ b/charts/stable/nightscout/Chart.yaml @@ -0,0 +1,23 @@ +apiVersion: v2 +appVersion: 14.2.5 +description: nightscout helm package +name: nightscout +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- nightscout +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/nightscout +icon: https://github.com/nightscout/cgm-remote-monitor/blob/master/static/images/favicon-96x96.png +sources: +- https://github.com/nightscout/nightscout-docker +maintainers: +- name: nchilder + email: nchilder@redhat.com +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.3.0 +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial version diff --git a/charts/stable/nightscout/README.md b/charts/stable/nightscout/README.md new file mode 100644 index 00000000..dd12c8aa --- /dev/null +++ b/charts/stable/nightscout/README.md @@ -0,0 +1,116 @@ +# nightscout + +![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) + +nightscout 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 nightscout k8s-at-home/nightscout +``` + +## Installing the Chart + +To install the chart with the release name `nightscout` + +```console +helm install nightscout k8s-at-home/nightscout +``` + +## Uninstalling the Chart + +To uninstall the `nightscout` deployment + +```console +helm uninstall nightscout +``` + +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 nightscout \ + --set env.TZ="America/New York" \ + k8s-at-home/nightscout +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install nightscout k8s-at-home/nightscout -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) +**Important**: Some of the below environment variables are **required** to be set for Nightscout to function. + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | See below | environment variables. See more environment variables in the [Nightscout documentation](https://github.com/nightscout/cgm-remote-monitor#environments). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| env.MONGODB_URI | none | **REQUIRED**: MongoDB URI | +| env.API_SECRET | none | **REQUIRED**: API secret. Must be at least 12 characters long. | +| env.MONGODB_COLLECTION | `"entries"` | **REQUIRED**: MongoDB collection where entries are stored. | +| env.DISPLAY_UNITS | `"mg/dl"` | **REQUIRED**: Display units for BG values. Valid values are mg/dl or mmol | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"nightscout/nightscout"` | 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/nightscout/README_CONFIG.md.gotmpl b/charts/stable/nightscout/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/nightscout/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/nightscout/templates/NOTES.txt b/charts/stable/nightscout/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/nightscout/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/nightscout/templates/common.yaml b/charts/stable/nightscout/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/nightscout/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/nightscout/values.yaml b/charts/stable/nightscout/values.yaml new file mode 100644 index 00000000..d15d5255 --- /dev/null +++ b/charts/stable/nightscout/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: nightscout/cgm-remote-monitor + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [Nightscout/cgm-remote-monitor documentation](https://github.com/nightscout/cgm-remote-monitor#environment). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + # -- MongoDB URI, eg mongodb://sally:sallypass@ds099999.mongolab.com:99999/nightscout + MONGODB_URI: '' + # -- API secret, must be at least 12 characters long + API_SECRET: '' + # -- MongoDB collection for BG entries + MONGODB_COLLECTION: entries + # -- Display units for BG. Valid values are mg/dl or mmol + DISPLAY_UNITS: mg/dl + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 1337 + +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: {} + # data: + # enabled: false + # mountPath: /data