docs: add autodocs generation for helm values

Summary

Restructure comments section in chart/values.yaml to support helm autodocs, include a README.md.gotpl to re-create README.md using:

docker run -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.5.0 --dry-run -s file -t .gitlab-ci/README.md.gotmpl

Eventually add this to some pre-commit hook.

chart/templates/gitlab/helmrelease.yaml

@@ -52,13 +52,13 @@ spec:
     postgresql:
       install: false
     {{- end }} 
-    {{- if .Values.addons.gitlab.objectstorage.endpoint }}
+    {{- if .Values.addons.gitlab.objectStorage.endpoint }}
     registry:      
       storage:
         secret: gitlab-object-storage
         key: registry
     {{- end }}
-    {{- if .Values.addons.gitlab.objectstorage.endpoint }}
+    {{- if .Values.addons.gitlab.objectStorage.endpoint }}
     gitlab:
       task-runner:        
         backups:
@@ -74,7 +74,7 @@ spec:
           name: {{ .Values.addons.gitlab.hostnames.gitlab }} 
         registry:
           name: {{ .Values.addons.gitlab.hostnames.registry }}
-      {{- if .Values.addons.gitlab.objectstorage.endpoint }}
+      {{- if .Values.addons.gitlab.objectStorage.endpoint }}
       minio:
         enabled: false
       {{- end }}
@@ -88,15 +88,15 @@ spec:
           secret: gitlab-database
           key: PGPASSWORD
       {{- end }}
-      {{- if .Values.addons.gitlab.objectstorage.endpoint }}
+      {{- if .Values.addons.gitlab.objectStorage.endpoint }}
       registry:
-        {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-        bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-registry
+        {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+        bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-registry
         {{- else }}
         bucket: gitlab-registry
         {{- end }}
       {{- end }}
-      {{- if or .Values.addons.gitlab.sso.enabled .Values.addons.gitlab.objectstorage.endpoint }}
+      {{- if or .Values.addons.gitlab.sso.enabled .Values.addons.gitlab.objectStorage.endpoint }}
       appConfig:
       {{- end }}
         {{- if .Values.addons.gitlab.sso.enabled }}
@@ -119,10 +119,10 @@ spec:
               - secret: gitlab-sso-provider
                 key: gitlab-sso.json
         {{- end }}
-        {{- if .Values.addons.gitlab.objectstorage.endpoint }}
+        {{- if .Values.addons.gitlab.objectStorage.endpoint }}
         lfs:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-lfs
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-lfs
           {{- else }}
           bucket: gitlab-lfs
           {{- end }}
@@ -130,8 +130,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         artifacts:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-artifacts
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-artifacts
           {{- else }}
           bucket: gitlab-artifacts
           {{- end }}
@@ -139,8 +139,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         uploads:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-uploads
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-uploads
           {{- else }}
           bucket: gitlab-uploads
           {{- end }}
@@ -148,8 +148,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         packages:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-packages
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-packages
           {{- else }}
           bucket: gitlab-packages
           {{- end }}
@@ -157,8 +157,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         externalDiffs:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-mr-diffs
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-mr-diffs
           {{- else }}
           bucket: gitlab-mr-diffs
           {{- end }}
@@ -166,8 +166,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         terraformState:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-terraform-state
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-terraform-state
           {{- else }}
           bucket: gitlab-terraform-state
           {{- end }}
@@ -175,8 +175,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         dependencyProxy:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-dependency-proxy
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-dependency-proxy
           {{- else }}
           bucket: gitlab-dependency-proxy
           {{- end }}
@@ -184,8 +184,8 @@ spec:
             secret: gitlab-object-storage
             key: rails
         pseudonymizer:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-pseudo
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-pseudo
           {{- else }}
           bucket: gitlab-pseudo
           {{- end }}
@@ -193,13 +193,13 @@ spec:
             secret: gitlab-object-storage
             key: rails
         backups:
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          bucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-backup
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          bucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-backup
           {{- else }}
           bucket: gitlab-backup
           {{- end }}
-          {{- if .Values.addons.gitlab.objectstorage.bucketPrefix }}
-          tmpBucket: {{ .Values.addons.gitlab.objectstorage.bucketPrefix }}-gitlab-backup-tmp
+          {{- if .Values.addons.gitlab.objectStorage.bucketPrefix }}
+          tmpBucket: {{ .Values.addons.gitlab.objectStorage.bucketPrefix }}-gitlab-backup-tmp
           {{- else }}
           tmpBucket: gitlab-backup-tmp
           {{- end }}