From ccdbc7c3c1d1ddb3f217eb54116273961bbfabaf Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Fri, 15 Mar 2024 09:05:42 +0100 Subject: [PATCH] xmlformat. --- articles/Micro-upgrade.asm.xml | 127 +++++------ concepts/Micro-upgrade-about.xml | 76 +++---- snippets/Micro-upgrade-path.xml | 8 +- tasks/Micro-upgrade-preparation.xml | 320 ++++++++++++++-------------- tasks/Micro-upgrade-upgrading.xml | 107 +++++----- 5 files changed, 311 insertions(+), 327 deletions(-) diff --git a/articles/Micro-upgrade.asm.xml b/articles/Micro-upgrade.asm.xml index a4ffaa33b..3d92176ff 100644 --- a/articles/Micro-upgrade.asm.xml +++ b/articles/Micro-upgrade.asm.xml @@ -19,7 +19,6 @@ --> - @@ -36,7 +35,6 @@ - @@ -49,35 +47,18 @@ - Upgrading &productnameshort; from Previous Releases - + Upgrading &productnameshort; from Previous Releases - - 2054-11-14 + + 2024-03-14 - Added sections: - - - - New section on foo to resolve issue bsc#12345 - - New section on foo bar - - - Removed sections: - - Removed section on foo1 to resolve issue bsc#12346 - Removed section on foo1 bar - - - Changed sections: - - Changed section on foo2 to resolve issue bsc#12347 - Changed section on foo2 bar - + + + Initial version + @@ -90,10 +71,10 @@ - - &x86-64; - &aarch64; - &ibm; + see https://confluence.suse.com/x/aQDWNg + --> + &x86-64;&aarch64;&ibm; - - &productname; + &productname; Upgrade procedure for &productnameshort; Upgrading from &productnameshort; 5.X releases to &productnameshort; 6.X releases Upgrade procedure for &productnameshort; - - Upgrade + Upgrade - - Upgrade - + Upgrade + Products & Solutions - https://bugzilla.suse.com/enter_bug.cgi @@ -137,53 +111,55 @@ Documentation jsindelarova@suse.com - + yes - - - WHAT? - - - This document offers a comprehensive guide to upgrading &productnameshort; from version 5.5 to version 6.0, detailing the preparatory steps, -upgrade process, and potential rollback options. - - - - - WHY? - - - You want to have the new release of &productnameshort;. - - - - - EFFORT + + + WHAT? + + + This document offers a comprehensive guide to upgrading + &productnameshort; from version 5.5 to version 6.0, detailing + the preparatory steps, upgrade process, and potential rollback + options. + + + + + WHY? + + + You want to have the new release of &productnameshort;. + + + + + EFFORT It takes approximately 20 minutes to read the article. - - - GOAL + + + GOAL A new running release of &productnameshort;. - - - REQUIREMENTS + + + REQUIREMENTS - A registered SLE Micro version 5.5 + A registered SLE Micro version 5.5 - + @@ -193,14 +169,13 @@ upgrade process, and potential rollback options. - - + @@ -208,7 +183,7 @@ upgrade process, and potential rollback options. - + diff --git a/concepts/Micro-upgrade-about.xml b/concepts/Micro-upgrade-about.xml index c5e04ddfc..4eeac0c67 100644 --- a/concepts/Micro-upgrade-about.xml +++ b/concepts/Micro-upgrade-about.xml @@ -18,57 +18,61 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - Introduction to the upgrade procedure + Introduction to the upgrade procedure + - + + - &productnameshort; allows upgrading from an existing system to the new version. No - new installation is needed. Existing data, such as home and data - directories and system configuration, is kept intact. - + &productnameshort; allows upgrading from an existing system to the new + version. No new installation is needed. Existing data, such as home and + data directories and system configuration, is kept intact. + - &suse; supports upgrades between two releases of &productname;. - Whether it is better to upgrade or perform a fresh installation depends on - your specific scenario. While upgrades involve less work, fresh - installations ensure you benefit from all the new features of a release, - such as disk layout changes, specific filesystem features, and other - improvements. To get the most out of your system, &suse; therefore - recommends fresh installations in most scenarios. - + &suse; supports upgrades between two releases of &productname;. Whether it + is better to upgrade or perform a fresh installation depends on your + specific scenario. While upgrades involve less work, fresh installations + ensure you benefit from all the new features of a release, such as disk + layout changes, specific filesystem features, and other improvements. To + get the most out of your system, &suse; therefore recommends fresh + installations in most scenarios. + - &suse; releases a new version of &productnameshort; twice a year and the product comes with 4 - years of general support (for details regarding &productnameshort; lifecycle, refer to ). - - - &productnameshort; uses transactional updates to upgrade from one - version to the next. This has the following advantages: - - + + + &productnameshort; uses transactional updates to + upgrade from one version to the next. This has the following advantages: + + - - Canceling is possible until you reboot your system. - + + Canceling is possible until you reboot your system. + - - Simple recovery if there is an error. - + + Simple recovery if there is an error. + - - Possible rollback via system tools—no backup - or restore needed. - + + Possible rollback via system tools—no backup or + restore needed. + - - Use of all active repositories. - + + Use of all active repositories. + - + diff --git a/snippets/Micro-upgrade-path.xml b/snippets/Micro-upgrade-path.xml index 27523a429..9230f3efc 100644 --- a/snippets/Micro-upgrade-path.xml +++ b/snippets/Micro-upgrade-path.xml @@ -5,7 +5,9 @@ -Upgrade is possible only from the 5.5 release -If you are upgrading from other 5.X release than 5.5, you need to at first migrate to 5.5 -before you trigger the upgrade to 6.0. + Upgrade is possible only from the 5.5 release + + If you are upgrading from other 5.X release than 5.5, you need to at first + migrate to 5.5 before you trigger the upgrade to 6.0. + diff --git a/tasks/Micro-upgrade-preparation.xml b/tasks/Micro-upgrade-preparation.xml index 1aa1855d9..4c72ee77b 100644 --- a/tasks/Micro-upgrade-preparation.xml +++ b/tasks/Micro-upgrade-preparation.xml @@ -18,24 +18,28 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - Preparing &productnameshort; for upgrade + Preparing &productnameshort; for upgrade + - + + - Before you start the upgrade procedure of &productnameshort;, you need to perform checks as described in this section. - + Before you start the upgrade procedure of &productnameshort;, you need + to perform checks as described in this section. +
Identify the &productnameshort; version - + - To check the &productnameshort; version, view the file /etc/os-release. - Machine-readable XML output is available with zypper: + To check the &productnameshort; version, view the file + /etc/os-release. Machine-readable XML output is + available with zypper: - + &prompt.sudo;zypper --no-remote --no-refresh --xmlout --non-interactive products -i @@ -59,71 +63,62 @@ in the assembly --> Read the release notes Find a list of all changes, new features, and known issues in the - release notes. - You can also find the release notes on the installation media in the - docu directory. - - - + release + notes. You can also find the release notes on the installation + media in the docu directory. + + The release notes usually only contain the changes between two subsequent releases. - - - + + Check the release notes to see whether: - - - + + - - your hardware needs special considerations - + + your hardware needs special considerations + - - any used software packages have changed significantly - + + any used software packages have changed significantly + - - special precautions are necessary for your installation - + + special precautions are necessary for your installation + - +
Register the machine - - - On registration, the system receives repositories from the &scc; (see - ) or a local registration proxy like ⪪. The - repository names map to specific URIs in the customer center. To list all - available repositories on your system, use zypper as - follows: - - - &prompt.root;zypper repos -u - - - This gives you a list of all available repositories on your system. Each - repository is listed by its alias, name and whether it is enabled and will - be refreshed. The option also gives you the URI from - where it originated. - - - - To register your machine, run the transactional-update command - as follows: - - - + + On registration, the system receives repositories from the &scc; (see + ) or a local registration proxy like ⪪. + The repository names map to specific URIs in the customer center. To list + all available repositories on your system, use zypper + as follows: + +&prompt.root;zypper repos -u + + This gives you a list of all available repositories on your system. Each + repository is listed by its alias, name and whether it is enabled and + will be refreshed. The option also gives you the URI + from where it originated. + + + To register your machine, run the transactional-update + command as follows: + + &prompt.sudo;transactional-update register -r REGCODE - - To check your locally installed products and their status, use the following - command: - - + + To check your locally installed products and their status, use the + following command: + &prompt.root;&suseconnect; -s
@@ -131,8 +126,8 @@ in the assembly --> Upgrading the system is only supported from the most recent patch level. Make sure the latest system updates are installed by running: - - + + &prompt.sudo;transactional-update patch
@@ -141,27 +136,25 @@ in the assembly --> Before upgrading, back up your data by copying the existing configuration files to a separate medium (such as tape device or removable hard disk). - This primarily applies to files stored in /etc and some - directories and files in /var and + This primarily applies to files stored in /etc and + some directories and files in /var and /opt. You may also want to write the user data in - /home (the HOME directories) to a backup - medium. - - - - Back up all data as &rootuser;. Only &rootuser; has sufficient permissions - for all local files. - + /home (the HOME directories) to a + backup medium. + + + Back up all data as &rootuser;. Only &rootuser; has sufficient + permissions for all local files. + -
Switch from <command>wicked</command> to &nm; - If your network service is wicked, you need to switch - it to &nm; because wicked is not - supported in the new release. To check which networking service you use, run: + If your network service is wicked, you need to switch + it to &nm; because wicked is not supported in the new + release. To check which networking service you use, run: - + &prompt.sudo;systemctl status network wicked.service - wicked managed network interfaces @@ -170,68 +163,67 @@ in the assembly --> <command>wicked</command> and &nm; incompatibilities - Even though &nm; and wicked are similar in - functionalities, we cannot guarantee full feature parity. Converting the - wicked configuration or automated switching - to &nm; is not supported. + Even though &nm; and wicked are similar in + functionalities, we cannot guarantee full feature parity. Converting + the wicked configuration or automated switching to + &nm; is not supported. - - - The /etc/sysconfig/network/ifcfg-* files are - compatible, except for some rare cases. However, when you use the - wicked configuration in - /etc/wicked/*.xml, you need to migrate - the configuration manually. + + The /etc/sysconfig/network/ifcfg-* files are + compatible, except for some rare cases. However, when you use the + wicked configuration in + /etc/wicked/*.xml, you need to migrate the + configuration manually. - + - To change your networking managing service from wicked to &nm;, proceed as follows: + To change your networking managing service from wicked + to &nm;, proceed as follows: - - Run the following command to create a new snapshot where you perform all - other changes to the system: - - &prompt.sudo;transactional-update shell + + Run the following command to create a new snapshot where you perform + all other changes to the system: + +&prompt.sudo;transactional-update shell - - Install &nm;: - - &prompt.sudo;zypper in NetworkManager + + Install &nm;: + +&prompt.sudo;zypper in NetworkManager - - Remove wicked from the system: - - &prompt.sudo;zypper rm wicked wicked-service + + Remove wicked from the system: + +&prompt.sudo;zypper rm wicked wicked-service - - Enable the &nm; service: - - &prompt.sudo;systemctl enable NetworkManager + + Enable the &nm; service: + +&prompt.sudo;systemctl enable NetworkManager - - If needed, configure the service according to your needs. - + + If needed, configure the service according to your needs. + - - Close the transactional-update shell: - - &prompt.sudo;exit + + Close the transactional-update shell: + +&prompt.sudo;exit - - Reboot your system to switch to the new snapshot. - + + Reboot your system to switch to the new snapshot. + - +
-
Check disk size @@ -239,64 +231,64 @@ in the assembly --> the available partition space before updating. If you suspect you are running short of disk space, back up your data before increasing the available space by resizing partitions, for example. There is no general - rule regarding how much space each partition should have. Space requirements - depend on your particular partitioning profile and the software selected. - - + rule regarding how much space each partition should have. Space + requirements depend on your particular partitioning profile and the + software selected. + + On a Btrfs file system, the output of df can be misleading, because in addition to the space the raw data allocates, a Btrfs file system also allocates and uses space for metadata. - - - Consequently, a Btrfs file system may report being out of space even though - it seems that plenty of space is still available. In that case, all space - allocated for the metadata is used up. - - - - Make sure there is enough free space as the root file system uses Btrfs and - might consume a significant amount of space. Check the available space on all - mounted partitions. In the worst case, an upgrade needs as much disk space - as the current root file system (without /.snapshot) - for a new snapshot. - - + + + Consequently, a Btrfs file system may report being out of space even + though it seems that plenty of space is still available. In that case, + all space allocated for the metadata is used up. + + + Make sure there is enough free space as the root file system uses Btrfs + and might consume a significant amount of space. Check the available + space on all mounted partitions. In the worst case, an upgrade needs as + much disk space as the current root file system (without + /.snapshot) for a new snapshot. + + The following recommendations have been proven: - - + + - - For all file systems, including Btrfs, you need enough free disk space to - download and install big RPMs. The space of old RPMs is only freed after - new RPMs are installed. - + + For all file systems, including Btrfs, you need enough free disk + space to download and install big RPMs. The space of old RPMs is only + freed after new RPMs are installed. + - - For Btrfs with snapshots, ensure you have at least as much free space as - your current installation requires. We recommend having twice as much - free space as the current installation. - - - If you do not have enough free space, you can try to delete old snapshots - with snapper: - - + + For Btrfs with snapshots, ensure you have at least as much free space + as your current installation requires. We recommend having twice as + much free space as the current installation. + + + If you do not have enough free space, you can try to delete old + snapshots with snapper: + + &prompt.sudo;snapper list &prompt.sudo;snapper delete NUMBER - - However, this may not help in all cases. Before migration, most snapshots - occupy only little space. - + + However, this may not help in all cases. Before migration, most + snapshots occupy only little space. + - +
Shut down virtual machine guests - If your machine serves as a &vmhost; for &kvm;, make sure to properly shut down all running &vmguest;s prior - to the update. Otherwise, you may not be able to access the guests after the - update. - + If your machine serves as a &vmhost; for &kvm;, make sure to properly + shut down all running &vmguest;s prior to the update. Otherwise, you may + not be able to access the guests after the update. +
diff --git a/tasks/Micro-upgrade-upgrading.xml b/tasks/Micro-upgrade-upgrading.xml index 92bfc73c9..27e680d95 100644 --- a/tasks/Micro-upgrade-upgrading.xml +++ b/tasks/Micro-upgrade-upgrading.xml @@ -18,75 +18,86 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - Upgrading to a new release + Upgrading to a new release + - + + - The topic covers the upgrade steps. + The topic covers the upgrade steps. - Before starting the upgrade procedure, make sure the following requirements are met: + Before starting the upgrade procedure, make sure the following requirements + are met: - + Internet connection - Make sure that your machine has a network connection throughout the entire upgrade process. + Make sure that your machine has a network connection throughout the + entire upgrade process. - - - SLE Micro 5.5 + + + SLE Micro 5.5 - The upgrade to 6.0 is possible only from the 5.5 version. If you have an older - version, upgrade to 5.5 first (see the Upgrade Guide). + The upgrade to 6.0 is possible only from the 5.5 version. If you have + an older version, upgrade to 5.5 first (see the + Upgrade + Guide). - - + + + + To start the upgrade process, proceed as follows: + + + + + Run the command: + +&prompt.sudo;transactional-update migration + + Invoking the command creates a new snapshot and refreshes the + repositories. + + + - To start the upgrade process, proceed as follows: + Enter the number of the migration target. - - - - Run the command: - - &prompt.sudo;transactional-update migration - - Invoking the command creates a new snapshot and refreshes the repositories. - - - - Enter the number of the migration target. - - - - A list of packages to be changed is displayed. Press y to continue. - - - - - If the process completes successfully, reboot your machine: - - + + + + A list of packages to be changed is displayed. Press + y to continue. + + + + + If the process completes successfully, reboot your machine: + + &prompt.sudo;reboot - - - - Failed upgrade - - If the upgrade procedure fails, you can roll back your system to a previous snapshot. - Refer to the + + + Failed upgrade + + If the upgrade procedure fails, you can roll back your system to a + previous snapshot. Refer to the + rollback - procedure. - - + procedure. + +