Distributed Upgrade Orchestration Process Using the CLI

Distributed upgrade orchestration can be initiated after the System Controller has been successfully upgraded.

About this task

The user first creates a distributed upgrade orchestration strategy, or plan, for the automated upgrade procedure. This customizes the upgrade orchestration, using parameters to specify:

  • whether to stop on failure of a subcloud upgrade or continue with the next subcloud

  • whether to upgrade hosts serially or in parallel

Based on these parameters, and the state of the subclouds, the upgrade orchestration creates a number of stages for the overall upgrade strategy. All the subclouds that are included in the same stage will be upgraded in parallel.

Prerequisites

Distributed upgrade orchestration can only be done on a system that meets the following conditions:

  • 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 bmc_password for each AIO-SX subcloud controller must be provided using the following CLI command on the System Controller.

    Note

    This is only needed if the subcloud has not already been provisioned with the Redfish BMC password.

    ~(keystone_admin)]$ dcmanager subcloud update subcloud1 --install-values\
install-values.yaml --bmc-password <password>

    For more information on install-values.yaml file, see Installing a Subcloud Using Redfish Platform Management Service.

  • All subclouds are clear of management-affecting alarms (with the exception of the alarm upgrade in progress).

  • All hosts of all subclouds must be unlocked, enabled, and available.

  • No distributed upgrade orchestration strategy exists, to verify use the 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:

    df -Th /opt/platform-backup

    The type must be ext4 and the size must be 9.5GB. For example, on controller-0, run the following command:

    ~(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

  • 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 data:

    sudo rm /opt/platform-backup/upgrade_data*

Procedure

  1. Review the upgrade status for the subclouds.

    After the System Controller upgrade is completed, wait for 10 minutes for the load_sync_status of all subclouds to be updated.

    To identify which subclouds are upgrade-current (in-sync), use the subcloud list command. For example:

    ~(keystone_admin)]$ dcmanager subcloud list
+----+-----------+--------------+--------------------+-------------+
| 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 |
+----+-----------+--------------+--------------------+-------------+

    Note

    The sync status is the rolled up sync status of platform, patching, identity, etc.

    To see synchronization details for a subcloud, use the following command:

    ~(keystone_admin)]$ dcmanager subcloud show subcloud1
+-----------------------------+------------------------------+
| Field                       | Value                        |
+-----------------------------+------------------------------+
| id                          | 1                            |
| name                        | subcloud1                    |
| description                 | None                         |
| location                    | None                         |
| software_version            | nn.nn                        |
| management                  | managed                      |
| availability                | online                       |
| deploy_status               | complete                     |
| management_subnet           | fd01:82::0/64                |
| management_start_ip         | fd01:82::2                   |
| management_end_ip           | fd01:82::11                  |
| management_gateway_ip       | fd01:82::1                   |
| systemcontroller_gateway_ip | fd01:81::1                   |
| group_id                    | 1                            |
| created_at                  | 2021-06-07 21:05:16.224664   |
| updated_at                  | 2021-06-09 20:01:37.525012   |
| dc-cert_sync_status         | in-sync                      |
| firmware_sync_status        | in-sync                      |
| identity_sync_status        | in-sync                      |
| kubernetes_sync_status      | in-sync                      |
| load_sync_status            | out-of-sync                  |
| patching_sync_status        | in-sync                      |
| platform_sync_status        | in-sync                      |
+-----------------------------+------------------------------+

  2. To create an upgrade strategy, use the dcmanager upgrade-strategy create command.

    The upgrade strategy for a Distributed Cloud system controls how upgrades are applied to subclouds.

    ~(keystone_admin)]$ dcmanager upgrade-strategy create \
[--subcloud-apply-type <type>] \
[–-max-parallel-subclouds <i>] \
[–-stop-on-failure <level>] \
[--group group] \
[--force] \
[<subcloud>]

    where:

    subcloud-apply-type

    parallel or serial— determines whether the subclouds are upgraded in parallel, or serially.

    If this is not specified using the CLI, the values for subcloud_update_type defined for each subcloud group will be used by default.

    max-parallel-subclouds

    Sets the maximum number of subclouds that can be upgraded in parallel (default 20).

    If this is not specified using the CLI, the values for max_parallel_subclouds defined for each subcloud group will be used by default.

    stop-on-failure

    true(default) or false— determines whether upgrade orchestration failure for a subcloud prevents application to subsequent subclouds.

    group

    Optionally pass the name or ID of a subcloud group to the dcmanager upgrade-strategy create command. This results in a strategy that is only applied to all subclouds in the specified group. The subcloud group values are used for subcloud apply type and max parallel subclouds parameters.

    force

    Upgrade both online and offline subclouds. Can be used for a single subcloud, or a subcloud group.

    For example:

    ~(keystone_admin)]$ dcmanager upgrade-strategy create
+------------------------+----------------------------+
| Field                  | Value                      |
+------------------------+----------------------------+
| strategy type          | upgrade                    |
| subcloud apply type    | parallel                   |
| max parallel subclouds | 10                         |
| stop on failure        | False                      |
| state                  | initial                    |
| created_at             | 2020-06-10T17:16:51.857207 |
| updated_at             | None                       |
+------------------------+----------------------------+

  3. To show the settings for the upgrade strategy, use the dcmanager upgrade-strategy show command.

    For example:

    ~(keystone_admin)]$ dcmanager upgrade-strategy show
+------------------------+----------------------------+
| Field                  | Value                      |
+------------------------+----------------------------+
| subcloud apply type    | parallel                   |
| max parallel subclouds | 20                         |
| stop on failure        | False                      |
| state                  | initial                    |
| created_at             | 2020-02-02T14:42:13.822499 |
| updated_at             | None                       |
+------------------------+----------------------------+

    Note

    The values for subcloud apply type and max parallel subclouds will be taken from the subcloud group if specified through the --group parameter.

  4. Review the upgrade strategy for the subclouds.

    To show the subclouds that will be upgraded when the upgrade strategy is applied, use the dcmanager strategy-step list command. For example:

    ~(keystone_admin)]$ dcmanager strategy-step list
+------------------+-------+---------+---------+------------+-------------+
| cloud            | stage | state   | details | started_at | finished_at |
+------------------+-------+---------+---------+------------+-------------+
| subcloud-1       |     1 | initial |         | None       | None        |
| subcloud-4       |     1 | initial |         | None       | None        |
| subcloud-5       |     2 | initial |         | None       | None        |
| subcloud-6       |     2 | initial |         | None       | None        |
+------------------+-------+---------+---------+------------+-------------+

    Note

    All the subclouds that are included in the same stage will be upgraded in parallel.

  5. To apply the upgrade strategy, use the dcmanager upgrade-strategy apply command.

    ~(keystone_admin)]$ dcmanager upgrade-strategy apply
+------------------------+----------------------------+
| Field                  | Value                      |
+------------------------+----------------------------+
| subcloud apply type    | parallel                   |
| max parallel subclouds | 20                         |
| stop on failure        | False                      |
| state                  | applying                   |
| created_at             | 2020-02-02T14:42:13.822499 |
| updated_at             | 2020-02-02T14:42:19.376688 |
+------------------------+----------------------------+

    Warning

    Do not log in to the subcloud using the sysadmin account during an upgrade procedure. During an upgrade, the subcloud password is reset to the default value and is subsequently resynced, and any login attempt during the upgrade will fail. Also, consecutive unsuccessful login attempts may lock your account.

  6. To show the step currently being performed on each of the subclouds, use the dcmanager strategy-step list command.

    For example:

    ~(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                       |
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+

  7. To show the step currently being performed on a subcloud, use the dcmanager strategy-step show <subcloud> command.

    ~(keystone_admin)]$ dcmanager strategy-step show <subcloud>

  8. When all the subclouds within the distributed upgrade orchestration indicate they have entered the complete state, delete the upgrade strategy, using the dcmanager upgrade-strategy delete command.

    ~(keystone_admin)]$ dcmanager upgrade-strategy delete
+------------------------+----------------------------+
| Field                  | Value                      |
+------------------------+----------------------------+
| subcloud apply type    | parallel                   |
| max parallel subclouds | 20                         |
| stop on failure        | False                      |
| state                  | deleting                   |
| created_at             | 2020-03-23T20:04:50.992444 |
| updated_at             | 2020-03-23T20:05:14.157352 |
+------------------------+----------------------------+

Postrequisites

The secret payload should be, “username: sysinv password:<password>”. If the secret payload is, “username: admin password:<password>”, see, Update Docker Registry Credentials on a Subcloud for more information.

Note

Before attempting to log in to the subclouds using the sysadmin account, verify that the subcloud platform_sync_status is synced. This would ensure that the sysadmin password is successfully resynced to the subclouds and that login attempts do not fail.