Skip to content

Commit 034539c

Browse files
Address commments
Signed-off-by: Furkat Gofurov <[email protected]>
1 parent 83e0e5d commit 034539c

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/next/modules/en/pages/user/cluster-resource-mapping.adoc

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,27 @@ This document explains the purpose, behavior, and relationships between the foll
2727

2828
| `provisioning.cattle.io`
2929
| Provisioning Cluster
30-
| Rancher's general-purpose cluster abstraction. Encapsulates both infrastructure-agnostic and provider-specific configuration. Required for generating cluster registration tokens and manifests. Automatically created by the Rancher Turtles when importing CAPI clusters.
30+
| Rancher’s earlier general-purpose cluster abstraction. Encapsulates both infrastructure-agnostic and provider-specific configuration, and is required for generating cluster registration tokens and manifests. In Rancher Turtles, this resource has been used to wrap imported CAPI clusters, but it is being phased out.
3131

3232
| `management.cattle.io`
3333
| Management Cluster
34-
| Legacy Rancher cluster representation. Primarily used for RKE1 clusters and hosted Kubernetes services (AKS, EKS, GKE). This should not be confused with **CAPI-managed clusters**, where "managed" refers to Cluster API's lifecycle management, not Rancher's `management.cattle.io` API group.
34+
| Rancher’s current cluster representation. `management.cattle.io/v3` clusters are now the default resource created and managed by Turtles. This should not be confused with CAPI-managed clusters, where managed refers to Cluster API lifecycle management, not Ranchers `management.cattle.io` API group.
3535
|===
3636

3737
== Relationships
3838

3939
=== CAPI Cluster → Fleet Cluster
4040

41-
When the Cluster API Add-on Provider for Fleet (CAAPF) is enabled, it propagates labels and annotations from the CAPI `Cluster` to the corresponding Fleet `Cluster`. This enables targeting GitOps bundles via label selectors.
41+
When the Cluster API Add-on Provider for Fleet (CAAPF) is enabled, it propagates labels and annotations from the CAPI `Cluster` to the corresponding Fleet `Cluster`. This enables targeting GitOps bundles via label selectors. CAAPF creates the corresponding Fleet `Cluster` resource after the CAPI `Cluster` reaches the `ControlPlaneInitialized` condition.
4242

43-
=== CAPI Cluster → Provisioning Cluster
43+
=== CAPI Cluster → Provisioning Cluster (Legacy)
4444

45-
If Rancher provisioning is used, a `provisioning.cattle.io.Cluster` is created to wrap the CAPI Cluster and expose Rancher-specific fields (e.g., display name, RKE config). However, in most Rancher Turtles workflows, this resource is not required.
45+
A `provisioning.cattle.io.Cluster` may be created to wrap the CAPI Cluster and expose Rancher-specific fields (e.g., display name, RKE config). However, in most Rancher Turtles workflows it is being phased out and the user is not required to interact with this resource.
4646

47-
=== Provisioning Cluster → Management Cluster
47+
=== Management Cluster → Provisioning Cluster
4848

49-
Each `provisioning.cattle.io.Cluster` results in the creation of a `management.cattle.io.Cluster`, which is used by Rancher’s UI and APIs. This object is not meant to be modified by users.
49+
For legacy clusters, a `provisioning.cattle.io/v1.Cluster` may be generated from a `management.cattle.io/v3.Cluster`. This object is used by Rancher’s UI and APIs and is not intended for direct modification by users.
50+
New clusters managed solely via Turtles do not automatically create a `provisioning.cattle.io` cluster.
5051

5152
== Propagation Behavior
5253

@@ -59,11 +60,11 @@ Each `provisioning.cattle.io.Cluster` results in the creation of a `management.c
5960

6061
| CAPI → Provisioning
6162
| No
62-
| No automatic propagation
63+
| Not automatically created; only generated via Turtles for legacy clusters
6364

6465
| CAPI → Management
6566
| No
66-
| Only via Provisioning Cluster
67+
| Only via Provisioning Cluster for legacy clusters
6768

6869
| Provisioning → Fleet
6970
| No
@@ -72,6 +73,10 @@ Each `provisioning.cattle.io.Cluster` results in the creation of a `management.c
7273
| Fleet → CAPI
7374
| No
7475
| Not supported
76+
77+
| Management → Provisioning
78+
| Conditional
79+
| Only for legacy clusters; new Turtles-managed clusters do not generate provisioning clusters
7580
|===
7681

7782
== What Should User Edit?

0 commit comments

Comments
 (0)