Skip to content

Commit f8068fb

Browse files
(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
1 parent 6bf7566 commit f8068fb

File tree

2 files changed

+28
-6
lines changed
  • pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates
  • testdata/project-v4-with-plugins/dist/chart

2 files changed

+28
-6
lines changed

pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/values.go

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,15 +109,27 @@ rbac:
109109
110110
# [CRDs]: To enable the CRDs
111111
crd:
112+
# This option determines whether the CRDs are included
113+
# in the installation process.
112114
enable: true
115+
116+
# Enabling this option adds the "helm.sh/resource-policy": keep
117+
# annotation to the CRD, ensuring it remains installed even when
118+
# the Helm release is uninstalled.
119+
# NOTE: Removing the CRDs will also remove all cert-manager CR(s)
120+
# (Certificates, Issuers, ...) due to garbage collection.
113121
keep: true
114122
115-
# [METRICS]: Set to true to generate manifests for exporting metrics
123+
# [METRICS]: Set to true to generate manifests for exporting metrics.
124+
# To disable metrics export set false, and ensure that the
125+
# ControllerManager argument "--metrics-bind-address=:8443" is removed.
116126
metrics:
117127
enable: true
118-
119128
{{ if .Webhooks }}
120129
# [WEBHOOKS]: Webhooks configuration
130+
# The following configuration is automatically generated from the manifests
131+
# generated by controller-gen. To update run 'make manifests' and
132+
# the edit command with the '--force' flag
121133
webhook:
122134
enable: true
123135
services:
@@ -160,7 +172,6 @@ webhook:
160172
{{- end }}
161173
{{- end }}
162174
{{ end }}
163-
164175
# [PROMETHEUS]: To enable a ServiceMonitor to export metrics to Prometheus set true
165176
prometheus:
166177
enable: false

testdata/project-v4-with-plugins/dist/chart/values.yaml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,27 @@ rbac:
4949

5050
# [CRDs]: To enable the CRDs
5151
crd:
52+
# This option determines whether the CRDs are included
53+
# in the installation process.
5254
enable: true
55+
56+
# Enabling this option adds the "helm.sh/resource-policy": keep
57+
# annotation to the CRD, ensuring it remains installed even when
58+
# the Helm release is uninstalled.
59+
# NOTE: Removing the CRDs will also remove all cert-manager CR(s)
60+
# (Certificates, Issuers, ...) due to garbage collection.
5361
keep: true
5462

55-
# [METRICS]: Set to true to generate manifests for exporting metrics
63+
# [METRICS]: Set to true to generate manifests for exporting metrics.
64+
# To disable metrics export set false, and ensure that the
65+
# ControllerManager argument "--metrics-bind-address=:8443" is removed.
5666
metrics:
5767
enable: true
5868

59-
6069
# [WEBHOOKS]: Webhooks configuration
70+
# The following configuration is automatically generated from the manifests
71+
# generated by controller-gen. To update run 'make manifests' and
72+
# the edit command with the '--force' flag
6173
webhook:
6274
enable: true
6375
services:
@@ -79,7 +91,6 @@ webhook:
7991
resources:
8092
- memcacheds
8193

82-
8394
# [PROMETHEUS]: To enable a ServiceMonitor to export metrics to Prometheus set true
8495
prometheus:
8596
enable: false

0 commit comments

Comments
 (0)