Skip to content

Commit 4991547

Browse files
committed
fix(docs): control plane resources required label from v1.5.0
Signed-off-by: Dario Tranchitella <[email protected]>
1 parent ce33c29 commit 4991547

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/book/src/developer/architecture/controllers/control-plane.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,9 @@ spec:
258258
## Kubeconfig management
259259

260260
Control Plane providers are expected to create and maintain a Kubeconfig
261-
secret for operators to gain initial access to the cluster. If a provider uses
261+
secret for operators to gain initial access to the cluster.
262+
The given secret must be labelled with the key-pair `cluster.x-k8s.io/cluster-name=${CLUSTER_NAME}`
263+
to make it stored and retrievable in the cache used by CAPI managers. If a provider uses
262264
client certificates for authentication in these Kubeconfigs, the client
263265
certificate should be kept with a reasonably short expiration period and
264266
periodically regenerated to keep a valid set of credentials available. As an

docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ maintainers of providers and consumers of our Go API.
3838
- Introduced function `CollectInfrastructureLogs` at the `ClusterLogCollector` interface in `test/framework/cluster_proxy.go` to allow collecting infrastructure related logs during tests.
3939
- 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.
4040
- `ClusterToObjectsMapper` in `sigs.k8s.io./cluster-api/util` has been deprecated, please use `ClusterToTypedObjectsMapper` instead.
41+
- The generated `kubeconfig` by the Control Plane providers must be labelled with the key-value pair `cluster.x-k8s.io/cluster-name=${CLUSTER_NAME}`.
42+
This is required for the CAPI managers caches to store and retrieve them for the required operations.
4143

4244
### Suggested changes for providers
4345

0 commit comments

Comments
 (0)