You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: deploy/charts/venafi-kubernetes-agent/README.md
+79-56Lines changed: 79 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,71 +22,69 @@ If you do not have one, you can sign up for a free trial now at:
22
22
> true
23
23
> ```
24
24
25
-
-- Enable the metrics server.
25
+
Enable the metrics server.
26
26
If false, the metrics server will be disabled and the other metrics fields below will be ignored.
27
27
#### **metrics.podmonitor.enabled** ~ `bool`
28
28
> Default value:
29
29
> ```yaml
30
30
> false
31
31
> ```
32
32
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
35
34
#### **metrics.podmonitor.namespace** ~ `string`
36
35
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.
-- 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.
The container image for the Venafi Enhanced Issuer manager.
116
+
117
117
#### **image.pullPolicy** ~ `string`
118
118
> Default value:
119
119
> ```yaml
120
120
> IfNotPresent
121
121
> ```
122
122
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
+
124
133
#### **imagePullSecrets** ~ `array`
125
134
> Default value:
126
135
> ```yaml
127
136
> []
128
137
> ```
129
138
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
132
140
#### **nameOverride** ~ `string`
133
141
> Default value:
134
142
> ```yaml
135
143
> ""
136
144
> ```
137
145
138
-
-- Helm default setting to override release name, usually leave blank.
146
+
Helm default setting to override release name, usually leave blank.
139
147
#### **fullnameOverride** ~ `string`
140
148
> Default value:
141
149
> ```yaml
142
150
> ""
143
151
> ```
144
152
145
-
-- Helm default setting, use this to shorten the full install name.
153
+
Helm default setting, use this to shorten the full install name.
146
154
#### **serviceAccount.create** ~ `bool`
147
155
> Default value:
148
156
> ```yaml
149
157
> true
150
158
> ```
151
159
152
-
-- Specifies whether a service account should be created
160
+
Specifies whether a service account should be created
153
161
#### **serviceAccount.annotations** ~ `object`
154
162
> Default value:
155
163
> ```yaml
156
164
> {}
157
165
> ```
158
166
159
-
-- Annotations YAML to add to the service account
167
+
Annotations YAML to add to the service account
160
168
#### **serviceAccount.name** ~ `string`
161
169
> Default value:
162
170
> ```yaml
163
171
> ""
164
172
> ```
165
173
166
-
-- The name of the service account to use.
174
+
The name of the service account to use.
167
175
If blank and `serviceAccount.create` is true, a name is generated using the fullname template of the release.
168
176
#### **podAnnotations** ~ `object`
169
177
> Default value:
170
178
> ```yaml
171
179
> {}
172
180
> ```
173
181
174
-
-- Additional YAML annotations to add the the pod.
182
+
Additional YAML annotations to add the the pod.
175
183
#### **podSecurityContext** ~ `object`
176
184
> Default value:
177
185
> ```yaml
178
186
> {}
179
187
> ```
180
188
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.
182
190
#### **http_proxy** ~ `string`
183
191
184
192
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
227
235
> {}
228
236
> ```
229
237
230
-
-- Embed YAML for nodeSelector settings, see https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/
-- Specify the command to run overriding default binary.
262
+
Specify the command to run overriding default binary.
252
263
#### **extraArgs** ~ `array`
253
264
> Default value:
254
265
> ```yaml
255
266
> []
256
267
> ```
257
268
258
-
-- Specify additional arguments to pass to the agent binary.
269
+
Specify additional arguments to pass to the agent binary.
259
270
For example `["--strict", "--oneshot"]`
260
271
#### **volumes** ~ `array`
261
272
> Default value:
262
273
> ```yaml
263
274
> []
264
275
> ```
265
276
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:
268
278
269
279
```yaml
270
280
volumes:
@@ -285,8 +295,7 @@ In order to create the ConfigMap, you can use the following command:
285
295
> []
286
296
> ```
287
297
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
-- 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
-- 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.
347
353
#### **config.server** ~ `string`
348
354
> Default value:
349
355
> ```yaml
350
356
> https://api.venafi.cloud/
351
357
> ```
352
358
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
355
360
VenafiConnection resource instead.
356
361
#### **config.clientId** ~ `string`
357
362
> Default value:
358
363
> ```yaml
359
364
> ""
360
365
> ```
361
366
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
364
368
Account in the Venafi Control Plane.
365
369
#### **config.period** ~ `string`
366
370
> Default value:
367
371
> ```yaml
368
372
> 0h1m0s
369
373
> ```
370
374
371
-
-- Send data back to the platform every minute unless changed
375
+
Send data back to the platform every minute unless changed
372
376
#### **config.clusterName** ~ `string`
373
377
> Default value:
374
378
> ```yaml
375
379
> ""
376
380
> ```
377
381
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
379
383
#### **config.clusterDescription** ~ `string`
380
384
> Default value:
381
385
> ```yaml
382
386
> ""
383
387
> ```
384
388
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
386
390
#### **config.ignoredSecretTypes[0]** ~ `string`
387
391
> Default value:
388
392
> ```yaml
@@ -434,8 +438,7 @@ Account in the Venafi Control Plane.
434
438
> false
435
439
> ```
436
440
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.
439
442
### CRDs
440
443
441
444
@@ -446,15 +449,35 @@ The CRDs installed by this chart are annotated with "helm.sh/resource-policy: ke
446
449
> false
447
450
> ```
448
451
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.
451
460
#### **crds.venafiConnection.include** ~ `bool`
452
461
> Default value:
453
462
> ```yaml
454
463
> false
455
464
> ```
456
465
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.
0 commit comments