From af340ceb3960011cf619692269918cedfeda5774 Mon Sep 17 00:00:00 2001 From: Dario Tranchitella Date: Wed, 26 Jul 2023 18:31:26 +0200 Subject: [PATCH] fix(docs): control plane resources required label from v1.5.0 Signed-off-by: Dario Tranchitella --- .../src/developer/architecture/controllers/control-plane.md | 4 +++- docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/book/src/developer/architecture/controllers/control-plane.md b/docs/book/src/developer/architecture/controllers/control-plane.md index 0d9e34bb3ea6..94637ef610a4 100644 --- a/docs/book/src/developer/architecture/controllers/control-plane.md +++ b/docs/book/src/developer/architecture/controllers/control-plane.md @@ -258,7 +258,9 @@ spec: ## Kubeconfig management Control Plane providers are expected to create and maintain a Kubeconfig -secret for operators to gain initial access to the cluster. If a provider uses +secret for operators to gain initial access to the cluster. +The given secret must be labelled with the key-pair `cluster.x-k8s.io/cluster-name=${CLUSTER_NAME}` +to make it stored and retrievable in the cache used by CAPI managers. If a provider uses client certificates for authentication in these Kubeconfigs, the client certificate should be kept with a reasonably short expiration period and periodically regenerated to keep a valid set of credentials available. As an diff --git a/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md b/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md index 49ab9f7b8bd3..ba37d8d8884d 100644 --- a/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md +++ b/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md @@ -38,6 +38,8 @@ maintainers of providers and consumers of our Go API. - Introduced function `CollectInfrastructureLogs` at the `ClusterLogCollector` interface in `test/framework/cluster_proxy.go` to allow collecting infrastructure related logs during tests. - A `GetTypedConfigOwner` function has been added to the `sigs.k8s.io./cluster-api/bootstrap/util` package. It is equivalent to `GetConfigOwner` except that it uses the cached typed client instead of the uncached unstructured client, so `GetTypedConfigOwner` is expected to be more performant. - `ClusterToObjectsMapper` in `sigs.k8s.io./cluster-api/util` has been deprecated, please use `ClusterToTypedObjectsMapper` instead. +- The generated `kubeconfig` by the Control Plane providers must be labelled with the key-value pair `cluster.x-k8s.io/cluster-name=${CLUSTER_NAME}`. + This is required for the CAPI managers caches to store and retrieve them for the required operations. ### Suggested changes for providers