diff --git a/charts/ohayodash/Chart.yaml b/charts/ohayodash/Chart.yaml index e357f40..6c863d6 100644 --- a/charts/ohayodash/Chart.yaml +++ b/charts/ohayodash/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v2 -appVersion: 0.1.0 +appVersion: 0.1.2 description: Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps. name: ohayodash -version: 0.1.1 +version: 0.1.2 kubeVersion: ">=1.16.0-0" keywords: - ohayodash diff --git a/charts/ohayodash/README.md b/charts/ohayodash/README.md new file mode 100644 index 0000000..fcbac29 --- /dev/null +++ b/charts/ohayodash/README.md @@ -0,0 +1,113 @@ +# ohayodash + +![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![AppVersion: 0.1.2](https://img.shields.io/badge/AppVersion-0.1.2-informational?style=flat-square) + +Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps. + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/nikdoof/helm-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.2.0 | + +## TL;DR + +```console +helm repo add ohayodash https://nikdoof.github.io/ohayodash/ +helm repo update +helm install ohayodash ohayodash/ohayodash +``` + +## Installing the Chart + +To install the chart with the release name `ohayodash` + +```console +helm install ohayodash ohayodash/ohayodash +``` + +## Uninstalling the Chart + +To uninstall the `ohayodash` deployment + +```console +helm uninstall ohayodash +``` + +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 ohayodash \ + --set env.TZ="Europe/London"\ + ohayodash/ohayodash +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install ohayodash ohayodash/ohayodash -f values.yaml +``` + +## Custom configuration + +## 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. | +| env.DATE_FORMAT | string | `"%Y-%m-%d %H:%M"` | Python date format string to use for rendering the date/time | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"ghcr.io/nikdoof/ohayodash"` | image repository | +| image.tag | string | `"latest"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| service | object | See values.yaml | Configures service settings for the chart. | +| serviceAccount | object | See below | Configures service account needed for reading k8s ingress objects | +| serviceAccount.create | bool | `true` | Create service account | + +## 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). + +### [0.1.2] + +#### Added + +- Started the Changelog +- Pinned to 0.1.2 rather than latest + +#### Changed + +- N/A + +#### Removed + +- N/A + +## Support + +- Open an [issue](https://github.com/nikdoof/ohayodash/issues/new/choose) + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/ohayodash/README.md.gotmpl b/charts/ohayodash/README.md.gotmpl new file mode 100644 index 0000000..a20f176 --- /dev/null +++ b/charts/ohayodash/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +ohayodash +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/nikdoof/ohayodash +{{- end -}} + +{{- define "custom.helm.url" -}} +https://nikdoof.github.io/ohayodash/ +{{- 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/nikdoof/helm-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="Europe/London"\ + {{ 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 + +- Open an [issue](https://github.com/nikdoof/ohayodash/issues/new/choose) +{{- 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/ohayodash/README_CHANGELOG.md.gotmpl b/charts/ohayodash/README_CHANGELOG.md.gotmpl new file mode 100644 index 0000000..b6272e5 --- /dev/null +++ b/charts/ohayodash/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). + +### [0.1.2] + +#### Added + +- Started the Changelog +- Pinned to 0.1.2 rather than latest + +#### Changed + +- N/A + +#### Removed + +- N/A + +{{- end -}} diff --git a/charts/ohayodash/README_CONFIG.md.gotmpl b/charts/ohayodash/README_CONFIG.md.gotmpl new file mode 100644 index 0000000..1e3d422 --- /dev/null +++ b/charts/ohayodash/README_CONFIG.md.gotmpl @@ -0,0 +1,7 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} +{{- end -}} diff --git a/charts/ohayodash/values.yaml b/charts/ohayodash/values.yaml index aa84fee..6b81a8e 100644 --- a/charts/ohayodash/values.yaml +++ b/charts/ohayodash/values.yaml @@ -9,9 +9,9 @@ image: # -- image repository repository: ghcr.io/nikdoof/ohayodash # -- image pull policy - pullPolicy: Always + pullPolicy: IfNotPresent # -- image tag - tag: latest + tag: 0.1.2 # -- environment variables. # @default -- See below