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
* <<components-metal3,Metal3>> IPAM provider (currently not supported)
38
+
* Fleet addon provider
37
39
38
40
Only the default providers installed via the wrapper chart are supported - alternative Control Plane, Bootstrap and Infrastructure providers are not currently supported as part of the SUSE Edge stack.
39
41
40
42
== Installing Rancher Turtles
41
43
42
-
Rancher Turtles may be installed by following the <<quickstart-metal3,Metal3 Quickstart>> guide, or the <<atip-management-cluster,Management Cluster>> documentation.
44
+
Since Rancher 2.13, Rancher Turtles is enabled by default when installing Rancher.
45
+
46
+
Rancher Turtles Providers may be installed by following the <<quickstart-metal3,Metal3 Quickstart>> guide, or the <<atip-management-cluster,Management Cluster>> documentation.
Copy file name to clipboardExpand all lines: asciidoc/day2/migration.adoc
+83-5Lines changed: 83 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
[#day2-migration]
2
2
= Edge {version-edge} migration
3
-
:revdate: 2025-09-30
3
+
:revdate: 2026-01-19
4
4
:page-revdate: {revdate}
5
5
:experimental:
6
6
@@ -13,9 +13,9 @@ ifdef::env-github[]
13
13
:warning-caption: :warning:
14
14
endif::[]
15
15
:toc: preamble
16
-
:previous-edge-version: 3.3
17
-
:static-edge-version: 3.4.0
18
-
:static-fleet-examples-tag: release-3.4.0
16
+
:previous-edge-version: 3.4
17
+
:static-edge-version: 3.5.0
18
+
:static-fleet-examples-tag: release-3.5.0
19
19
20
20
This section explains how to migrate your `management` and `downstream` clusters from `Edge {previous-edge-version}` to `Edge {static-edge-version}`.
21
21
@@ -62,7 +62,7 @@ This section covers the following topics:
62
62
63
63
[NOTE]
64
64
====
65
-
Applies only to clusters that require a <<components-metal3>> chart upgrade.
65
+
Applies only to CAPI/Metal3 management clusters that require a <<components-metal3>> chart upgrade.
66
66
====
67
67
68
68
The `Metal^3^` Helm chart includes the link:https://book.metal3.io/bmo/introduction.html[Bare Metal Operator (BMO)] CRDs by leveraging Helm's link:https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#method-1-let-helm-do-it-for-you[CRD] directory.
You can provide a `values.yaml` file by appending `-f values.yaml` to the upgrade command if you wish.
262
262
263
+
==== Prepare for Rancher Turtles upgrade
264
+
265
+
[NOTE]
266
+
====
267
+
Applies only to CAPI/Metal3 management clusters that require a rancher turtles chart upgrade.
268
+
269
+
You must ensure the management cluster is first updated to the latest 3.4 z-stream, which contains the necessary 0.24.3 Rancher Turtles version.
270
+
====
271
+
272
+
Starting with Rancher 2.13, Rancher Turtles is installed by default, therefore it is necessary to follow some additional migration steps as described in the https://turtles.docs.rancher.com/turtles/next/en/tutorials/migration.html[Rancher Turtles Documentation]
273
+
274
+
First we remove the installed `CAPIProvider` resources:
275
+
276
+
[,bash,subs="attributes"]
277
+
----
278
+
kubectl delete capiprovider -A --all
279
+
----
280
+
281
+
After waiting for the step above to complete, we next remove the installed rancher-turtles chart and rancher-turtles-airgap-resources (if installed),
282
+
when installed via Edge Image Builder this requires removal of the corresponding `HelmChart` resources:
Next we must patch the CRD resources as described in the https://turtles.docs.rancher.com/turtles/next/en/tutorials/migration.html[Rancher Turtles Documentation]
Now follow the regular steps to upgrade the management cluster to `Edge {static-edge-version}`
299
+
300
+
==== Rancher Turtles post-upgrade
301
+
302
+
*After* following the steps below to upgrade to `Edge {static-edge-version}` it is necessary to install the new `rancher-turtles-providers` helm chart - this creates new `CAPIProvider` resources to replace those removed in the pre-upgrade steps above.
303
+
304
+
This chart installation should be done via a `HelmChart` resource to enable future automated upgrade via the upgrade controller:
Copy file name to clipboardExpand all lines: asciidoc/product/atip-management-cluster.adoc
+17-74Lines changed: 17 additions & 74 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
[#atip-management-cluster]
2
2
== Setting up the management cluster
3
-
:revdate: 2025-07-31
3
+
:revdate: 2025-12-01
4
4
:page-revdate: {revdate}
5
5
:experimental:
6
6
@@ -64,7 +64,6 @@ The following are the main steps to set up the management cluster using a declar
64
64
- xref:mgmt-cluster-image-definition-file-airgap[Modifications in the definition file]: The `mgmt-cluster.yaml` file must be modified to include the `embeddedArtifactRegistry` section with the `images` field set to all container images to be included into the EIB output image.
65
65
- xref:mgmt-cluster-custom-folder-airgap[Modifications in the custom folder]: The `custom` folder must be modified to include the resources needed to run the management cluster in an air-gap environment.
66
66
** Register script: The `custom/scripts/99-register.sh` script must be removed when you use an air-gap environment.
67
-
- xref:mgmt-cluster-helm-values-folder-airgap[Modifications in the helm values folder]: The `helm/values` folder must be modified to include the configuration needed to run the management cluster in an air-gap environment.
68
67
69
68
. **xref:mgmt-cluster-image-creation[Image creation]**: This step covers the creation of the image using the Edge Image Builder tool (for both, connected and air-gap scenarios). Check the <<components-eib,prerequisites>> to run the Edge Image Builder tool on your system.
This section describes how to prepare the image for air-gap environments showing only the differences from the previous sections. The following changes to the previous section (xref:mgmt-cluster-image-preparation-connected[Image preparation for connected environments]) are required to prepare the image for air-gap environments:
998
982
999
983
- The `mgmt-cluster.yaml` file must be modified to include the `embeddedArtifactRegistry` section with the `images` field set to all container images to be included into the EIB output image.
1000
-
- The `mgmt-cluster.yaml` file must be modified to include `rancher-turtles-airgap-resources` helm chart.
1001
984
- The `custom/scripts/99-register.sh` script must be removed when use an air-gap environment.
1002
985
1003
986
[#mgmt-cluster-image-definition-file-airgap]
@@ -1012,8 +995,6 @@ The following is an example of the `mgmt-cluster.yaml` file with the `embeddedAr
1012
995
Make sure to the listed images contain the component versions you need.
1013
996
====
1014
997
1015
-
The `rancher-turtles-airgap-resources` helm chart must also be added, this creates resources as described in the https://documentation.suse.com/cloudnative/cluster-api/{rancher-turtles-docs-version}/en/getting-started/air-gapped-environment.html[Rancher Turtles Airgap Documentation]. This also requires a turtles.yaml values file for the rancher-turtles chart to specify the necessary configuration.
- The `custom/scripts/99-register.sh` script must be removed when using an air-gap environment. As you can see in the directory structure, the `99-register.sh` script is not included in the `custom/scripts` folder.
1166
1141
1167
1142
1168
-
[#mgmt-cluster-helm-values-folder-airgap]
1169
-
==== Modifications in the helm values folder
1170
-
1171
-
- The `turtles.yaml`: contains the configuration required to specify airgapped operation for Rancher Turtles, note this depends on installation of the rancher-turtles-airgap-resources chart.
After some time, the controller pods should be running in the `capi-system`, `capm3-system`, `rke2-bootstrap-system` and `rke2-control-plane-system` namespaces.
169
+
After some time, the controller pods should be running in the `cattle-capi-system`, `capm3-system`, `rke2-bootstrap-system` and `rke2-control-plane-system` namespaces.
0 commit comments