generate helm-docs for unifi chart

charts/unifi-controller/README.md

@@ -0,0 +1,48 @@
+# unifi-controller
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 7.3.83](https://img.shields.io/badge/AppVersion-7.3.83-informational?style=flat-square)
+
+A Helm chart for the Unifi Controller
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| config.jvmMemory.limit | string | `"default"` | Integer value in MB or `default` for memory limit for JVM |
+| config.jvmMemory.startup | string | `"default"` | Integer value in MB or `default` for startup memory for JVM |
+| config.timezone | string | `"Etc/UTC"` | Timezone - see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"quay.io/linuxserver.io/unifi-controller"` |  |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"unifi-controller.local"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| persistence.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.annotations | object | `{}` |  |
+| persistence.enabled | bool | `false` |  |
+| persistence.existingClaim | string | `""` |  |
+| persistence.size | string | `"1Gi"` |  |
+| persistence.storageClass | string | `""` |  |
+| podAnnotations | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.annotations | object | `{}` |  |
+| service.combinedProtocols | bool | `true` | Use the same service for TCP and UDP ports - set to disabled if using a LoadBalancer with MetalLB |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

charts/unifi-controller/values.yaml

@@ -5,7 +5,7 @@
 image:
   repository: quay.io/linuxserver.io/unifi-controller
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
 imagePullSecrets: []
@@ -13,9 +13,12 @@ nameOverride: ""
 fullnameOverride: ""
 
 config:
+  # -- Timezone - see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
   timezone: Etc/UTC
   jvmMemory:
+    # -- Integer value in MB or `default` for startup memory for JVM
     startup: default
+    # -- Integer value in MB or `default` for memory limit for JVM
     limit: default
 
 persistence:
@@ -27,12 +30,11 @@ persistence:
   size: 1Gi
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template
-  # If not set and create is true, a name is generated using the fullname template
   name: ""
 
 podAnnotations: {}
@@ -50,7 +52,7 @@ securityContext: {}
 
 service:
   type: ClusterIP
-  # Use the same service for TCP and UDP ports
+  # -- Use the same service for TCP and UDP ports - set to disabled if using a LoadBalancer with MetalLB
   combinedProtocols: true
   annotations: {}