From 2dbaaba94a45a6f514e60372bf21e751d756ead7 Mon Sep 17 00:00:00 2001 From: Juanita Balaraj Date: Wed, 10 Jul 2024 19:52:56 +0000 Subject: [PATCH] Added Appendix for USM Updates Updated patchset 7 comments Added --local to command ``sudo software upload --local .patch**`` Fixed line break Reverted Index and only added the Appendix - Kubernetes Platform for this Gerrit review, see https://review.opendev.org/c/starlingx/docs/+/923472; https://review.opendev.org/c/starlingx/docs/+/923747 for Index updates. Reverted Index updates as per Patchset 3 comments - Reorganized Kubernetes Version Upgrade section - Moved N3000 information to the Appendix (Deperecated) Story: 2010676 Task: 50141 Change-Id: I5b08427567b2cd98516a109c113655ad946fba89 Signed-off-by: Juanita Balaraj --- .../index-updates-kub-03d4d10fa0be.rst | 21 ++++ ...trap-and-commissioning-of-7d0a97144db8.rst | 111 ++++++++++++++++++ 2 files changed, 132 insertions(+) create mode 100644 doc/source/updates/kubernetes/patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8.rst diff --git a/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst b/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst index 251758cf3..76d1f0f74 100644 --- a/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst +++ b/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst @@ -139,4 +139,25 @@ Orchestrated Platform component upgrade performing-an-orchestrated-upgrade performing-an-orchestrated-upgrade-using-the-cli +------------------------------ +Appendix - Kubernetes Platform +------------------------------ +.. toctree:: + :maxdepth: 1 + + patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8 + +------------------------------------------------------ +N3000 FPGA Firmware Update Orchestration is deprecated +------------------------------------------------------ + +.. toctree:: + :maxdepth: 1 + + overview-of-firmware-update-orchestration + the-firmware-update-orchestration-process + firmware-update-operations-requiring-manual-migration + configure-firmware-update-orchestration + firmware-update-orchestration-using-the-cli + handle-firmware-update-orchestration-failures diff --git a/doc/source/updates/kubernetes/patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8.rst b/doc/source/updates/kubernetes/patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8.rst new file mode 100644 index 000000000..714f05a84 --- /dev/null +++ b/doc/source/updates/kubernetes/patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8.rst @@ -0,0 +1,111 @@ +.. WARNING: Add no lines of text between the label immediately following +.. and the title. + +.. _patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8: + +======================================================================================= +Deployment of Patch Releases before Bootstrap and Commissioning of initial Installation +======================================================================================= + +.. rubric:: |context| + +When initially installing a |prod-long| system, occassionally it is required +to deploy the latest available patch release for the major release +being deployed. + +The patch releases should be deployed using the procedure below. + +- *AFTER* the intial install of software on the first host + (controller-0), and + +- *BEFORE* running the Ansible Bootstrap Playbook and configuring and + installing software on any other hosts. + +This ensures that: + +- The software on controller-0, and all other hosts, is up to date when + the cluster first becomes active. + +- You reduce installation time by avoiding having to patch the system + right after an out-of-date software installation is completed. + +.. rubric:: |prereq| + +- The software patch releases that are required to be deployed are available + on a USB flash drive, or from a server reachable by controller-0. + +- You are at the beginning of a |prod-long| system installation. Specifically, + + - You have used the |prod-long| bootable ISO image (for a major + release) to install the |prod-long| software on controller-0. + + - You have logged into the console port as user sysadmin, **BUT you have NOT + bootstrapped the system yet.** + +.. rubric:: |proc| + +#. Upload the patch releases. + + Upload the updates from the USB flash drive using the :command:`software + upload ` command. + + .. note:: + + ``sudo`` is required for authentication due to |prod| + authentication not currently running. + + .. code-block:: + + $ sudo software upload --local .patch** + is now uploaded + +-------------------------------+-------------------+ + | Uploaded File | Release | + +-------------------------------+-------------------+ + | .patch | | + +-------------------------------+-------------------+ + + .. note:: Repeat the above command for all patch releases to be deployed. + +#. If you copied the patch release file(s) to /home/sysadmin/, then + remove these files. + + After the patch release files are uploaded to the system, the + original files are no longer required. + + You should delete them to ensure enough disk space to complete the + installation. + + .. Caution:: + + If the original files are not deleted before the updates are applied, + the installation may fail due to a full disk. + +#. Deploy the patch releases. + + .. code-block:: + + $ sudo software deploy start + + + $ sudo software deploy localhost + + Patch Release deployment complete. + Please reboot before continuing. + +#. Reboot controller-0. + + You must reboot the controller to ensure that it is running with + the software fully updated. + + .. code-block:: + + $ sudo reboot + +.. rubric:: |postreq| + +Continue with bootstrapping and configuring your system. + +.. rubric:: |result| + +Once all hosts in the cluster are initialized, they will all be running +fully patched software.