From aa5d9403714941da0edd497b4388dd4a0b50189e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elisamara=20Aoki=20Gon=C3=A7alves?= Date: Mon, 18 Nov 2024 18:56:26 +0000 Subject: [PATCH] Review of USM Doc Updates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Final comments on the USM doc updates. Add note. Change-Id: I836f0672bf1b99494e1a21c730395ea9958ad5e7 Signed-off-by: Elisamara Aoki Gonçalves --- doc/source/_includes/upgrade-note.rest | 2 ++ .../index-updates-kub-03d4d10fa0be.rst | 6 +++++ ...software-updates-upgrades-06d6de90bbd0.rst | 8 +++---- ...-host-software-deployment-ee17ec6f71a4.rst | 12 +++++----- ...-host-software-deployment-9295ce1e6e29.rst | 8 +++---- ...-host-software-deployment-d234754c7d20.rst | 22 ++++++++++++------- 6 files changed, 37 insertions(+), 21 deletions(-) create mode 100644 doc/source/_includes/upgrade-note.rest diff --git a/doc/source/_includes/upgrade-note.rest b/doc/source/_includes/upgrade-note.rest new file mode 100644 index 000000000..443fa0efa --- /dev/null +++ b/doc/source/_includes/upgrade-note.rest @@ -0,0 +1,2 @@ +.. important-begin +.. important-end \ No newline at end of file diff --git a/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst b/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst index 383598f9b..f4105e1ad 100644 --- a/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst +++ b/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst @@ -2,6 +2,12 @@ .. include:: /_includes/toc-title-updates-kub.rest +.. only:: partner + + .. include:: /_includes/upgrade-note.rest + :start-after: important-begin + :end-before: important-end + .. only:: partner .. include:: /updates/index-updates-e3b970bb69ce.rst diff --git a/doc/source/updates/kubernetes/introduction-platform-software-updates-upgrades-06d6de90bbd0.rst b/doc/source/updates/kubernetes/introduction-platform-software-updates-upgrades-06d6de90bbd0.rst index 0637efc7c..9ea8a5f22 100644 --- a/doc/source/updates/kubernetes/introduction-platform-software-updates-upgrades-06d6de90bbd0.rst +++ b/doc/source/updates/kubernetes/introduction-platform-software-updates-upgrades-06d6de90bbd0.rst @@ -70,10 +70,10 @@ Reboot-Required (RR) in this mode, the upversioning to a new Patch Release will result in a reboot of each host, as the host is upversioned to the new Patch Release. -For a Major Release only, an **Abort and Rollback** of the active software -deployment is supported. The deployment of a Major Release can be aborted and -rolled back at any step of the deployment process, as long as the active -deployment has not been both completed and deleted. +For either a Patch Release or a Major Release, an **Abort and Rollback** of the +active software deployment is supported. The deployment of a Release can be +aborted and rolled back at any step of the deployment process, as long as the +active deployment has not been both completed and deleted. For a Patch Release only, a **removal or un-deployment of a release** is supported. One or more Patch Releases can be removed/un-deployed by deploying a diff --git a/doc/source/updates/kubernetes/manual-host-software-deployment-ee17ec6f71a4.rst b/doc/source/updates/kubernetes/manual-host-software-deployment-ee17ec6f71a4.rst index ff0620272..ecd892226 100644 --- a/doc/source/updates/kubernetes/manual-host-software-deployment-ee17ec6f71a4.rst +++ b/doc/source/updates/kubernetes/manual-host-software-deployment-ee17ec6f71a4.rst @@ -626,11 +626,6 @@ standard configuration. #. Delete the software deployment. - .. note:: - - If it is a system controller, the deployment should not be deleted - until the subclouds are up-to-date. - .. note:: For a major release deployment, after this command is executed, the @@ -652,8 +647,15 @@ standard configuration. unavailable state, the alarm 900.024 ``Obsolete release in system`` is raised. +.. rubric:: |postreq| + #. Delete the old major release. + .. note:: + + If it is a System Controller, the deployment should not be deleted + until the subclouds are up-to-date. + In the case of software deployment of a new major release, you should remove the old major release to reclaim disk space. diff --git a/doc/source/updates/kubernetes/manual-rollback-host-software-deployment-9295ce1e6e29.rst b/doc/source/updates/kubernetes/manual-rollback-host-software-deployment-9295ce1e6e29.rst index 6d829fccc..0fa397a12 100644 --- a/doc/source/updates/kubernetes/manual-rollback-host-software-deployment-9295ce1e6e29.rst +++ b/doc/source/updates/kubernetes/manual-rollback-host-software-deployment-9295ce1e6e29.rst @@ -112,10 +112,10 @@ delete`. Host installation request sent to controller-0. Host installation was successful on controller-0 - The host is still running the new software release, however boot - parameters have been updated to boot into the previous software - release on the next host reboot, which will occur in the next step - which unlocks the host. + The host is still running the new software release, however boot + parameters have been updated to boot into the previous software + release on the next host reboot, which will occur in the next step + which unlocks the host. #. Unlock controller-0. diff --git a/doc/source/updates/kubernetes/orchestrated-deployment-host-software-deployment-d234754c7d20.rst b/doc/source/updates/kubernetes/orchestrated-deployment-host-software-deployment-d234754c7d20.rst index df58b6676..5fb8b91d1 100644 --- a/doc/source/updates/kubernetes/orchestrated-deployment-host-software-deployment-d234754c7d20.rst +++ b/doc/source/updates/kubernetes/orchestrated-deployment-host-software-deployment-d234754c7d20.rst @@ -23,17 +23,19 @@ Software deployment Orchestration supports all standalone configurations: .. note:: - Orchestrating the software deployment of a |DC| system is different from - orchestrating the software deployment of standalone |prod| configurations. + Orchestrating the software deployment of subclouds in a |DC| system is + different from orchestrating the software deployment of standalone |prod| + configurations. See + :ref:`distributed-upgrade-orchestration-process-using-the-cli`. Software deployment orchestration automatically iterates through all the hosts and deploys the new software load on each host: first the controller hosts, then the storage hosts, and lastly the worker hosts, and finally activates and completes the software deployment. During software deployment on a worker host (and duplex |AIO| controllers), pods or |VMs| are automatically moved to the -alternate worker hosts. After software deployment orchestration has deployed -the new software on all hosts, it will activate, complete, and delete the new -software deployment. +alternate worker hosts, if a reboot of the host is required. After software +deployment orchestration has deployed the new software on all hosts, it will +activate, complete, and delete the new software deployment. .. note:: @@ -327,9 +329,8 @@ to control and monitor their progress manually. ``wait-data-sync`` - This waits for a period of time (up to many hours) and ensures that data - synchronization has completed after the upgrade of a controller or storage - node. + This waits for a period of time and ensures that data synchronization has + completed after the upgrade of a controller or storage node. .. code-block:: @@ -651,6 +652,11 @@ After a successful software deployment orchestration, - Remove the old major release to reclaim disk space. + .. note:: + + If this is a System Controller, the old major release should NOT be + deleted until all the subclouds have moved to new major release. + .. code-block:: ~(keystone_admin)]$ software list