Publish docs updates
Signed-off-by: Ornias1993 <Ornias1993@users.noreply.github.com>
This commit is contained in:
Ornias1993
committed by
kjeld Schouten-Lebbing
kjeld Schouten-Lebbing
parent
faad17c656
commit
bd80fa6962
@@ -1,6 +1,6 @@
|
||||
# Introduction
|
||||
|
||||
  
|
||||
  
|
||||
|
||||
A Traefik based Reverse Proxy and Certificate Manager
|
||||
|
||||
|
||||
@@ -1 +1,2 @@
|
||||
A Traefik based Reverse Proxy and Certificate Manager
|
||||
|
||||
|
||||
@@ -1,69 +1,54 @@
|
||||
# Unifi Controller
|
||||
# Introduction
|
||||
|
||||
This is a helm chart for [unifi](https://unifi-network.ui.com/).
|
||||
  
|
||||
|
||||
**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
|
||||
|
||||
* <https://github.com/truecharts/charts/tree/master/charts/unifi>
|
||||
* <https://github.com/jacobalberty/unifi-docker>
|
||||
* <https://unifi-network.ui.com>
|
||||
|
||||
## 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)
|
||||
|
||||
@@ -1 +1,2 @@
|
||||
The Unifi App is designed to deploy Unifi Controller in a TrueNAS SCALE kubernetes cluster.
|
||||
Ubiquiti Network's Unifi Controller
|
||||
|
||||
|
||||
3
charts/unifi/1.0.0/docs/CONFIG.md
Normal file
3
charts/unifi/1.0.0/docs/CONFIG.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Configuration Options
|
||||
|
||||
N/A
|
||||
11
charts/unifi/1.0.0/docs/CONFIG.md.gotmpl
Normal file
11
charts/unifi/1.0.0/docs/CONFIG.md.gotmpl
Normal file
@@ -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" . }}
|
||||
Reference in New Issue
Block a user