Skip to content

Commit b6963ca

Browse files
committed
helm: remove useless "+docs:property" markers
These markers are only meant for properties that don't have a default value.
1 parent 0849c60 commit b6963ca

File tree

2 files changed

+79
-63
lines changed

2 files changed

+79
-63
lines changed

deploy/charts/venafi-kubernetes-agent/README.md

Lines changed: 79 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -22,71 +22,69 @@ If you do not have one, you can sign up for a free trial now at:
2222
> true
2323
> ```
2424
25-
-- Enable the metrics server.
25+
Enable the metrics server.
2626
If false, the metrics server will be disabled and the other metrics fields below will be ignored.
2727
#### **metrics.podmonitor.enabled** ~ `bool`
2828
> Default value:
2929
> ```yaml
3030
> false
3131
> ```
3232
33-
-- Create a PodMonitor to add the metrics to Prometheus, if you are using Prometheus Operator.
34-
See https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PodMonitor
33+
Create a PodMonitor to add the metrics to Prometheus, if you are using Prometheus Operator. See https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PodMonitor
3534
#### **metrics.podmonitor.namespace** ~ `string`
3635
37-
-- The namespace that the pod monitor should live in.
38-
Defaults to the venafi-kubernetes-agent namespace.
36+
The namespace that the pod monitor should live in. Defaults to the venafi-kubernetes-agent namespace.
3937
4038
#### **metrics.podmonitor.prometheusInstance** ~ `string`
4139
> Default value:
4240
> ```yaml
4341
> default
4442
> ```
4543
46-
-- Specifies the `prometheus` label on the created PodMonitor.
47-
This is used when different Prometheus instances have label selectors matching different PodMonitors.
44+
Specifies the `prometheus` label on the created PodMonitor. This is used when different Prometheus instances have label selectors matching different PodMonitors.
4845
#### **metrics.podmonitor.interval** ~ `string`
4946
> Default value:
5047
> ```yaml
5148
> 60s
5249
> ```
5350
54-
-- The interval to scrape metrics.
51+
The interval to scrape metrics.
5552
#### **metrics.podmonitor.scrapeTimeout** ~ `string`
5653
> Default value:
5754
> ```yaml
5855
> 30s
5956
> ```
6057
61-
-- The timeout before a metrics scrape fails.
58+
The timeout before a metrics scrape fails.
6259
#### **metrics.podmonitor.labels** ~ `object`
6360
> Default value:
6461
> ```yaml
6562
> {}
6663
> ```
6764
68-
-- Additional labels to add to the PodMonitor.
65+
Additional labels to add to the PodMonitor.
66+
6967
#### **metrics.podmonitor.annotations** ~ `object`
7068
> Default value:
7169
> ```yaml
7270
> {}
7371
> ```
7472
75-
-- Additional annotations to add to the PodMonitor.
73+
Additional annotations to add to the PodMonitor.
7674
#### **metrics.podmonitor.honorLabels** ~ `bool`
7775
> Default value:
7876
> ```yaml
7977
> false
8078
> ```
8179
82-
-- Keep labels from scraped data, overriding server-side labels.
80+
Keep labels from scraped data, overriding server-side labels.
8381
#### **metrics.podmonitor.endpointAdditionalProperties** ~ `object`
8482
> Default value:
8583
> ```yaml
8684
> {}
8785
> ```
8886
89-
-- EndpointAdditionalProperties allows setting additional properties on the endpoint such as relabelings, metricRelabelings etc.
87+
EndpointAdditionalProperties allows setting additional properties on the endpoint such as relabelings, metricRelabelings etc.
9088
9189
For example:
9290
@@ -100,85 +98,95 @@ endpointAdditionalProperties:
10098
```
10199
102100
101+
103102
#### **replicaCount** ~ `number`
104103
> Default value:
105104
> ```yaml
106105
> 1
107106
> ```
108107
109-
-- default replicas, do not scale up
108+
default replicas, do not scale up
110109
#### **image.repository** ~ `string`
111110
> Default value:
112111
> ```yaml
113112
> registry.venafi.cloud/venafi-agent/venafi-agent
114113
> ```
115114
116-
-- Default to Open Source image repository
115+
The container image for the Venafi Enhanced Issuer manager.
116+
117117
#### **image.pullPolicy** ~ `string`
118118
> Default value:
119119
> ```yaml
120120
> IfNotPresent
121121
> ```
122122
123-
-- Defaults to only pull if not already present
123+
Kubernetes imagePullPolicy on Deployment.
124+
125+
#### **image.tag** ~ `string`
126+
> Default value:
127+
> ```yaml
128+
> v0.0.0
129+
> ```
130+
131+
Overrides the image tag whose default is the chart appVersion.
132+
124133
#### **imagePullSecrets** ~ `array`
125134
> Default value:
126135
> ```yaml
127136
> []
128137
> ```
129138
130-
-- Specify image pull credentials if using a private registry
131-
example: - name: my-pull-secret
139+
Specify image pull credentials if using a private registry example: - name: my-pull-secret
132140
#### **nameOverride** ~ `string`
133141
> Default value:
134142
> ```yaml
135143
> ""
136144
> ```
137145
138-
-- Helm default setting to override release name, usually leave blank.
146+
Helm default setting to override release name, usually leave blank.
139147
#### **fullnameOverride** ~ `string`
140148
> Default value:
141149
> ```yaml
142150
> ""
143151
> ```
144152
145-
-- Helm default setting, use this to shorten the full install name.
153+
Helm default setting, use this to shorten the full install name.
146154
#### **serviceAccount.create** ~ `bool`
147155
> Default value:
148156
> ```yaml
149157
> true
150158
> ```
151159
152-
-- Specifies whether a service account should be created
160+
Specifies whether a service account should be created
153161
#### **serviceAccount.annotations** ~ `object`
154162
> Default value:
155163
> ```yaml
156164
> {}
157165
> ```
158166
159-
-- Annotations YAML to add to the service account
167+
Annotations YAML to add to the service account
160168
#### **serviceAccount.name** ~ `string`
161169
> Default value:
162170
> ```yaml
163171
> ""
164172
> ```
165173
166-
-- The name of the service account to use.
174+
The name of the service account to use.
167175
If blank and `serviceAccount.create` is true, a name is generated using the fullname template of the release.
168176
#### **podAnnotations** ~ `object`
169177
> Default value:
170178
> ```yaml
171179
> {}
172180
> ```
173181
174-
-- Additional YAML annotations to add the the pod.
182+
Additional YAML annotations to add the the pod.
175183
#### **podSecurityContext** ~ `object`
176184
> Default value:
177185
> ```yaml
178186
> {}
179187
> ```
180188
181-
-- Optional Pod (all containers) `SecurityContext` options, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod.
189+
Optional Pod (all containers) `SecurityContext` options, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod.
182190
#### **http_proxy** ~ `string`
183191
184192
Configures the HTTP_PROXY environment variable where a HTTP proxy is required.
@@ -227,44 +235,46 @@ Configures the NO_PROXY environment variable where a HTTP proxy is required, but
227235
> {}
228236
> ```
229237
230-
-- Embed YAML for nodeSelector settings, see https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/
238+
Embed YAML for nodeSelector settings, see
239+
https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/
231240
#### **tolerations** ~ `array`
232241
> Default value:
233242
> ```yaml
234243
> []
235244
> ```
236245
237-
-- Embed YAML for toleration settings, see https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
246+
Embed YAML for toleration settings, see
247+
https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
238248
#### **affinity** ~ `object`
239249
> Default value:
240250
> ```yaml
241251
> {}
242252
> ```
243253
244-
-- Embed YAML for Node affinity settings, see https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes-using-node-affinity/.
254+
Embed YAML for Node affinity settings, see
255+
https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes-using-node-affinity/.
245256
#### **command** ~ `array`
246257
> Default value:
247258
> ```yaml
248259
> []
249260
> ```
250261
251-
-- Specify the command to run overriding default binary.
262+
Specify the command to run overriding default binary.
252263
#### **extraArgs** ~ `array`
253264
> Default value:
254265
> ```yaml
255266
> []
256267
> ```
257268
258-
-- Specify additional arguments to pass to the agent binary.
269+
Specify additional arguments to pass to the agent binary.
259270
For example `["--strict", "--oneshot"]`
260271
#### **volumes** ~ `array`
261272
> Default value:
262273
> ```yaml
263274
> []
264275
> ```
265276
266-
-- Additional volumes to add to the Venafi Kubernetes Agent container. This is
267-
useful for mounting a custom CA bundle. For example:
277+
Additional volumes to add to the Venafi Kubernetes Agent container. This is useful for mounting a custom CA bundle. For example:
268278
269279
```yaml
270280
volumes:
@@ -285,8 +295,7 @@ In order to create the ConfigMap, you can use the following command:
285295
> []
286296
> ```
287297
288-
-- Additional volume mounts to add to the Venafi Kubernetes Agent container.
289-
This is useful for mounting a custom CA bundle. Any PEM certificate mounted under /etc/ssl/certs will be loaded by the Venafi Kubernetes Agent. For
298+
Additional volume mounts to add to the Venafi Kubernetes Agent container. This is useful for mounting a custom CA bundle. Any PEM certificate mounted under /etc/ssl/certs will be loaded by the Venafi Kubernetes Agent. For
290299
291300
```yaml
292301
example:
@@ -307,82 +316,77 @@ volumeMounts:
307316
> agent-credentials
308317
> ```
309318
310-
-- Name of the secret containing the private key
319+
Name of the secret containing the private key
311320
#### **authentication.secretKey** ~ `string`
312321
> Default value:
313322
> ```yaml
314323
> privatekey.pem
315324
> ```
316325
317-
-- Key name in the referenced secret
326+
Key name in the referenced secret
318327
### Venafi Connection
319328
320329
321-
-- Configure VenafiConnection authentication
330+
Configure VenafiConnection authentication
322331
#### **authentication.venafiConnection.enabled** ~ `bool`
323332
> Default value:
324333
> ```yaml
325334
> false
326335
> ```
327336
328-
-- When set to true, the Venafi Kubernetes Agent will authenticate to
329-
Venafi using the configuration in a VenafiConnection resource. Use `venafiConnection.enabled=true` for [secretless authentication](https://docs.venafi.cloud/vaas/k8s-components/t-install-tlspk-agent/). When set to true, the `authentication.secret` values will be ignored and the. Secret with `authentication.secretName` will _not_ be mounted into the
337+
When set to true, the Venafi Kubernetes Agent will authenticate to. Venafi using the configuration in a VenafiConnection resource. Use `venafiConnection.enabled=true` for [secretless authentication](https://docs.venafi.cloud/vaas/k8s-components/t-install-tlspk-agent/). When set to true, the `authentication.secret` values will be ignored and the. Secret with `authentication.secretName` will _not_ be mounted into the
330338
Venafi Kubernetes Agent Pod.
331339
#### **authentication.venafiConnection.name** ~ `string`
332340
> Default value:
333341
> ```yaml
334342
> venafi-components
335343
> ```
336344
337-
-- The name of a VenafiConnection resource which contains the configuration
338-
for authenticating to Venafi.
345+
The name of a VenafiConnection resource which contains the configuration for authenticating to Venafi.
339346
#### **authentication.venafiConnection.namespace** ~ `string`
340347
> Default value:
341348
> ```yaml
342349
> venafi
343350
> ```
344351
345-
-- The namespace of a VenafiConnection resource which contains the
346-
configuration for authenticating to Venafi.
352+
The namespace of a VenafiConnection resource which contains the configuration for authenticating to Venafi.
347353
#### **config.server** ~ `string`
348354
> Default value:
349355
> ```yaml
350356
> https://api.venafi.cloud/
351357
> ```
352358
353-
-- API URL of the Venafi Control Plane API. For EU tenants, set this value to
354-
https://api.venafi.eu/. If you are using the VenafiConnection authentication method, you must set the API URL using the field `spec.vcp.url` on the
359+
API URL of the Venafi Control Plane API. For EU tenants, set this value to https://api.venafi.eu/. If you are using the VenafiConnection authentication method, you must set the API URL using the field `spec.vcp.url` on the
355360
VenafiConnection resource instead.
356361
#### **config.clientId** ~ `string`
357362
> Default value:
358363
> ```yaml
359364
> ""
360365
> ```
361366
362-
-- The client-id to be used for authenticating with the Venafi Control
363-
Plane. Only useful when using a Key Pair Service Account in the Venafi. Control Plane. You can obtain the cliend ID by creating a Key Pair Service
367+
The client-id to be used for authenticating with the Venafi Control. Plane. Only useful when using a Key Pair Service Account in the Venafi. Control Plane. You can obtain the cliend ID by creating a Key Pair Service
364368
Account in the Venafi Control Plane.
365369
#### **config.period** ~ `string`
366370
> Default value:
367371
> ```yaml
368372
> 0h1m0s
369373
> ```
370374
371-
-- Send data back to the platform every minute unless changed
375+
Send data back to the platform every minute unless changed
372376
#### **config.clusterName** ~ `string`
373377
> Default value:
374378
> ```yaml
375379
> ""
376380
> ```
377381
378-
-- Name for the cluster resource if it needs to be created in Venafi Control Plane
382+
Name for the cluster resource if it needs to be created in Venafi Control Plane
379383
#### **config.clusterDescription** ~ `string`
380384
> Default value:
381385
> ```yaml
382386
> ""
383387
> ```
384388
385-
-- Description for the cluster resource if it needs to be created in Venafi Control Plane
389+
Description for the cluster resource if it needs to be created in Venafi Control Plane
386390
#### **config.ignoredSecretTypes[0]** ~ `string`
387391
> Default value:
388392
> ```yaml
@@ -434,8 +438,7 @@ Account in the Venafi Control Plane.
434438
> false
435439
> ```
436440
437-
-- Enable or disable the PodDisruptionBudget resource, which helps prevent downtime
438-
during voluntary disruptions such as during a Node upgrade.
441+
Enable or disable the PodDisruptionBudget resource, which helps prevent downtime during voluntary disruptions such as during a Node upgrade.
439442
### CRDs
440443
441444
@@ -446,15 +449,35 @@ The CRDs installed by this chart are annotated with "helm.sh/resource-policy: ke
446449
> false
447450
> ```
448451
449-
-- The 'x-kubernetes-validations' annotation is not supported in Kubernetes 1.22 and below.
450-
This annotation is used by CEL, which is a feature introduced in Kubernetes 1.25 that improves how validation is performed. This option allows to force the 'x-kubernetes-validations' annotation to be excluded, even on Kubernetes 1.25+ clusters.
452+
The 'x-kubernetes-validations' annotation is not supported in Kubernetes 1.22 and below. This annotation is used by CEL, which is a feature introduced in Kubernetes 1.25 that improves how validation is performed. This option allows to force the 'x-kubernetes-validations' annotation to be excluded, even on Kubernetes 1.25+ clusters.
453+
#### **crds.keep** ~ `bool`
454+
> Default value:
455+
> ```yaml
456+
> false
457+
> ```
458+
459+
This option makes it so that the "helm.sh/resource-policy": keep annotation is added to the CRD. This will prevent Helm from uninstalling the CRD when the Helm release is uninstalled.
451460
#### **crds.venafiConnection.include** ~ `bool`
452461
> Default value:
453462
> ```yaml
454463
> false
455464
> ```
456465
457-
-- When set to false, the rendered output does not contain the
458-
VenafiConnection CRDs and RBAC. This is useful for when the. Venafi Connection resources are already installed separately.
466+
When set to false, the rendered output does not contain the. VenafiConnection CRDs and RBAC. This is useful for when the. Venafi Connection resources are already installed separately.
467+
#### **podDisruptionBudget.enabled** ~ `bool`
468+
> Default value:
469+
> ```yaml
470+
> false
471+
> ```
472+
#### **podDisruptionBudget.minAvailable** ~ `number`
473+
> Default value:
474+
> ```yaml
475+
> 1
476+
> ```
477+
#### **podDisruptionBudget.maxUnavailable** ~ `number`
478+
> Default value:
479+
> ```yaml
480+
> 1
481+
> ```
459482
460483
<!-- /AUTO-GENERATED -->

0 commit comments

Comments
 (0)