Chart 0.1.2

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
+
+* <https://github.com/nikdoof/ohayodash>
+
+## 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)