clarify caData field

The code in `@kubernetes/client-node` will decode this value, as seen here:

https://github.com/kubernetes-client/javascript/blob/2b6813f99a85605f691973d6bc43f291ac072fc7/src/config.ts#L518-L520

I have seen a casual reader insert the multi-line raw contents of a PEM file in
this field, so it seems worth mentioning the extra layer of encoding explicitly.

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
This commit is contained in:
Jamie Klassen
2022-07-29 15:38:32 -04:00
committed by GitHub
parent 92430bdc39
commit c51d970410
+5 -3
View File
@@ -236,10 +236,12 @@ kubernetes:
##### `clusters.\*.caData` (optional)
PEM-encoded certificate authority certificates.
Base64-encoded certificate authority bundle in PEM format. The Kubernetes client
will verify that TLS certificate presented by the API server is signed by this
CA.
This values could be obtained via inspecting the Kubernetes config file (usually
at `~/.kube/config`) under `clusters.cluster.certificate-authority-data`. For
This value could be obtained via inspecting the kubeconfig file (usually
at `~/.kube/config`) under `clusters[*].cluster.certificate-authority-data`. For
GKE, execute the following command to obtain the value
```