feat: move helm docs into values files (#2281)

Signed-off-by: Griffin <prakritimandal611@gmail.com>
keptn · Oct 24, 2023 · bd1a37b · bd1a37b
1 parent bffbaf2
commit bd1a37b
Show file tree

Hide file tree

Showing 13 changed files with 287 additions and 327 deletions.
diff --git a/.github/scripts/generate-helm-docs.sh b/.github/scripts/generate-helm-docs.sh
@@ -28,18 +28,12 @@ echo "Generating Keptn readme now..."
 readme-generator --values=./chart/values.yaml --readme=./chart/README.md
 
 echo "Generating lifecycle operator readme now..."
-cat ./lifecycle-operator/chart/values.yaml ./lifecycle-operator/chart/doc.yaml > ./lifecycle-operator/chart/rendered.yaml
-readme-generator --values=./lifecycle-operator/chart/rendered.yaml --readme=./lifecycle-operator/chart/README.md
-rm ./lifecycle-operator/chart/rendered.yaml
+readme-generator --values=./lifecycle-operator/chart/values.yaml --readme=./lifecycle-operator/chart/README.md
 
 echo "Generating keptn cert manager readme now..."
-cat ./klt-cert-manager/chart/values.yaml ./klt-cert-manager/chart/doc.yaml > ./klt-cert-manager/chart/rendered.yaml
-readme-generator --values=./klt-cert-manager/chart/rendered.yaml --readme=./klt-cert-manager/chart/README.md
-rm ./klt-cert-manager/chart/rendered.yaml
+readme-generator --values=./klt-cert-manager/chart/values.yaml --readme=./klt-cert-manager/chart/README.md
 
 echo "Generating keptn metrics operator readme now..."
-cat ./metrics-operator/chart/values.yaml ./metrics-operator/chart/doc.yaml > ./metrics-operator/chart/rendered.yaml
-readme-generator --values=./metrics-operator/chart/rendered.yaml --readme=./metrics-operator/chart/README.md
-rm ./metrics-operator/chart/rendered.yaml
+readme-generator --values=./metrics-operator/chart/values.yaml --readme=./metrics-operator/chart/README.md
 
 # Please be aware, the readme file needs to exist and needs to have a Parameters section, as only this section will be re-generated
diff --git a/.github/workflows/validate-helm-chart.yml b/.github/workflows/validate-helm-chart.yml
@@ -47,8 +47,7 @@ jobs:
         run: |
           cd ./${{ matrix.config.path }}/
           cp ./README.md ./README-old.md
-          cat ./values.yaml ./doc.yaml > ./rendered.yaml
-          readme-generator --values=./rendered.yaml --readme=./README.md
+          readme-generator --values=./values.yaml --readme=./README.md
           if ! cmp --quiet ./README-old.md ./README.md; then
             echo "The Helm values for ${{ matrix.config.name }} have changes that are not reflected in the readme."
             echo "Please use ./.github/scripts/generate-helm-docs.sh to re-generate the docs."

diff --git a/chart/doc.yaml b/chart/doc.yaml
diff --git a/chart/values.yaml b/chart/values.yaml
@@ -1,6 +1,10 @@
+## @section Keptn
 certManager:
+## @param certManager.enabled Enable this value to install Keptn Certificate Manager
   enabled: true
 lifecycleOperator:
+## @param lifecycleOperator.enabled Enable this value to install Keptn Lifecycle Operator
   enabled: true
 metricsOperator:
+## @param metricsOperator.enabled Enable this value to install Keptn Metrics Operator
   enabled: true
diff --git a/klt-cert-manager/chart/README.md b/klt-cert-manager/chart/README.md
@@ -10,8 +10,8 @@ resource.
 
 | Name                        | Description                                    | Value |
 | --------------------------- | ---------------------------------------------- | ----- |
-| `replicas`                  | customize number of replicas                   | `1`   |
 | `nodeSelector`              | specify custom node selectors for cert manager | `{}`  |
+| `replicas`                  | customize number of replicas                   | `1`   |
 | `tolerations`               | customize tolerations for cert manager         | `[]`  |
 | `topologySpreadConstraints` | add topology constraints for cert manager      | `[]`  |
 
@@ -20,11 +20,11 @@ resource.
 | Name                       | Description                                                               | Value                                |
 | -------------------------- | ------------------------------------------------------------------------- | ------------------------------------ |
 | `containerSecurityContext` | Sets security context for the cert manager                                |                                      |
+| `env.labelSelectorKey`     | specify the label selector to find resources to generate certificates for | `keptn.sh/inject-cert`               |
+| `env.labelSelectorValue`   | specify the value for the label selector                                  | `true`                               |
 | `image.repository`         | specify repo for manager image                                            | `ghcr.io/keptn/certificate-operator` |
 | `image.tag`                | select tag for manager container                                          | `v1.1.0`                             |
 | `imagePullPolicy`          | select image pull policy for manager container                            | `Always`                             |
-| `env.labelSelectorKey`     | specify the label selector to find resources to generate certificates for | `keptn.sh/inject-cert`               |
-| `env.labelSelectorValue`   | specify the value for the label selector                                  | `true`                               |
 | `livenessProbe`            | custom RBAC proxy liveness probe                                          |                                      |
 | `readinessProbe`           | custom manager readiness probe                                            |                                      |
 | `resources`                | custom limits and requests for manager container                          |                                      |
@@ -33,5 +33,5 @@ resource.
 
 | Name                      | Description                            | Value           |
 | ------------------------- | -------------------------------------- | --------------- |
-| `kubernetesClusterDomain` | overrides domain.local                 | `cluster.local` |
 | `imagePullSecrets`        | global value for image registry secret | `[]`            |
+| `kubernetesClusterDomain` | overrides domain.local                 | `cluster.local` |
diff --git a/klt-cert-manager/chart/doc.yaml b/klt-cert-manager/chart/doc.yaml
diff --git a/klt-cert-manager/chart/values.yaml b/klt-cert-manager/chart/values.yaml
@@ -1,3 +1,22 @@
+# yamllint disable rule:line-length
+## @section Keptn Certificate Operator common
+## @param     nodeSelector specify custom node selectors for cert manager
+nodeSelector: {}
+## @param     replicas customize number of replicas
+replicas: 1
+## @param     tolerations customize tolerations for cert manager
+tolerations: []
+## @param     topologySpreadConstraints add topology constraints for cert manager
+topologySpreadConstraints: []
+
+## @section Keptn Certificate Operator controller
+## @extra    containerSecurityContext Sets security context for the cert manager
+## @skip     containerSecurityContext.allowPrivilegeEscalation
+## @skip     containerSecurityContext.capabilities.drop
+## @skip     containerSecurityContext.readOnlyRootFilesystem
+## @skip     containerSecurityContext.runAsGroup
+## @skip     containerSecurityContext.runAsUser
+## @skip     containerSecurityContext.seccompProfile.type
 containerSecurityContext:
   allowPrivilegeEscalation: false
   capabilities:
@@ -9,34 +28,58 @@ containerSecurityContext:
   seccompProfile:
     type: RuntimeDefault
 env:
+## @param     env.labelSelectorKey specify the label selector to find resources to generate certificates for
   labelSelectorKey: keptn.sh/inject-cert
+## @param     env.labelSelectorValue specify the value for the label selector
   labelSelectorValue: "true"
 image:
+## @param     image.repository specify repo for manager image
   repository: ghcr.io/keptn/certificate-operator
+## @param     image.tag select tag for manager container
   tag: v1.1.0
+## @param     imagePullPolicy select image pull policy for manager container
 imagePullPolicy: Always
+
+## @extra     livenessProbe custom RBAC proxy liveness probe
+## @skip     livenessProbe.httpGet.path
+## @skip     livenessProbe.httpGet.port
+## @skip     livenessProbe.initialDelaySeconds
+## @skip     livenessProbe.periodSeconds
 livenessProbe:
   httpGet:
     path: /healthz
     port: 8081
   initialDelaySeconds: 15
   periodSeconds: 20
+
+## @extra    readinessProbe custom manager readiness probe
+## @skip     readinessProbe.httpGet.path
+## @skip     readinessProbe.httpGet.port
+## @skip     readinessProbe.initialDelaySeconds
+## @skip     readinessProbe.periodSeconds
 readinessProbe:
   httpGet:
     path: /readyz
     port: 8081
   initialDelaySeconds: 5
   periodSeconds: 10
+
+## @extra    resources custom limits and requests for manager container
+## @skip     resources.limits.cpu
+## @skip     resources.limits.memory
+## @skip     resources.requests.cpu
+## @skip     resources.requests.memory
 resources:
   limits:
     cpu: 25m
     memory: 64Mi
   requests:
     cpu: 5m
     memory: 16Mi
-nodeSelector: {}
-replicas: 1
-tolerations: []
-topologySpreadConstraints: []
+
+## @section Global
+## Current available parameters: kubernetesClusterDomain, imagePullSecrets, schedulingGatesEnabled
+## @param  imagePullSecrets global value for image registry secret
 imagePullSecrets: []
+## @param  kubernetesClusterDomain overrides domain.local
 kubernetesClusterDomain: cluster.local