You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/next/modules/en/pages/user/cluster-resource-mapping.adoc
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,26 +27,27 @@ This document explains the purpose, behavior, and relationships between the foll
27
27
28
28
| `provisioning.cattle.io`
29
29
| 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.
31
31
32
32
| `management.cattle.io`
33
33
| Management Cluster
34
-
| Legacy Ranchercluster 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 Rancher’s `management.cattle.io` API group.
35
35
|===
36
36
37
37
== Relationships
38
38
39
39
=== CAPI Cluster → Fleet Cluster
40
40
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.
42
42
43
-
=== CAPI Cluster → Provisioning Cluster
43
+
=== CAPI Cluster → Provisioning Cluster (Legacy)
44
44
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.
46
46
47
-
=== Provisioning Cluster → Management Cluster
47
+
=== Management Cluster → Provisioning Cluster
48
48
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.
50
51
51
52
== Propagation Behavior
52
53
@@ -59,11 +60,11 @@ Each `provisioning.cattle.io.Cluster` results in the creation of a `management.c
59
60
60
61
| CAPI → Provisioning
61
62
| No
62
-
| No automatic propagation
63
+
| Not automatically created; only generated via Turtles for legacy clusters
63
64
64
65
| CAPI → Management
65
66
| No
66
-
| Only via Provisioning Cluster
67
+
| Only via Provisioning Cluster for legacy clusters
67
68
68
69
| Provisioning → Fleet
69
70
| No
@@ -72,6 +73,10 @@ Each `provisioning.cattle.io.Cluster` results in the creation of a `management.c
72
73
| Fleet → CAPI
73
74
| No
74
75
| Not supported
76
+
77
+
| Management → Provisioning
78
+
| Conditional
79
+
| Only for legacy clusters; new Turtles-managed clusters do not generate provisioning clusters
0 commit comments