Automatically generate README from helm values

[Teko012]

Ideally, the README should be automatically generated by the CI.

Some of the possible options for tooling:

• https://github.com/norwoodj/helm-docs
• https://github.com/kubepack/chart-doc-gen
• https://github.com/bitnami-labs/readme-generator-for-helm
• https://github.com/rapidsai/frigate

Once the tool has been decided, the values.yaml can be reformatted accordingly.

[Teko012]

I went through the chart to see what are the missing values in values.yaml, which need to be added first (I was only looking if something can be supplied as value but missing from the values.yaml file).

The values that are missing from the README currently and from the values.yaml:

basicAuthSecretName
fullnameOverride
nameOverride

These are in the README, but not mentioned in the values.yaml:

command
config
environment
ingress.apiVersion
orgWhitelist
service.annotations
service.loadBalancerSourceRanges

All of this will need to be added to the values.yaml file. I haven't checked if there are any that are still mentioned in the README, and not in the code, but I don't think that matters, and it will be fixed when it gets auto generated.

Related:
#231

[Teko012]

I think readme-generator-for-helm might be better for this, but helm-docs could work too, both lets you specify types as well.

[Teko012]

We should also unify what is declared by default and what is not: #238 We will have to check if declaring it as an empty value will change some behaviour or not.

[GMartinez-Sisti]

I've been using norwoodj/helm-docs for this and it works very well. The idea is that values.yaml is your source of truth and every key should have a default value to be documented along with the type. Add a CI job to PRs to ensure the README is always updated and it does wonders.

[GMartinez-Sisti]

I'll take this one.