Skip to content

Commit c56c2a6

Browse files
committed
Documentation improvements
1 parent 567d9ea commit c56c2a6

File tree

1 file changed

+37
-23
lines changed

1 file changed

+37
-23
lines changed

asciidoc/day2/migration.adoc

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ifdef::env-github[]
1212
endif::[]
1313
:toc: preamble
1414

15-
This section offers migration guidelines for existing `Edge 3.0` *management* and *downstream* clusters to `Edge 3.1.0`.
15+
This section offers migration guidelines for existing `Edge 3.0` (including minor releases such as 3.0.1 and 3.0.2) *management* and *downstream* clusters to `Edge 3.1.0`.
1616

1717
For a list of `Edge 3.1.0` component versions, refer to the <<release-notes, release notes>>.
1818

@@ -21,7 +21,7 @@ For a list of `Edge 3.1.0` component versions, refer to the <<release-notes, rel
2121

2222
This section covers how to migrate a `management` cluster from `Edge 3.0` to `Edge 3.1.0`.
2323

24-
`Management` cluster component should be migrated in the following order:
24+
`Management` cluster components should be migrated in the following order:
2525

2626
. <<day2-migration-mgmt-os, Operating System (OS)>>
2727

@@ -102,6 +102,11 @@ The `--continue` option is used here in order to reuse the previous snapshot wit
102102
image::day2-migration-os-migration-prompt.png[]
103103
+
104104
Select the `number` that corresponds to `SUSE Linux Micro 6.0 <arch>`.
105+
+
106+
[NOTE]
107+
====
108+
The `Edge 3.1.0` release supports *only* the `SUSE Linux Micro 6.0` operating system.
109+
====
105110

106111
. After a successful `transactional-update` run, for the changes to take effect on the system you would need to reboot:
107112
+
@@ -110,7 +115,7 @@ Select the `number` that corresponds to `SUSE Linux Micro 6.0 <arch>`.
110115
reboot
111116
----
112117

113-
. Validate that the operating system has been migrated to `SUSE Linux Micro 6.0`:
118+
. After the host has been rebooted, validate that the operating system has been migrated to `SUSE Linux Micro 6.0`:
114119
+
115120
[,bash]
116121
----
@@ -224,7 +229,7 @@ kubectl uncordon <node_name>
224229

225230
[NOTE]
226231
====
227-
This section assumes you have installed `helm` on your system. For `helm` installation instructions, check link:https://helm.sh/docs/intro/install[here].
232+
This section assumes you have installed `helm` on your system and you have a valid `kubeconfig` pointing to the desired cluster. For `helm` installation instructions, check link:https://helm.sh/docs/intro/install[here].
228233
====
229234

230235
This section provides guidelines for upgrading the Helm chart components that make up a specific Edge release. It covers the following topics:
@@ -274,7 +279,7 @@ kubectl patch helmchart rancher -n <namespace> --type='merge' -p '{"spec":{"set"
274279
[#day2-migration-mgmt-helm-capi]
275280
==== Cluster API controllers migration
276281

277-
From `Edge 3.1.0`, Cluster API (CAPI) controllers on a Metal^3^ management cluster are managed via the `Rancher Turtles` Helm chart.
282+
From `Edge 3.1.0`, Cluster API (CAPI) controllers on a Metal^3^ management cluster are managed via link:https://turtles.docs.rancher.com[Rancher Turtles].
278283

279284
To migrate the CAPI controllers versions to `Edge 3.1.0` compatible versions, install the `Rancher Turtles` chart:
280285

@@ -402,32 +407,30 @@ As per the link:https://docs.rke2.io/helm#automatically-deploying-manifests-and-
402407
> "Deleting files out of this directory will not delete the corresponding resources from the cluster."
403408
====
404409

405-
To remove any EIB deployed chart manifests, follow these steps:
410+
Removing any EIB deployed chart manifests involves the following steps:
406411

407-
. Navigate to the RKE2 manifests directory:
412+
. To ensure disaster recovery, make a backup of each EIB deployed manifest:
408413
+
409-
[,bash]
410-
----
411-
cd /var/lib/rancher/rke2/server/manifests
412-
----
413-
414-
. Get all EIB deployed manifests:
414+
[NOTE]
415+
====
416+
EIB deployed manifests will have the `"edge.suse.com/source: edge-image-builder"` label.
417+
====
415418
+
416419
[NOTE]
417420
====
418-
All EIB deployed manifests will have the `"edge.suse.com/source: edge-image-builder"` label.
421+
Make sure that the `<backup_location>` that you provide to the below command exists.
419422
====
420423
+
421424
[,bash]
422425
----
423-
grep -rl 'edge.suse.com/source: edge-image-builder'
426+
grep -lrIZ 'edge.suse.com/source: edge-image-builder' /var/lib/rancher/rke2/server/manifests | xargs -0 -I{} cp {} <backup_location>
424427
----
425428

426-
. Remove each `*.yaml` chart manifest:
429+
. Remove all EIB deployed manifests:
427430
+
428431
[,bash]
429432
----
430-
rm <chart_name>.yaml
433+
grep -lrIZ 'edge.suse.com/source: edge-image-builder' /var/lib/rancher/rke2/server/manifests | xargs -0 rm -f --
431434
----
432435

433436
[#day2-migration-mgmt-helm-upgrade-steps]
@@ -808,17 +811,17 @@ On downstream clusters, the removal of the EIB created chart manifest files is h
808811

809812
[WARNING]
810813
====
811-
Using the `eib-charts-migration-prep` Fleet from `main` is *not* advised. The fleet should *always* be used from a valid Edge link:https://github.com/suse-edge/fleet-examples/releases[release] tag.
814+
Using the `eib-charts-migration-prep` Fleet file from the `main` branch is *not* advised. The Fleet file should *always* be used from a valid Edge link:https://github.com/suse-edge/fleet-examples/releases[release] tag.
812815
====
813816

814817
[IMPORTANT]
815818
====
816-
This process requires that SUC is already deployed. For installation details, refer to <<components-system-upgrade-controller-install, "Installing the System Upgrade Controller">>.
819+
This process requires that System Upgrade Controller (SUC) is already deployed. For installation details, refer to <<components-system-upgrade-controller-install, "Installing the System Upgrade Controller">>.
817820
====
818821

819822
Once created, the `eib-charts-migration-prep` Fleet ships a <<components-system-upgrade-controller,SUC>> Plan that contains a script that will do the following:
820823

821-
. Determine whether the current node it is running on is an `initializer` node.
824+
. Determine whether the current node it is running on is an `initializer` node. If it is not, it won't do anything.
822825

823826
. If the node is an `initializer`, it will:
824827

@@ -907,20 +910,31 @@ Make sure that the version of the *fleet-cli* you download matches the version o
907910

908911
** For Linux users, the binaries are present as *assets* to each Fleet link:https://github.com/rancher/fleet/releases[release].
909912

910-
*** Linux AMD:
913+
*** Retrieve the desired binary:
914+
915+
**** Linux AMD:
911916
+
912917
[,bash]
913918
----
914919
curl -L -o fleet-cli https://github.com/rancher/fleet/releases/download/<FLEET_VERSION>/fleet-linux-amd64
915920
----
916921

917-
*** Linux ARM:
922+
**** Linux ARM:
918923
+
919924
[,bash]
920925
----
921926
curl -L -o fleet-cli https://github.com/rancher/fleet/releases/download/<FLEET_VERSION>/fleet-linux-arm64
922927
----
923928

929+
*** Move the binary to `/usr/local/bin`:
930+
+
931+
[,bash]
932+
----
933+
sudo mkdir -p /usr/local/bin
934+
sudo mv ./fleet-cli /usr/local/bin/fleet-cli
935+
sudo chmod 755 /usr/local/bin/fleet-cli
936+
----
937+
924938
. Clone the *suse-edge/fleet-examples* link:https://github.com/suse-edge/fleet-examples/releases[release] that you wish to use the `eib-chart-migration-prep` fleet from:
925939
+
926940
[,bash]
@@ -947,7 +961,7 @@ EOF
947961
+
948962
For information on how to map to downstream clusters, see link:https://fleet.rancher.io/gitrepo-targets[Mapping to Downstream Clusters].
949963

950-
. Proceed to building the Bundle:
964+
. Proceed to build the Bundle:
951965
+
952966
[NOTE]
953967
====

0 commit comments

Comments
 (0)