From bd80fa69627129705bfcd241c3c8f3e82e3d1c6e Mon Sep 17 00:00:00 2001 From: Ornias1993 Date: Sat, 27 Feb 2021 18:48:39 +0000 Subject: [PATCH] Publish docs updates Signed-off-by: Ornias1993 --- charts/traefik/1.0.4/README.md | 2 +- charts/traefik/1.0.4/app-readme.md | 1 + charts/unifi/1.0.0/README.md | 91 ++++++++++-------------- charts/unifi/1.0.0/app-readme.md | 3 +- charts/unifi/1.0.0/docs/CONFIG.md | 3 + charts/unifi/1.0.0/docs/CONFIG.md.gotmpl | 11 +++ 6 files changed, 56 insertions(+), 55 deletions(-) create mode 100644 charts/unifi/1.0.0/docs/CONFIG.md create mode 100644 charts/unifi/1.0.0/docs/CONFIG.md.gotmpl diff --git a/charts/traefik/1.0.4/README.md b/charts/traefik/1.0.4/README.md index 3582e453b47..064ecadbb0a 100644 --- a/charts/traefik/1.0.4/README.md +++ b/charts/traefik/1.0.4/README.md @@ -1,6 +1,6 @@ # Introduction -![Version: 1.0.3](https://img.shields.io/badge/Version-1.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.4.2](https://img.shields.io/badge/AppVersion-2.4.2-informational?style=flat-square) +![Version: 1.0.4](https://img.shields.io/badge/Version-1.0.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.4.2](https://img.shields.io/badge/AppVersion-2.4.2-informational?style=flat-square) A Traefik based Reverse Proxy and Certificate Manager diff --git a/charts/traefik/1.0.4/app-readme.md b/charts/traefik/1.0.4/app-readme.md index e9f33caacb9..a0eee9b953a 100644 --- a/charts/traefik/1.0.4/app-readme.md +++ b/charts/traefik/1.0.4/app-readme.md @@ -1 +1,2 @@ A Traefik based Reverse Proxy and Certificate Manager + diff --git a/charts/unifi/1.0.0/README.md b/charts/unifi/1.0.0/README.md index 045363806ce..216a3fcde8f 100644 --- a/charts/unifi/1.0.0/README.md +++ b/charts/unifi/1.0.0/README.md @@ -1,69 +1,54 @@ -# Unifi Controller +# Introduction -This is a helm chart for [unifi](https://unifi-network.ui.com/). +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 5.14.23](https://img.shields.io/badge/AppVersion-5.14.23-informational?style=flat-square) -**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)** +Ubiquiti Network's Unifi Controller -## TL;DR; +TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation. +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)** -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/grocy -``` +## Source Code + +* +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.truecharts.com/ | common | 1.3.0 | ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `unifi` -```console -helm install --name my-release k8s-at-home/grocy -``` +- Open TrueNAS SCALE +- Go to Apps +- Click "Install" for this specific Apps +- Fill out the configuration form ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `unifi` deployment -```console -helm delete my-release --purge -``` +- Open TrueNAS SCALE +- Go to Apps +- Go to "Installed Apps" +- Expand the menu in the top-right corner of this App +- Click "Remove" for this specific Apps -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release. -## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/grocy/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +## Support -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install grocy \ - --set env.TZ="America/New_York" \ - k8s-at-home/grocy -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install grocy k8s-at-home/grocy --values values.yaml -``` +- See the [Wiki](https://wiki.truecharts.org) +- Open a [issue](https://github.com/truecharts/charts/issues/new/choose) +- Ask a [question](https://github.com/truecharts/charts/discussions) -```yaml -image: - tag: ... -``` - ---- -**NOTE** - -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. - ---- - -## Upgrading an existing Release to a new major version - -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. - -Refer to the library values.yaml for more configuration options. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/unifi/1.0.0/app-readme.md b/charts/unifi/1.0.0/app-readme.md index 1f3a3b0c7f5..85b798d43af 100644 --- a/charts/unifi/1.0.0/app-readme.md +++ b/charts/unifi/1.0.0/app-readme.md @@ -1 +1,2 @@ -The Unifi App is designed to deploy Unifi Controller in a TrueNAS SCALE kubernetes cluster. +Ubiquiti Network's Unifi Controller + diff --git a/charts/unifi/1.0.0/docs/CONFIG.md b/charts/unifi/1.0.0/docs/CONFIG.md new file mode 100644 index 00000000000..cc20c8c78ba --- /dev/null +++ b/charts/unifi/1.0.0/docs/CONFIG.md @@ -0,0 +1,3 @@ +# Configuration Options + +N/A diff --git a/charts/unifi/1.0.0/docs/CONFIG.md.gotmpl b/charts/unifi/1.0.0/docs/CONFIG.md.gotmpl new file mode 100644 index 00000000000..0242e267803 --- /dev/null +++ b/charts/unifi/1.0.0/docs/CONFIG.md.gotmpl @@ -0,0 +1,11 @@ +{{- define "custom.custom.configuration.header" -}} +# Configuration Options +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} + +{{ template "custom.custom.configuration" . }}