docs/doc/source/dist_cloud/kubernetes/upgrade-management-overview.rst
Elisamara Aoki Gonçalves 9e5b12cae9 Upgrade Support doc update (r10.1)
Story: 2010676
Task: 51423

Change-Id: I2e15fd4645c7661ab838a4ed0e69f7167a1cce79
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
2024-12-06 13:57:40 +00:00

88 lines
3.2 KiB
ReStructuredText

.. gjf1592841770001
.. _upgrade-management-overview:
===========================
Upgrade Management Overview
===========================
You can upgrade |prod|'s |prod-dc|'s System Controller, and subclouds with a new
release of |prod| software.
.. rubric:: |context|
.. note::
Backup all yaml files that are updated using the Redfish Platform
Management service. For more information, see
:ref:`installing-a-subcloud-using-redfish-platform-management-service`.
For information on back up and restore, see :ref:`backing-up-starlingx-system-data`.
You can use the |CLI| to manage upgrades. The workflow for upgrades is as
follows:
.. _upgrade-management-overview-ol-uqv-p24-3mb:
#. To upgrade the |prod-dc| system, you must first upgrade the
System Controller. See :ref:`upgrading-the-systemcontroller-using-the-cli`.
#. Use |prod-dc| Upgrade Orchestration to upgrade the subclouds. See
:ref:`distributed-software-deploy-orchestration-process-using-the-cli`.
#. To handle errors during an orchestrated upgrade, see :ref:`robust-error-handling-during-an-orchestrated-upgrade`.
.. rubric:: |prereq|
For |AIO-SX| deployment configurations, the end user container images in
`registry.local` will be backed up during the upgrade process. This only
includes images other than |prod| system and application images. These images
are limited to 5 GB in total size. If the system contains more than 5 GB of
these images, the upgrade start will fail. For information on back up and restore,
see :ref:`backing-up-starlingx-system-data`.
The following prerequisites apply to a |prod-dc| upgrade management service.
.. _upgrade-management-overview-ul-smx-y2m-cmb:
- Validate the list of new images with the target release. If you are using a
private registry for installs/upgrades, you must populate your private
registry with the new images prior to bootstrap and/or patch application.
- **Configuration Verification**: Ensure that the following configurations
are verified before you proceed with the upgrade on the |prod-dc|
and subclouds:
- Run the :command:`system application-list` command to ensure that all
applications are running.
- Run the :command:`system host-list` command to list the configured
hosts.
- Run the :command:`dcmanager subcloud list` command to list the
subclouds.
- Run the :command:`kubectl get pods --all-namespaces` command to test
that the authentication token validates correctly.
- Run the :command:`fm alarm-list` command to ensure that there are no
unexpected or management-affecting alarms.
- Run the :command:`system health-query-upgrade` command to check the
system health to ensure that the system meets all the upgrade prerequisites.
- Run the :command:`kubectl get host -n deployment` command to ensure all
nodes in the cluster have reconciled and is set to 'true'.
- Ensure **controller-0** is the active controller.
- The |AIO-SX| subclouds must use the Redfish platform management service.
- Ensure any certificates managed by cert manager will not be renewed during
the upgrade process.
.. only:: partner
.. include:: /_includes/upgrade-management-overview.rest