From f8068fbc62eb1f5d2b501609707c5810ad255b24 Mon Sep 17 00:00:00 2001 From: Camila Macedo Date: Sun, 10 Nov 2024 08:08:29 +0000 Subject: [PATCH] (helm/v1-alpha): add missed info to chart values When we rebase with the latest changes those infos to clarify the usage of the options get lost. In this commit we are introducing the missed info to help users know how to use the chart --- .../scaffolds/internal/templates/values.go | 17 ++++++++++++++--- .../dist/chart/values.yaml | 17 ++++++++++++++--- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/values.go b/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/values.go index 202a4a5a12e..d3a533411fa 100644 --- a/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/values.go +++ b/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/values.go @@ -109,15 +109,27 @@ rbac: # [CRDs]: To enable the CRDs crd: + # This option determines whether the CRDs are included + # in the installation process. enable: true + + # Enabling this option adds the "helm.sh/resource-policy": keep + # annotation to the CRD, ensuring it remains installed even when + # the Helm release is uninstalled. + # NOTE: Removing the CRDs will also remove all cert-manager CR(s) + # (Certificates, Issuers, ...) due to garbage collection. keep: true -# [METRICS]: Set to true to generate manifests for exporting metrics +# [METRICS]: Set to true to generate manifests for exporting metrics. +# To disable metrics export set false, and ensure that the +# ControllerManager argument "--metrics-bind-address=:8443" is removed. metrics: enable: true - {{ if .Webhooks }} # [WEBHOOKS]: Webhooks configuration +# The following configuration is automatically generated from the manifests +# generated by controller-gen. To update run 'make manifests' and +# the edit command with the '--force' flag webhook: enable: true services: @@ -160,7 +172,6 @@ webhook: {{- end }} {{- end }} {{ end }} - # [PROMETHEUS]: To enable a ServiceMonitor to export metrics to Prometheus set true prometheus: enable: false diff --git a/testdata/project-v4-with-plugins/dist/chart/values.yaml b/testdata/project-v4-with-plugins/dist/chart/values.yaml index 1cb9c14d0df..7e928bd3e50 100644 --- a/testdata/project-v4-with-plugins/dist/chart/values.yaml +++ b/testdata/project-v4-with-plugins/dist/chart/values.yaml @@ -49,15 +49,27 @@ rbac: # [CRDs]: To enable the CRDs crd: + # This option determines whether the CRDs are included + # in the installation process. enable: true + + # Enabling this option adds the "helm.sh/resource-policy": keep + # annotation to the CRD, ensuring it remains installed even when + # the Helm release is uninstalled. + # NOTE: Removing the CRDs will also remove all cert-manager CR(s) + # (Certificates, Issuers, ...) due to garbage collection. keep: true -# [METRICS]: Set to true to generate manifests for exporting metrics +# [METRICS]: Set to true to generate manifests for exporting metrics. +# To disable metrics export set false, and ensure that the +# ControllerManager argument "--metrics-bind-address=:8443" is removed. metrics: enable: true - # [WEBHOOKS]: Webhooks configuration +# The following configuration is automatically generated from the manifests +# generated by controller-gen. To update run 'make manifests' and +# the edit command with the '--force' flag webhook: enable: true services: @@ -79,7 +91,6 @@ webhook: resources: - memcacheds - # [PROMETHEUS]: To enable a ServiceMonitor to export metrics to Prometheus set true prometheus: enable: false