Patch Orchestration Phase Operations (dsR8)

Story: 2010584
Task: 48998

Change-Id: I48c2960362e3fd04f0175e74e2611b68e6b846f3
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Goncalves 2023-08-18 01:17:41 +00:00
parent 1f2da97166
commit f3f94b273a
12 changed files with 202 additions and 134 deletions

View File

@ -12,21 +12,30 @@ the update strategy for |prod-dc| Update Orchestration.
.. rubric:: |context|
You can apply the update strategy from the Horizon Web interface or the CLI.
To use the CLI, see :ref:`Update Management for Distributed Cloud
<update-management-for-distributed-cloud>`.
To use the CLI, see :ref:`update-management-for-distributed-cloud`.
.. rubric:: |prereq|
Before you can apply the update strategy, you must upload and apply one or more
updates to the SystemController / central update repository, create the update
strategy for subclouds, and optionally adjust the configuration settings for
updating nodes. For more information, see :ref:`Update Management for
Distributed Cloud <update-management-for-distributed-cloud>`.
Before you can apply the update strategy to the subclouds:
- Upload and apply one or more updates to the SystemController / central
update repository.
- Install the updates on the SystemController RegionOne.
- Create the update strategy for subclouds.
- Optionally adjust the configuration settings for updating nodes.
For more information, see :ref:`Update Management for Distributed Cloud
<update-management-for-distributed-cloud>`.
.. rubric:: |proc|
.. _applying-the-update-strategy-for-distributed-cloud-steps-hrv-4nl-rdb:
Use |prod-dc| patch orchestration to update the subclouds:
#. Select the **SystemController** region.
#. Select **Distributed Cloud Admin** \> **Orchestration**.
@ -37,22 +46,17 @@ Distributed Cloud <update-management-for-distributed-cloud>`.
.. image:: figures/bqu1525123082913.png
:width: 1000px
#. Click **Apply Strategy**.
To monitor the progress of the overall update orchestration, use the
**Orchestration Strategy** tab.
To monitor the progress of host updates on RegionOne of System Controller
or a subcloud, use the **Host Inventory** page on the subcloud.
To monitor the progress of host updates on a subcloud, use the **Host
Inventory** page on the subcloud.
.. seealso::
:ref:`Creating an Update Strategy for Distributed Cloud Update Orchestration
<creating-an-update-strategy-for-distributed-cloud-update-orchestration>`
:ref:`creating-an-update-strategy-for-distributed-cloud-update-orchestration`
:ref:`Customizing the Update Configuration for Distributed Cloud Update
Orchestration
<customizing-the-update-configuration-for-distributed-cloud-update-orchestration>`
:ref:`customizing-the-update-configuration-for-distributed-cloud-update-orchestration`

View File

@ -6,9 +6,8 @@
Create an Update Strategy for Distributed Cloud Update Orchestration
====================================================================
To update Central Cloud's RegionOne and the subclouds with updates in the
**Partial-Apply** state, you must create an update strategy for |prod-dc|
Update Orchestration.
To update the subclouds with updates in the **Partial-Apply** state, you must
create an update strategy for |prod-dc| Update Orchestration.
After a patch (update) has been **applied/removed/committed** on the
Central Cloud's RegionOne, the subclouds are audited and their patching sync
@ -22,15 +21,14 @@ If the Subclouds are in a **Managed** state and if the patching sync status is
Only one update strategy can exist at a time. The strategy controls how the
subclouds are updated (for example, serially or in parallel).
To determine how the nodes on the Central Cloud's RegionOne and each subcloud
are updated, the update strategy refers to separate configuration settings
available on the Cloud Patching Configuration tab.
To determine how the nodes on each subcloud are updated, the update strategy
refers to separate configuration settings available on the Cloud Patching
Configuration tab.
.. rubric:: |prereq|
You must be in **SystemController** region. To change the region, see
:ref:`RegionOne and SystemController Modes
<regionone-and-systemcontroller-modes>`.
:ref:`regionone-and-systemcontroller-modes`.
.. rubric:: |proc|
@ -96,11 +94,9 @@ You must be in **SystemController** region. To change the region, see
.. image:: figures/update-strategy-3.png
:width: 444
#. Adjust how nodes are updated on RegionOne and the subclouds.
#. Adjust how nodes are updated on the subclouds.
See :ref:`Customizing the Update Configuration for Distributed Cloud Update
Orchestration
<customizing-the-update-configuration-for-distributed-cloud-update-orchestration>`.
See :ref:`customizing-the-update-configuration-for-distributed-cloud-update-orchestration`.
#. Click **Create Strategy**.
@ -120,9 +116,7 @@ You must be in **SystemController** region. To change the region, see
.. seealso::
:ref:`Customizing the Update Configuration for Distributed Cloud Update
Orchestration <customizing-the-update-configuration-for-distributed-cloud-update-orchestration>`
:ref:`customizing-the-update-configuration-for-distributed-cloud-update-orchestration`
:ref:`Applying the Update Strategy for Distributed Cloud
<applying-the-update-strategy-for-distributed-cloud>`
:ref:`applying-the-update-strategy-for-distributed-cloud`

View File

@ -6,15 +6,14 @@
Customize the Update Configuration for Distributed Cloud Update Orchestration
=============================================================================
You can adjust how the nodes in each system (Central Cloud's RegionOne and/or
Subclouds) are updated.
You can adjust how the nodes in each subcloud are updated.
.. rubric:: |context|
The update strategy for |prod-dc| Update Orchestration uses separate
configuration settings to control how the nodes on a given system are updated.
You can adjust the settings used by default for Central Cloud's RegionOne and
all subclouds, and you can create custom settings for individual subclouds.
You can adjust the settings used by default for all subclouds, and you can
create custom settings for individual subclouds.
You can change the configuration settings before or after creating a update
strategy for |prod-dc| update orchestration. The settings are maintained
@ -35,8 +34,8 @@ independently.
Take one of the following actions:
- To edit the settings applicable to RegionOne and all subclouds by
default, click **Edit Configuration** in the **all clouds default** row.
- To edit the settings applicable to all subclouds by default, click
**Edit Configuration** in the **all clouds default** row.
.. image:: figures/brk1525194697928.png
@ -88,16 +87,14 @@ independently.
.. rubric:: |postreq|
For information about creating and applying a patch strategy, see :ref:`Update
Management for Distributed Cloud <update-management-for-distributed-cloud>`.
For information about creating and applying a patch strategy, see
:ref:`update-management-for-distributed-cloud`.
**Related information**
.. seealso::
:ref:`Creating an Update Strategy for Distributed Cloud Update
Orchestration <creating-an-update-strategy-for-distributed-cloud-update-orchestration>`
:ref:`creating-an-update-strategy-for-distributed-cloud-update-orchestration`
:ref:`Applying the Update Strategy for Distributed Cloud
<applying-the-update-strategy-for-distributed-cloud>`
:ref:`applying-the-update-strategy-for-distributed-cloud`

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

View File

@ -10,9 +10,8 @@ You can review updates across the |prod-dc| from the Horizon Web interface.
.. rubric:: |context|
If you prefer, you can use the |CLI|. For more information, see :ref:`Reviewing
Update Status for Distributed Cloud Using the CLI
<reviewing-update-status-for-distributed-cloud-using-the-cli>`.
If you prefer, you can use the |CLI|. For more information, see
:ref:`reviewing-update-status-for-distributed-cloud-using-the-cli`.
From Horizon, you can use only the **SystemController** region to
review updates in the central update repository and the update sync status of
@ -40,12 +39,10 @@ subclouds.
Update (or Patch) Sync Status is part of the overall Sync status of a
subcloud. To review the synchronization status of subclouds, see
:ref:`Monitoring Subclouds Using Horizon
<monitoring-subclouds-using-horizon>`.
:ref:`monitoring-subclouds-using-horizon`.
.. rubric:: |postreq|
To update the SystemController's central update repository, see :ref:`Reviewing
Update Status for Distributed Cloud Using the CLI
<reviewing-update-status-for-distributed-cloud-using-the-cli>`.
To update the SystemController's central update repository, see
:ref:`uploading-and-applying-updates-to-systemcontroller-using-horizon`.

View File

@ -34,21 +34,18 @@ updates. The workflow for patching is as follows:
#. Review the update status of the systems in the |prod-dc|.
See :ref:`Reviewing Update Status for Distributed Cloud Using Horizon
<reviewing-update-status-for-distributed-cloud-using-horizon>`.
See :ref:`reviewing-update-status-for-distributed-cloud-using-horizon`.
#. Upload and apply any required updates to the System Controller. This adds
them to a Central Update Repository, making them available to the
SystemController and all subclouds.
See :ref:`Uploading and Applying Updates to SystemController Using Horizon
<uploading-and-applying-updates-to-systemcontroller-using-horizon>`.
See :ref:`uploading-and-applying-updates-to-systemcontroller-using-horizon`.
#. Update the Central Cloud's RegionOne and all subclouds with the updates
using update orchestration.
See :ref:`Update Orchestration of Central Cloud's RegionOne and Subclouds
<update-orchestration-of-central-clouds-regionone-and-subclouds>`.
See :ref:`update-orchestration-of-central-clouds-regionone-and-subclouds`.
.. note::
For |prod-dc|, manual updating of individual subclouds is not recommended.

View File

@ -2,30 +2,29 @@
.. fql1558615252466
.. _update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli:
=============================================================================
Update Orchestration of Central Cloud's RegionOne and Subclouds Using the CLI
=============================================================================
===============================================
Update Orchestration of Subclouds Using the CLI
===============================================
For |prod-dc| update orchestration, you can use the :command:`dcmanager`
commands from the command line interface. These are similar to the
:command:`sw-manager` commands used to define and execute update strategies on
non-distributed systems.
non-distributed systems, or on the SystemController RegionOne.
.. contents:: |minitoc|
:local:
:depth: 1
To use the Horizon Web interface instead, see :ref:`Update Orchestration of
Central Cloud's RegionOne and Subclouds
<update-orchestration-of-central-clouds-regionone-and-subclouds>`.
To use the Horizon Web interface instead, see
:ref:`update-orchestration-of-central-clouds-regionone-and-subclouds`.
.. note::
Before you can use |prod-dc| update orchestration, you must upload and
apply one or more updates to the SystemController / central update
repository. For more information, see :ref:`Uploading and Applying Updates
to SystemController Using the CLI
<uploading-and-applying-updates-to-systemcontroller-using-the-cli>`.
repository, and then update the RegionOne. For more information, see
:ref:`uploading-and-applying-updates-to-systemcontroller-using-the-cli`.
.. _update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli-section-N10087-N10029-N10001:
@ -35,7 +34,7 @@ Patch Strategy Settings
-----------------------
The update strategy for a |prod-dc| system controls how updates are applied to
the Central Cloud's RegionOne and the subclouds. The following settings are
the subclouds. The following settings are
available:
**subcloud apply type**
@ -57,6 +56,10 @@ available:
true (default) or false — determines whether update orchestration failure
for a subcloud prevents application to subsequent subclouds.
**upload only**
the patch strategy will only upload the necessary patches to the subclouds,
without executing the other steps (apply, install, reboot, etc.).
.. _update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli-ul-blq-nmx-fdb:
@ -68,6 +71,7 @@ available:
[--subcloud-apply-type <type>] \
[-max-parallel-subclouds <i>] \
[-stop-on-failure <level>] \
[--upload-only] \
[--group group] \
[<subcloud>]
@ -92,9 +96,40 @@ available:
You can optionally pass the name or ID of a subcloud group to the
:command:`patch-strategy create` command. This results in a strategy
that is applied only to the System Controller and all subclouds in the
specified group. The subcloud group values are used for subcloud apply
type and max parallel subclouds parameters.
that is applied only to all subclouds in the specified group. The
subcloud group values are used for subcloud apply type and max parallel
subclouds parameters.
To only upload the necessary patches to the subclouds, without executing
the other steps (apply, install, reboot, etc.), use the
:command:`patch-strategy create --upload-only` command.
.. code-block:: none
~(keystone_admin)]$ dcmanager patch-strategy create --upload-only
+------------------------+----------------------------+
| Field | Value |
+------------------------+----------------------------+
| strategy type | patch |
| subcloud apply type | None |
| max parallel subclouds | None |
| stop on failure | False |
| upload only | True |
| state | initial |
| created_at | 2023-03-08T13:58:50.130629 |
| updated_at | None |
+------------------------+----------------------------+
.. note::
This is useful to reduce the total time it takes to run the
orchestration during a system maintenance window by enabling the user
to upload the patches to the subclouds before the system maintenance
window.
If the ``--upload-only`` option is used, the ``updating patches`` state
skips directly to the ``complete`` state once the patches are uploaded
to the subclouds.
- To show the settings for the update strategy, use the
:command:`patch-strategy show` command.
@ -149,11 +184,10 @@ available:
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
| cloud | stage | state | details | started_at | finished_at |
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
| SystemController | 1 | complete | | 2018-03-13 14:12:12.262001 | 2018-03-13 14:15:52.450908 |
| subcloud-1 | 2 | applying... | apply phase is 66% complete | 2018-03-13 14:16:02.457588 | None |
| subcloud-4 | 2 | applying... | apply phase is 83% complete | 2018-03-13 14:16:02.463213 | None |
| subcloud-5 | 2 | finishing | | 2018-03-13 14:16:02.473669 | None |
| subcloud-6 | 2 | applying... | apply phase is 66% complete | 2018-03-13 14:16:02.483422 | None |
| subcloud-1 | 1 | applying... | apply phase is 66% complete | 2018-03-13 14:16:02.457588 | None |
| subcloud-4 | 1 | applying... | apply phase is 83% complete | 2018-03-13 14:16:02.463213 | None |
| subcloud-5 | 1 | finishing | | 2018-03-13 14:16:02.473669 | None |
| subcloud-6 | 1 | applying... | apply phase is 66% complete | 2018-03-13 14:16:02.483422 | None |
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
- To show the step currently being performed on a subcloud, use the
@ -199,9 +233,9 @@ available:
Configuration for Specific Subclouds
------------------------------------
To determine how updates are applied to the nodes on each subcloud and on
RegionOne, the update strategy refers to separate configuration settings. The
following settings are applied by default:
To determine how updates are applied to the nodes on each subcloud, the update
strategy refers to separate configuration settings. The following settings are
applied by default:
.. _update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli-ul-sgb-p34-gdb:
@ -296,7 +330,7 @@ individual subclouds.
**alarm restriction type**
relaxed or strict — determines whether the orchestration is aborted for
alarms that are not management-affecting. For more information, refer
to |updates-doc|: :ref:`Configure Update Orchestration <configuring-update-orchestration>`.
to |updates-doc|: :ref:`configuring-update-orchestration`.
**default instance action**
.. note::

View File

@ -2,22 +2,20 @@
.. mmg1558615549438
.. _update-orchestration-of-central-clouds-regionone-and-subclouds:
===============================================================
Update Orchestration of Central Cloud's RegionOne and Subclouds
===============================================================
=================================
Update Orchestration of Subclouds
=================================
You can use update orchestration to automate software updates across the
Central Cloud's RegionOne and all subclouds in the |prod-dc|.
You can use update orchestration to automate software updates across all
subclouds in the |prod-dc|.
You can use the Horizon Web interface or the CLI. To use the CLI, see
:ref:`Update Orchestration of Central Cloud's RegionOne and Subclouds Using the
CLI
<update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli>`.
:ref:`update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli`.
.. note::
Patch orchestration is the recommended method for updating software on a
|prod-dc| system. Do not update RegionOne or individual subclouds manually.
|prod-dc| system. Do not update individual subclouds manually.
To use update orchestration, complete the following workflow:
@ -27,35 +25,35 @@ To use update orchestration, complete the following workflow:
#. Ensure that the required updates are uploaded and applied to the
SystemController / central update repository.
For more information, see :ref:`Uploading and Applying Updates to
SystemController Using Horizon
<uploading-and-applying-updates-to-systemcontroller-using-horizon>`.
For more information, see
:ref:`uploading-and-applying-updates-to-systemcontroller-using-horizon`.
#. Update the RegionOne, for more information see
:ref:`uploading-and-applying-updates-to-systemcontroller-using-horizon-update-the-regionone`.
#. Create an update strategy for the |prod-dc| update orchestration.
See :ref:`Creating an Update Strategy for Distributed Cloud Update
Orchestration
<creating-an-update-strategy-for-distributed-cloud-update-orchestration>`.
See :ref:`creating-an-update-strategy-for-distributed-cloud-update-orchestration`.
#. Optionally, customize the configuration settings used by the update strategy.
The update strategy is applied to the Central Cloud's RegionOne and all
subclouds using default configuration settings. You can change these
settings, and you can create custom settings for individual subclouds. For
more information, see :ref:`Customizing the Update Configuration for
Distributed Cloud Update Orchestration
<customizing-the-update-configuration-for-distributed-cloud-update-orchestration>`.
The update strategy is applied to all subclouds using default configuration
settings. You can change these settings, and you can create custom settings
for individual subclouds. For more information, see
:ref:`customizing-the-update-configuration-for-distributed-cloud-update-orchestration`.
#. Apply the strategy for the |prod-dc| update orchestration.
See :ref:`Applying the Update Strategy for Distributed Cloud
<applying-the-update-strategy-for-distributed-cloud>`.
See :ref:`applying-the-update-strategy-for-distributed-cloud`.
As each subcloud is updated, it moves through the following states:
**initial**
The update has not started.
**pre-check**
Subcloud alarm status is being checked for management-affecting alarms.
**updating patches**
Patches are being updated to synchronize with System Controller
updates.
@ -67,9 +65,9 @@ To use update orchestration, complete the following workflow:
The strategy is being applied in the subcloud.
**finishing**
updates that are no longer required are being deleted
Updates that are no longer required are being deleted.
updates that require committing are being committed
Updates that require committing are being committed.
**complete**
Updating has been completed successfully.
@ -79,13 +77,10 @@ To use update orchestration, complete the following workflow:
.. seealso::
:ref:`Creating an Update Strategy for Distributed Cloud Update
Orchestration <creating-an-update-strategy-for-distributed-cloud-update-orchestration>`
:ref:`creating-an-update-strategy-for-distributed-cloud-update-orchestration`
:ref:`Customizing the Update Configuration for Distributed Cloud Update
Orchestration <customizing-the-update-configuration-for-distributed-cloud-update-orchestration>`
:ref:`Applying the Update Strategy for Distributed Cloud
<applying-the-update-strategy-for-distributed-cloud>`
:ref:`customizing-the-update-configuration-for-distributed-cloud-update-orchestration`
:ref:`applying-the-update-strategy-for-distributed-cloud`

View File

@ -2,18 +2,17 @@
.. iru1558615665841
.. _uploading-and-applying-updates-to-systemcontroller-using-horizon:
=============================================================
Upload and Applying Updates to SystemController Using Horizon
=============================================================
==========================================================
Upload and Apply Updates to SystemController Using Horizon
==========================================================
You can upload and apply updates (patches) to the SystemController in order
to update the central update repository, from the Horizon Web interface.
.. rubric:: |context|
If you prefer, you can use the |CLI|. For more information, see :ref:`Uploading
and Applying Updates to SystemController Using the CLI
<uploading-and-applying-updates-to-systemcontroller-using-the-cli>`.
If you prefer, you can use the |CLI|. For more information, see
:ref:`uploading-and-applying-updates-to-systemcontroller-using-the-cli`.
.. rubric:: |proc|
@ -44,10 +43,44 @@ and Applying Updates to SystemController Using the CLI
The state is updated to **Partial-Apply**.
.. _uploading-and-applying-updates-to-systemcontroller-using-horizon-update-the-regionone:
--------------------
Update the RegionOne
--------------------
To fully patch the Central Cloud's RegionOne through Horizon:
#. Upload and apply updates to SystemController region, for more details see
:ref:`configuring-update-orchestration`.
#. Update the RegionOne region:
#. Change to the RegionOne region (top left drop-down menu).
.. image:: figures/regionone.png
#. Go to **Admin** \> **Platform** \> **Software Management** and open the
**Patch Orchestration** tab.
#. Select **Create Strategy**.
#. Create an update strategy by specifying settings for the parameters in
the **Create Strategy** dialog box.
#. Click **Apply Strategy** to apply the update strategy.
To update the RegionOne using the CLI see :ref:`update-orchestration-cli`.
.. note::
This procedure closely resembles what is described in
:ref:`configuring-update-orchestration`. The key difference lies in the
necessity to preselect RegionOne.
.. rubric:: |postreq|
To update the software on the System Controller and subclouds, you must use the
|prod-dc| Update Orchestration. For more information, see :ref:`Update
Orchestration of Central Cloud's RegionOne and Subclouds
<update-orchestration-of-central-clouds-regionone-and-subclouds>`.
|prod-dc| Update Orchestration. For more information, see
:ref:`update-orchestration-of-central-clouds-regionone-and-subclouds`.

View File

@ -13,10 +13,9 @@ for |prod|. For |prod-dc|, you must include an additional |CLI| parameter.
.. rubric:: |context|
If you prefer, you can use the Horizon Web interface. For more information, see
:ref:`Uploading and Applying Updates to SystemController Using Horizon
<uploading-and-applying-updates-to-systemcontroller-using-horizon>`, however
the specific procedure for incrementally uploading and applying one or more
patches for the SystemController is provided below.
:ref:`uploading-and-applying-updates-to-systemcontroller-using-horizon`,
however the specific procedure for incrementally uploading and applying one or
more patches for the SystemController is provided below.
For standard |prod| updating procedures, see the |updates-doc|:
:ref:`software-updates-and-upgrades-software-updates` guide.
@ -51,7 +50,7 @@ SystemController when using |CLI| :command:`sw-patch` commands.
.. _uploading-and-applying-updates-to-systemcontroller-using-the-cli-steps-scm-jkx-fdb:
#. Log in as the **sysadmin** user.
#. Copy all patches to be uploaded and applied to ``/home/sysadmin/patches/``.
@ -63,12 +62,13 @@ SystemController when using |CLI| :command:`sw-patch` commands.
~(keystone_admin)]$ sw-patch upload-dir /home/sysadmin/patches --os-region-name SystemController
.. note::
You may receive a warning about the update already being imported. This
is expected and occurs if the update was uploaded locally to the system
controller. The warning will only occur for patches that were applied
to controller-0 (system controller) before it was first unlocked.
#. Confirm that the newly uploaded patches have a status of **available**.
.. code-block:: none
@ -87,9 +87,26 @@ SystemController when using |CLI| :command:`sw-patch` commands.
~(keystone_admin)]$ sw-patch query --os-region-name SystemController
#. To update the RegionOne, create the patch strategy using:
.. code-block:: none
~(keystone_admin)]$ sw-manager patch-strategy create
#. Apply the patch strategy:
.. code-block:: none
~(keystone_admin)]$ sw-manager patch-strategy apply
.. note::
The system controller is not included in the |DC| patch orchestration
strategy anymore. You need to patch the system controller before using
|DC| orchestration to patch the subclouds.
.. rubric:: |postreq|
To update the software on the System Controller and subclouds, you must use the
|prod-dc| Update Orchestration. For more information, see :ref:`Update
Orchestration of Central Cloud's RegionOne and Subclouds
<update-orchestration-of-central-clouds-regionone-and-subclouds>`.
To update the software on the subclouds, you must use the |prod-dc| Update
Orchestration. For more information, see
:ref:`update-orchestration-of-central-clouds-regionone-and-subclouds`.

View File

@ -11,7 +11,7 @@ command is used for corrective content (bug fixes) -type updates to the
running containerized openstack application.
This means that the system application-update -n |prefix|-openstack is **not**
used for upgrading between OpenStack releases (e.g. Train to Ussuri). The
used for upgrading between OpenStack releases (e.g. Train to Antelope). The
:command:`system application-update` assumes that there is no data schema
changes or data migration required in order to update to the new openstack
container image\(s).