Skip to content

Commit e15eebf

Browse files
committed
make update-helm-docs
Signed-off-by: Richard Wall <[email protected]>
1 parent a7c8f62 commit e15eebf

File tree

1 file changed

+11
-6
lines changed
  • deploy/charts/venafi-kubernetes-agent

1 file changed

+11
-6
lines changed

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Venafi Kubernetes Agent connects your Kubernetes or Openshift cluster to the Venafi Control Plane.
44

5-
![Version: 0.1.43-alpha.1](https://img.shields.io/badge/Version-0.1.43--alpha.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.1.43](https://img.shields.io/badge/AppVersion-v0.1.43-informational?style=flat-square)
5+
![Version: 0.1.43](https://img.shields.io/badge/Version-0.1.43-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.1.43](https://img.shields.io/badge/AppVersion-v0.1.43-informational?style=flat-square)
66

77
## Additional Information
88

@@ -16,6 +16,9 @@ Upon signing up you will be redirected to one of either of the following login U
1616
- https://ui.venafi.cloud/ (US)
1717
- https://ui.venafi.eu/ (EU)
1818

19+
> 📖 Learn more about [Venafi Kubernetes Agent network requirements](https://docs.venafi.cloud/vaas/k8s-components/c-vcp-network-requirements/),
20+
> in the two regions.
21+
1922
## Installation
2023

2124
The Helm chart is available from the following Venafi OCI registries:
@@ -24,7 +27,9 @@ The Helm chart is available from the following Venafi OCI registries:
2427
- `oci://private-registry.venafi.cloud/charts/venafi-kubernetes-agent` (private, US)
2528
- `oci://private-registry.venafi.eu/charts/venafi-kubernetes-agent` (private, EU)
2629

27-
> Learn [how to access the private Venafi OCI registries](https://docs.venafi.cloud/vaas/k8s-components/th-guide-confg-access-to-tlspk-enterprise-components/).
30+
> ℹ️ In the following steps it is assumed that you are using the **public** registry.
31+
>
32+
> 📖 Learn [how to access the private Venafi OCI registries](https://docs.venafi.cloud/vaas/k8s-components/th-guide-confg-access-to-tlspk-enterprise-components/).
2833
2934
Familiarise yourself with the Helm chart:
3035

@@ -86,8 +91,8 @@ helm upgrade venafi-kubernetes-agent oci://registry.venafi.cloud/charts/venafi-k
8691
--set config.clientId="${VENAFI_CLIENT_ID}"
8792
```
8893

89-
> To change the backend to the EU Venafi Control Plane, use the following Helm value:
90-
> `--set config.server="${VENAFI_SERVER_URL}"`
94+
> ℹ️ To use the [EU Venafi Control Plane](https://docs.venafi.cloud/vaas/k8s-components/c-vcp-network-requirements/),
95+
> add: `--set config.server=https://api.venafi.eu/`.
9196
9297
### 3) Connect the cluster in Venafi Control Plane
9398

@@ -143,13 +148,13 @@ You should see the following events for your service account:
143148
| command | list | `[]` | Specify the command to run overriding default binary. |
144149
| config | object | `{"clientId":"","configmap":{"key":null,"name":null},"period":"0h1m0s","server":"https://api.venafi.cloud/"}` | Configuration section for the Venafi Kubernetes Agent itself |
145150
| config.clientId | string | `""` | The client-id returned from the Venafi Control Plane |
146-
| config.configmap | object | `{"key":null,"name":null}` | Specify ConfigMap details to load config from an existing resource. This should be blank by default unless you have you own config. |
151+
| config.configmap | object | `{"key":null,"name":null}` | Specify ConfigMap details to load config from an existing resource. This should be blank by default unless you have you own config. |
147152
| config.period | string | `"0h1m0s"` | Send data back to the platform every minute unless changed |
148153
| config.server | string | `"https://api.venafi.cloud/"` | Overrides the server if using a proxy in your environment For the EU variant use: https://api.venafi.eu/ |
149154
| extraArgs | list | `[]` | Specify additional arguments to pass to the agent binary. For example `["--strict", "--oneshot"]` |
150155
| fullnameOverride | string | `""` | Helm default setting, use this to shorten the full install name. |
151156
| image.pullPolicy | string | `"IfNotPresent"` | Defaults to only pull if not already present |
152-
| image.repository | string | `"quay.io/jetstack/preflight"` | Default to Open Source image repository |
157+
| image.repository | string | `"quay.io/jetstack/venafi-agent"` | Default to Open Source image repository |
153158
| image.tag | string | `"v0.1.43"` | Overrides the image tag whose default is the chart appVersion |
154159
| imagePullSecrets | list | `[]` | Specify image pull credentials if using a private registry example: - name: my-pull-secret |
155160
| nameOverride | string | `""` | Helm default setting to override release name, usually leave blank. |

0 commit comments

Comments
 (0)