[helm-docs] Addopt helm-docs for remaining charts (#660)

* homebridge -> helm-docs

* librespeed -> helmdocs

* node-feature-discovery -> helm-docs

* oauth2-proxy -> helm-docs

* sersock -> helmdocs

* speedtest -> helm-docs

* unifi -> helm-docs

* bump version

* uptimerobot -> helm-docs

* do not install test ser2sock

* Add influxdb dependency

* no default value for externalTrafficPolicy

Co-authored-by: angelnu <git@angelnucom>

.github/ct-install.yaml

@@ -6,6 +6,7 @@ chart-dirs:
 excluded-charts:
 - alertmanager-bot
 - dnsmadeeasy-webhook
+- ser2sock
 - zigbee2mqtt
 chart-repos:
 - bitnami=https://charts.bitnami.com/bitnami

.helmdocsignore

@@ -1,8 +1 @@
-charts/homebridge
-charts/librespeed
-charts/node-feature-discovery
-charts/oauth2-proxy
-charts/ser2sock
-charts/speedtest
-charts/unifi
 charts/uptimerobot

charts/homebridge/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 appVersion: 3.1.0
-version: 1.0.2
+version: 1.0.3
 name: homebridge
 description: A lightweight NodeJS server that emulates the iOS HomeKit API
 type: application

charts/homebridge/README.md.gotmpl

@@ -0,0 +1,145 @@
+{{- define "custom.repository.organization" -}}
+k8s-at-home
+{{- end -}}
+
+{{- define "custom.repository.url" -}}
+https://github.com/k8s-at-home/charts
+{{- end -}}
+
+{{- define "custom.helm.url" -}}
+https://k8s-at-home.com/charts/
+{{- 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/k8s-at-home/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](../common/values.yaml) from the [common library](../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="America/New York" \
+    {{ 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/charts/tree/master/charts/common/)
+
+{{ template "chart.valuesTable" . }}
+{{- end -}}
+
+{{- define "custom.support" -}}
+## Support
+
+- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
+- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
+- Join our [Discord](https://discord.gg/sTMX7Vh) community
+{{- 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" . }}

charts/homebridge/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/charts/tree/master/charts/common/README.md#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).
+
+### [1.0.3]
+
+#### Added
+
+- N/A
+
+#### Changed
+
+- Use helm-docs
+
+#### Removed
+
+- N/A
+
+[1.0.3]: #1.0.3
+{{- end -}}

charts/homebridge/README_CONFIG.md.gotmpl

@@ -0,0 +1,9 @@
+{{- define "custom.custom.configuration.header" -}}
+## Custom configuration
+{{- end -}}
+
+{{- define "custom.custom.configuration" -}}
+{{ template "custom.custom.configuration.header" . }}
+
+N/A
+{{- end -}}

charts/homebridge/values.yaml

@@ -3,29 +3,39 @@
 replicaCount: 1
 
 image:
+  # -- Image repository
   repository: oznu/homebridge
+  # -- Image pull policy
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
+  # Possible values listed [here](https://hub.docker.com/r/oznu/homebridge/tags)
   tag: "3.1.0"
 
+# -- Secrets to use when pulling the image
 imagePullSecrets: []
+
 nameOverride: ""
 fullnameOverride: ""
 
-# upgrade strategy type (e.g. Recreate or RollingUpdate)
+# -- Specifies the strategy used to replace old Pods by new ones
 strategyType: Recreate
 
+# -- Specify the container timezone
 timezone: "UTC"
+# -- process userID the instance should run as
 puid: 1000
+# -- process groupID the instance should run as
 pgid: 1000
 
 config:
+  # -- Enable the Homebridge UI plugin
   enableUI: true
+  # -- Additional Homebridge plugins to install at container startup such as `homebridge-hue`
   plugins: []
-    # - homebridge-hue
+  # -- Additional Alpine packages to install at container statup such as `bash`
   additionalPackages: []
-    # - bash
 
+# -- Extra ENV vars to pass to the homebridge container
 extraEnvs: []
 
 serviceAccount:
@@ -37,6 +47,7 @@ serviceAccount:
   # If not set and create is true, a name is generated using the fullname template
   name: ""
 
+# -- Key-value pairs to add as pod annotations
 podAnnotations: {}
 
 podSecurityContext: {}
@@ -51,60 +62,87 @@ securityContext: {}
   # runAsUser: 1000
 
 service:
+  # -- Kubernetes service type for the homebridge GUI
   type: ClusterIP
   homebridgePort: 51826
+  # -- Kubernetes port where the homebridge GUI is exposed
   httpPort: 8080
+  # -- Service annotations for the homebridge GUI
+  annotations: {}
+  # -- (string) Cluster IP for the homebridge GUI
+  clusterIP:
+  # -- (string) External IPs for the homebridge GUI
+  externalIPs:
+  # -- (string) Loadbalancer IP for the homebridge GUI
+  loadBalancerIP:
+  # -- (string) Loadbalancer client IP restriction range for the homebridge GUI
+  loadBalancerSourceRanges:
+  # -- (string) Loadbalancer externalTrafficPolicy
+  externalTrafficPolicy:
+  # -- (int) nodePort to listen on for the homebridge GUI
+  nodePort:
 
 ingress:
+  # -- Enables Ingress
   enabled: false
+  # -- Ingress annotations
   annotations: {}
-    # kubernetes.io/ingress.class: nginx
-    # kubernetes.io/tls-acme: "true"
+  # -- Ingress path
   path: /
+  # -- Ingress accepted hostnames
   hosts:
     - chart-example.local
+  # -- Ingress TLS configuration
   tls: []
   #  - secretName: chart-example-tls
   #    hosts:
   #      - chart-example.local
 
+# -- Enable hostNetwork - needed for discovery to work
 hostNetwork: false
 
 persistence:
+  # -- Use persistent volume to store data
   enabled: true
-  ## homebridge data Persistent Volume Storage Class
-  ## If defined, storageClassName: <storageClass>
-  ## If set to "-", storageClassName: "", which disables dynamic provisioning
-  ## If undefined (the default) or set to null, no storageClassName spec is
-  ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
-  ##   GKE, AWS & OpenStack)
-  ##
-  # storageClass: "-"
-  ##
-  ## If you want to reuse an existing claim, you can pass the name of the PVC using
-  ## the existingClaim variable
-  # existingClaim: your-claim
+  # -- (string) Type of persistent volume claim
+  storageClass:
+  # -- (string) Use an existing PVC to persist data
+  existingClaim:
+  # -- Persistence access modes
   accessMode: ReadWriteOnce
+  # -- Size of persistent volume claim
   size: 1Gi
-  ## Do not delete the pvc upon helm uninstall
+  # -- Do not delete the pvc upon helm uninstall
   skipuninstall: false
 
 probes:
   liveness:
+    # -- Use the livenessProbe?
     enabled: true
+    # -- Specify liveness `initialDelaySeconds` parameter for the deployment
     initialDelaySeconds: 60
+    # -- Specify liveness `failureThreshold` parameter for the deployment
     failureThreshold: 5
+    # -- Specify liveness `timeoutSeconds` parameter for the deployment
     timeoutSeconds: 10
   readiness:
+    # -- Use the readinessProbe?
     enabled: true
+    # -- Specify readiness `initialDelaySeconds` parameter for the deployment
     initialDelaySeconds: 60
+    # -- Specify readiness `failureThreshold` parameter for the deployment
     failureThreshold: 5
+    # -- Specify readiness `timeoutSeconds` parameter for the deployment
     timeoutSeconds: 10
   startup:
+    # -- Use the startupProbe? (new in kubernetes 1.16)
     enabled: false
+    # -- Specify startup `failureThreshold` parameter for the deployment
     failureThreshold: 30
+    # -- Specify startup `periodSeconds` parameter for the deployment
     periodSeconds: 10
 
+# -- CPU/Memory resource requests/limits or the homebridge GUI
 resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little
@@ -117,8 +155,11 @@ resources: {}
   #   cpu: 100m
   #   memory: 128Mi
 
+# -- Node labels for pod assignment or the homebridge GUI
 nodeSelector: {}
 
+# -- Toleration labels for pod assignment or the homebridge GUI
 tolerations: []
 
+# -- Affinity settings for pod assignment or the homebridge GUI
 affinity: {}

charts/librespeed/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: 1.0.6-12
 description: Librespeed is a HTML5 webpage to test upload and download speeds
 name: librespeed
-version: 2.0.0
+version: 2.0.1
 keywords:
   - librespeed
 home: https://github.com/k8s-at-home/charts/tree/master/charts/librespeed