From c51d970410311dc32250241db855901249b4ac3c Mon Sep 17 00:00:00 2001 From: Jamie Klassen Date: Fri, 29 Jul 2022 15:38:32 -0400 Subject: [PATCH] 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 --- docs/features/kubernetes/configuration.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/features/kubernetes/configuration.md b/docs/features/kubernetes/configuration.md index c3559585f7..dc541c5c50 100644 --- a/docs/features/kubernetes/configuration.md +++ b/docs/features/kubernetes/configuration.md @@ -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 ```