(feat): easier Kubernetes local development steps (#12373)

* (feat): easier kubernetes local deevlopment steps Signed-off-by: Matthew Clarke <mclarke@spotify.com> * add changeset Signed-off-by: Matthew Clarke <mclarke@spotify.com> * update api docs Signed-off-by: Matthew Clarke <mclarke@spotify.com> * fix typo Signed-off-by: Matthew Clarke <mclarke@spotify.com>
2022-07-07 03:45:25 -04:00
parent 3a6f3536f3
commit f5c9730639
12 changed files with 84 additions and 134 deletions
@@ -57,10 +57,17 @@ This is an array used to determine where to retrieve cluster configuration from.

 Valid cluster locator methods are:

+- [`localKubectlProxy`](#localKubectlProxy)
 - [`config`](#config)
 - [`gke`](#gke)
 - [custom `KubernetesClustersSupplier`](#custom-kubernetesclusterssupplier)

+#### `localKubectlProxy`
+
+This cluster locator method will assume a locally running [`kubectl proxy`](https://kubernetes.io/docs/tasks/extend-kubernetes/http-proxy-access-api/#using-kubectl-to-start-a-proxy-server) process using the default port (8001).
+
+NOTE: This cluster locator method is for local development only and should not be used in production.
+
 #### `config`

 This cluster locator method will read cluster information from your app-config