starlingx/docs
Code Issues Proposed changes

Fixed Errors in WRCP Distributed Cloud Upgrade management (r8, dsr8)

Browse Source 
For System Controller Upgrade:
- Moved Duplex bullet to line 61.
- Removed a note and some comands from files.
- Removed information from postreq and added new text.
- Minor updates.
- Applied some fixes according the review.
- Added --local option to the command.
- Removed the example as it is identical to the command.
- Updated Step 3. In the second paragraph.
- Updated Step 4. second paragraph;
- Updated and moved Note to correct place. same for
Upgrade All-in-One Simplex and Upgrade All-in-One Duplex / Standard docs.
For Orchestrated Subcloud Upgrade section:
Prerquisites:
- Removed the 3rd bullet and updted the first.
- Reword the Note.
- Updated bullet 7;
Procedure:
- Updated step2: max-parallel-subclouds default is 2.


Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
Change-Id: I095c6d14135d863e5117dc033028ef9e0dd79854
This commit is contained in:
Elaine Fonaro 2023-05-10 13:11:07 -03:00 committed by Elaine A Fonaro Antonio
parent 281c5645c8
commit 952c0b53ae
6 changed files with 56 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
View File

@ -6,4 +6,7 @@
.. dcupgrade-end
.. dcsubcloud-begin
.. dcsubcloud-end
.. dcsubcloud-end
.. DMupgrade-begin
.. DMupgrade-end

5
doc/source/_includes/upgrading-the-systemcontroller-using-the-cli.rest
View File

@ -6,4 +6,7 @@
.. upgradeDM-end
.. wrsbegin
.. wrsend
.. wrsend
.. DMupgrades-begin
.. DMupgrades-end

97
doc/source/dist_cloud/kubernetes/distributed-upgrade-orchestration-process-using-the-cli.rst
View File

@ -39,19 +39,15 @@ following conditions:
.. _distributed-upgrade-orchestration-process-using-the-cli-ul-blp-gcx-ry:
- The subclouds must use the Redfish platform management service if it is
an |AIO-SX| subcloud.
- Duplex (|AIO-DX|/Standard) upgrades are supported, and they do not
require remote install using Redfish.
- Redfish |BMC| is required for orchestrated subcloud upgrades. The install
values, and :command:`bmc_password` for each |AIO-SX| subcloud controller
must be provided using the following |CLI| command on the System Controller.
- The subclouds must use the Redfish platform management service if it is an
|AIO-SX| subcloud. The install values as well as `bmc_password`
for each |AIO-SX| subcloud must have already been saved in the system
controller database before the start of orchestrated subcloud upgrade.
.. note::
This is only needed if the subcloud has not already been provisioned
with the Redfish BMC password.
The following command is only required if the |AIO-SX| subcloud install
values and `bmc_password` have never been provided using
:command:`dcmanager CLI` command.
.. code-block:: none
@ -62,6 +58,9 @@ following conditions:
:ref:`Installing a Subcloud Using Redfish Platform Management Service
<installing-a-subcloud-using-redfish-platform-management-service>`.
- Duplex (|AIO-DX|/Standard) upgrades are supported, and they do not
require remote install using Redfish.
- All subclouds are clear of management-affecting alarms (with the exception of the alarm upgrade
in progress).
@ -71,18 +70,21 @@ following conditions:
command :command:`dcmanager upgrade-strategy-show`. An upgrade cannot be
orchestrated while upgrade orchestration is in progress.
- Verify the size and format of the platform-backup filesystem on each
subcloud. From the shell on each subcloud, use the following command to view
the details of the file system:
- The size and format of the persistent filesystem, /opt/platform-backup, of
each subcloud must be 30GiB (or larger) and ext4 respectively. From the shell
on a subcloud, use the following command to view the details of its
persistent file system:
:command:`df -Th /opt/platform-backup`
The type must be ext4 and the size must be 9.5GB. For example, on
The type must be ext4 and the size must be 30GiB. For example, on
controller-0, run the following command:
.. code-block:: none
~(keystone_admin)]$ df -Th /opt/platform-backup/ Filesystem Type Size Used Avail Use% Mounted on /dev/sda2 ext4 9.5G 51M 9.0G 1% /opt/platform-backup
~(keystone_admin)]$ df -Th /opt/platform-backup
Filesystem Type Size Used Avail Use% Mounted on
/dev/sda1 ext4 29G 6.9G 21G 26% /opt/platform-backup
- **If a previous upgrade has been done on the subcloud**, from the shell on
each subcloud, use the following command to remove the previous upgrade
@ -113,15 +115,16 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
+----+-----------+--------------+--------------------+-------------+
| id | name | management | availability | sync |
+----+-----------+--------------+--------------------+-------------+
| 1 | subcloud1 | managed | online | out-of-sync |
| 2 | subcloud2 | managed | online | out-of-sync |
| 3 | subcloud3 | managed | online | out-of-sync |
| 4 | subcloud4 | managed | online | out-of-sync |
| 1 | subcloud-1| managed | online | out-of-sync |
| 2 | subcloud-2| managed | online | out-of-sync |
| 3 | subcloud-3| managed | online | out-of-sync |
| 4 | subcloud-4| managed | online | out-of-sync |
+----+-----------+--------------+--------------------+-------------+
.. note::
The sync status is the rolled up sync status of platform, patching,
identity, etc.
The subclouds are out-of-sync because the load-sync-status is out-of-sync.
All of the above subclouds are not upgrade-current and, therefore, need
to be upgraded.
To see synchronization details for a subcloud, use the following command:
@ -132,7 +135,7 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
| Field | Value |
+-----------------------------+------------------------------+
| id | 1 |
| name | subcloud1 |
| name | subcloud-1 |
| description | None |
| location | None |
| software_version | nn.nn |
@ -184,7 +187,7 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
**max-parallel-subclouds**
Sets the maximum number of subclouds that can be upgraded in parallel
(default 20).
(default 2).
If this is not specified using the CLI, the values for
:command:`max_parallel_subclouds` defined for each subcloud group
@ -216,7 +219,7 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
+------------------------+----------------------------+
| strategy type | upgrade |
| subcloud apply type | parallel |
| max parallel subclouds | 10 |
| max parallel subclouds | 2 |
| stop on failure | False |
| state | initial |
| created_at | 2020-06-10T17:16:51.857207 |
@ -235,7 +238,7 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
| Field | Value |
+------------------------+----------------------------+
| subcloud apply type | parallel |
| max parallel subclouds | 20 |
| max parallel subclouds | 2 |
| stop on failure | False |
| state | initial |
| created_at | 2020-02-02T14:42:13.822499 |
@ -279,7 +282,7 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
| Field | Value |
+------------------------+----------------------------+
| subcloud apply type | parallel |
| max parallel subclouds | 20 |
| max parallel subclouds | 2 |
| stop on failure | False |
| state | applying |
| created_at | 2020-02-02T14:42:13.822499 |
@ -294,13 +297,13 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
.. code-block:: none
~(keystone_admin)]$ dcmanager strategy-step list
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
| cloud | stage | state | details | started_at | finished_at |
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
| subcloud-1 | 2 | applying... | apply phase is 66% complete | 2021-06-11 14:12:12.262001 | 2021-06-11 14:15:52.450908 |
| subcloud-4 | 2 | applying... | apply phase is 83% complete | 2021-06-11 14:16:02.457588 | None |
| subcloud-5 | 2 | finishing | | 2021-06-11 14:16:02.463213 | None |
| subcloud-6 | 2 | applying... | apply phase is 66% complete | 2021-06-11 14:16:02.473669 | None |
+------------------+-------+-----------------------+-------------------+----------------------------+----------------------------+
| cloud | stage | state | details | started_at | finished_at |
+------------------+-------+-----------------------+-------------------+----------------------------+----------------------------+
| subcloud-1 | 1 | complete | | 2021-06-11 14:12:12.262001 | 2021-06-11 14:15:52.450908 |
| subcloud-4 | 1 | activating upgrade | | 2021-06-11 14:16:02.457588 | None |
| subcloud-5 | 2 | initial | | None | None |
| subcloud-6 | 2 | initial | | None | None |
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
#. To show the step currently being performed on a subcloud, use the
@ -321,7 +324,7 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
| Field | Value |
+------------------------+----------------------------+
| subcloud apply type | parallel |
| max parallel subclouds | 20 |
| max parallel subclouds | 2 |
| stop on failure | False |
| state | deleting |
| created_at | 2020-03-23T20:04:50.992444 |
@ -330,29 +333,9 @@ dcmanager CLI or the Horizon web interface. If you prefer to use Horizon, see
.. rubric:: |postreq|
.. _distributed-upgrade-orchestration-process-using-the-cli-ul-lx1-zcv-3mb:
The secret payload should be, "username: sysinv password:<password>". If
the secret payload is, "username: admin password:<password>", see,
:ref:`Update Docker Registry Credentials on a Subcloud
<updating-docker-registry-credentials-on-a-subcloud>` for more information.
.. only:: partner
.. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
:start-after: syscontroller-begin
:end-before: syscontroller-end
:start-after: DMupgrade-begin
:end-before: DMupgrade-end
.. only:: partner
.. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
:start-after: dcupgrade-begin
:end-before: dcupgrade-end
.. only:: partner
.. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
:start-after: dcsubcloud-begin
:end-before: dcsubcloud-end

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

@ -37,13 +37,7 @@ Follow the steps below to manually upgrade the System Controller:
.. code-block:: none
~(keystone_admin)]$ system --os-region-name SystemController load-import <bootimage>.iso <bootimage>.sig
For example,
.. code-block:: none
~(keystone_admin)]$ system --os-region-name SystemController load-import <bootimage>.iso <bootimage>.sig
~(keystone_admin)]$ system --os-region-name SystemController load-import --local <bootimage>.iso <bootimage>.sig
.. note::
This can take several minutes.
@ -51,8 +45,9 @@ Follow the steps below to manually upgrade the System Controller:
#. Apply any required software updates. After the update is installed ensure
controller-0 is active.
The system must be 'patch current'. All software updates related to your
current |prod| software release must be uploaded, applied, and installed.
The system controller as well as the subclouds must be 'patch current'. All
software updates related to your current |prod| software release must be
uploaded, applied, and installed.
All software updates to the new |prod| release, only need to be uploaded
and applied. The install of these software updates will occur automatically
@ -72,7 +67,8 @@ Follow the steps below to manually upgrade the System Controller:
Check the current system health status, resolve any alarms and other issues
reported by the :command:`system health-query-upgrade` command then recheck
the system health status to confirm that all **System Health** fields are
set to **OK**.
set to **OK**. "If the upgrade health query fails 'Boot Device and Root file
system Device' check as seen below:"
.. code-block:: none
@ -96,18 +92,6 @@ Follow the steps below to manually upgrade the System Controller:
boot_device (/dev/sde) for controller-0 does not match root disk /dev/sda
rootfs_device (/dev/disk/by-path/pci-0000:00:1f.2-ata-1.0) for controller-0 does not match root disk /dev/sda
.. note::
In case "Disk space requirement: [Fail]"
Insufficient unallocated disk space on rootdisk for compute-0. Current
partitions have allocated disk space such that only 5GiB is available
but 23.5GiB unallocated disk space is needed. Insufficient total disk
space on rootdisk for controller-1, 220GiB needed, 180GiB available.
In case "Boot Device and Root file system Device: [Fail]";
boot_device (/dev/sdd) for controller-0 does not match any inventoried
disk rootfs_device for controller-1 is not assigned.
Use the following commands to correct the boot_device and/or rootfs_device
settings if you encounter an error:
@ -512,5 +496,5 @@ Follow the steps below to manually upgrade the System Controller:
.. only:: partner
.. include:: /_includes/upgrading-the-systemcontroller-using-the-cli.rest
:start-after: upgradeDM-begin
:end-before: upgradeDM-end
:start-after: DMupgrades-begin
:end-before: DMupgrades-end

21
doc/source/updates/kubernetes/upgrading-all-in-one-duplex-or-standard.rst
View File

@ -164,27 +164,6 @@ of |prod| software.
Disk space requirement: [OK]
Boot Device and Root file system Device: [OK]
.. note::
In case of "Disk space requirement: [Fail]"
Insufficient unallocated disk space on rootdisk for compute-0. Current
partitions have allocated disk space such that only 5GiB is available
but 23.5GiB unallocated disk space is needed. Insufficient total disk
space on rootdisk for controller-1, 220GiB needed, 180GiB available.
In case "Boot Device and Root file system Device: [Fail]";
boot_device (/dev/sdd) for controller-0 does not match any inventoried disk
rootfs_device for controller-1 is not assigned.
Use the following commands to correct the boot_device and/or rootfs_device
settings if you encounter an error:
.. code-block:: none
~(keystone_admin)]$ system host-lock <hostname_or_id>
~(keystone_admin)]$ system host-update <hostname_or_id> boot_device=<boot_device> rootfs_device=<rootfs_device>
~(keystone_admin)]$ system host-unlock <hostname_or_id>
By default, the upgrade process cannot be run with active alarms present.
Use the command :command:`system upgrade-start --force` to force the upgrade
process to start and ignore non-management-affecting alarms.

21
doc/source/updates/kubernetes/upgrading-all-in-one-simplex.rst
View File

@ -184,27 +184,6 @@ For more details, see :ref:`Detailed contents of a system backup
Disk space requirement: [OK]
Boot Device and Root file system Device: [OK]
.. note::
In case of "Disk space requirement: [Fail]"
Insufficient unallocated disk space on rootdisk for compute-0. Current
partitions have allocated disk space such that only 5GiB is available
but 23.5GiB unallocated disk space is needed. Insufficient total disk
space on rootdisk for controller-1, 220GiB needed, 180GiB available.
In case "Boot Device and Root file system Device: [Fail]";
boot_device (/dev/sdd) for controller-0 does not match any inventoried disk
rootfs_device for controller-1 is not assigned.
Use the following commands to correct the boot_device and/or rootfs_device
settings if you encounter an error:
.. code-block:: none
~(keystone_admin)]$ system host-lock <hostname_or_id>
~(keystone_admin)]$ system host-update <hostname_or_id> boot_device=<boot_device> rootfs_device=<rootfs_device>
~(keystone_admin)]$ system host-unlock <hostname_or_id>
By default, the upgrade process cannot be run with Active Alarms present.
However, management affecting alarms can be ignored with the
:command:`--force` option with the :command:`system upgrade-start` command