starlingx/docs
Code Issues Proposed changes

Merge "Upgrade documentation comments/suggestions (r8, ds8)"

Browse Source
This commit is contained in:
Zuul 2023-09-29 13:51:23 +00:00 committed by Gerrit Code Review
commit 0ebc1a330d
2 changed files with 45 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/dist_cloud/kubernetes/upgrade-management-overview.rst
View File

@ -14,9 +14,9 @@ release of |prod| software.
.. note::
Backup all yaml files that are updated using the Redfish Platform
Management service. For more information, see :ref:`Installing a Subcloud
Using Redfish Platform Management Service
<installing-a-subcloud-using-redfish-platform-management-service>`.
Management service. For more information, see
:ref:`installing-a-subcloud-using-redfish-platform-management-service`.
For information on back up and restore, see :ref:`backing-up-starlingx-system-data`.
You can use the |CLI| to manage upgrades. The workflow for upgrades is as
follows:
@ -25,15 +25,12 @@ follows:
.. _upgrade-management-overview-ol-uqv-p24-3mb:
#. To upgrade the |prod-dc| system, you must first upgrade the
System Controller. See :ref:`Upgrading the System Controller Using the CLI
<upgrading-the-systemcontroller-using-the-cli>`.
System Controller. See :ref:`upgrading-the-systemcontroller-using-the-cli`.
#. Use |prod-dc| Upgrade Orchestration to upgrade the subclouds. See
:ref:`Distributed Upgrade Orchestration Process Using the CLI <distributed-upgrade-orchestration-process-using-the-cli>`.
:ref:`distributed-upgrade-orchestration-process-using-the-cli`.
#. To handle errors during an orchestrated upgrade, see :ref:`Error
Handling During An Orchestrated Upgrade
<robust-error-handling-during-an-orchestrated-upgrade>`.
#. To handle errors during an orchestrated upgrade, see :ref:`robust-error-handling-during-an-orchestrated-upgrade`.
.. rubric:: |prereq|
@ -41,7 +38,8 @@ For all deployment configurations, end user container images in
`registry.local` will be backed up during the upgrade process. This only
includes images other than |prod| system and application images. These images
are limited to 5 GB in total size. If the system contains more than 5 GB of
these images, the upgrade start will fail.
these images, the upgrade start will fail. For information on back up and restore,
see :ref:`backing-up-starlingx-system-data`.
The following prerequisites apply to a |prod-dc| upgrade management service.

49
doc/source/dist_cloud/kubernetes/upgrading-the-systemcontroller-using-the-cli.rst
View File

@ -7,14 +7,14 @@
Upgrade the System Controller Using the CLI
===========================================
You can upload and apply upgrades to the System Controller in order to upgrade
the central repository, from the CLI. The System Controller can be upgraded
You can upload and apply upgrades to the system controller in order to upgrade
the central repository, from the CLI. The system controller can be upgraded
using either a manual software upgrade procedure or by using the
non-distributed systems :command:`sw-manager` orchestration procedure.
.. rubric:: |context|
Follow the steps below to manually upgrade the System Controller:
Follow the steps below to manually upgrade the system controller:
.. rubric:: |prereq|
@ -45,6 +45,14 @@ Follow the steps below to manually upgrade the System Controller:
~(keystone_admin)]$ system --os-region-name SystemController load-import --local <bootimage>.iso <bootimage>.sig
.. note::
Move the iso to ``/opt/backups`` before importing the load to avoid any
disk space issues during the load import.
.. note::
If you face any issue while importing the load, go to
``/var/log/load-import.log`` and examine the error messages.
.. note::
This can take several minutes. After the system controller is successfully
upgraded, the old load (which is in imported state) should not be deleted
@ -193,8 +201,12 @@ Follow the steps below to manually upgrade the System Controller:
~(keystone_admin)]$ system host-upgrade controller-1
Wait for controller-1 to reinstall with the load N+1 and becomes
**locked-disabled-online** state.
Wait for controller-1 to reinstall with the load N+1 and enter the
``locked-disabled-online`` state.
Controller-1 must boot using |PXE| from the internal management network, that
is, controller-1 must boot from the interface that is connected to
controller-0's management network interface.
The following data migration states apply when this command is executed.
@ -251,8 +263,9 @@ Follow the steps below to manually upgrade the System Controller:
~(keystone_admin)]$ system host-unlock controller-1
Wait for controller-1 to become **unlocked-enabled**. Wait for the DRBD
sync **400.001** Services-related alarm is raised and then cleared.
Wait for controller-1 to enter the ``unlocked-enabled`` state. Wait until
the DRBD sync **400.001** Services-related alarm has been raised and then
cleared.
The following states apply when this command is executed.
@ -291,31 +304,43 @@ Follow the steps below to manually upgrade the System Controller:
Continue the remaining steps below to manually upgrade or use upgrade
orchestration to upgrade the remaining nodes.
#. Upgrade **controller-0**.
#. Upgrade controller-0.
For more information, see :ref:`Updates and Upgrades
<software-updates-and-upgrades-software-updates>`.
#. Lock **controller-0**.
#. Lock controller-0.
.. code-block:: none
~(keystone_admin)]$ system host-lock controller-0
#. Upgrade **controller-0**.
#. Upgrade controller-0.
.. code-block:: none
~(keystone_admin)]$ system host-upgrade controller-0
.. note::
Controller-0 must pxe-boot from the management network and not from
any pxe-boot server. Also, ensure that the |NIC| sequence is correct.
#. Unlock **controller-0**.
#. Unlock controller-0.
.. code-block:: none
~(keystone_admin)]$ system host-unlock controller-0
You may encounter the following error message:
Wait until the DRBD sync **400.001** Services-related alarm is raised
.. code-block:: none
Expecting number of interface sriov_numvfs=16. Please wait a few
minutes for inventory update and retry host-unlock.
If you see this error message, you need to retry after 5 minutes.
Wait until the DRBD sync **400.001** Services-related alarm has been raised
and then cleared before proceeding to the next step.