Chapter 4. Updating the Overcloud
This process updates the overcloud.
Prerequisites
- You have updated the undercloud to the latest version.
4.1. Running the overcloud update preparation
The update requires running openstack overcloud update prepare
command, which performs the following tasks:
- Updates the overcloud plan to OpenStack Platform 16.0
- Prepares the nodes for the update
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the update preparation command:
$ openstack overcloud update prepare \ --templates \ -r <ROLES DATA FILE> \ -n <NETWORK DATA FILE> \ -e <ENVIRONMENT FILE> \ -e <ENVIRONMENT FILE> \ --stack <STACK_NAME> \ …
Include the following options relevant to your environment:
-
Custom configuration environment files (
-e
) -
If using your own custom roles, include your custom roles (
roles_data
) file (-r
) -
If using custom networks, include your composable network (
network_data
) file (-n
) -
If the name of your overcloud stack is different to the default name
overcloud
, include the--stack
option in the update preparation command and replace<STACK_NAME>
with the name of your stack.
-
Custom configuration environment files (
- Wait until the update preparation completes.
4.2. Running the container image preparation
The overcloud requires the latest OpenStack Platform 16.0 container images before performing the update. This involves executing the container_image_prepare
external update process. To execute this process, run the openstack overcloud external-update run
command against tasks tagged with the container_image_prepare
tag. These tasks:
- Automatically prepare all container image configuration relevant to your environment.
- Pull the relevant container images to your undercloud, unless you have previously disabled this option.
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the
openstack overcloud external-update run
command against tasks tagged with thecontainer_image_prepare
tag:$ openstack overcloud external-update run --stack STACK_NAME --tags container_image_prepare
4.3. Updating all Controller nodes
This process updates all the Controller nodes to the latest OpenStack Platform 16.0 version. The process involves running the openstack overcloud update run
command and including the --limit Controller
option to restrict operations to the Controller nodes only.
If you are not using the default stack name (overcloud
), set your stack name with the --stack STACK_NAME
option replacing STACK_NAME
with the name of your stack.
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the update command:
$ openstack overcloud update run --stack STACK_NAME --limit Controller --playbook all
- Wait until the Controller node update completes.
4.4. Updating all Compute nodes
This process updates all Compute nodes to the latest OpenStack Platform 16.0 version. The process involves running the openstack overcloud update run
command and including the --nodes Compute
option to restrict operations to the Compute nodes only.
If you are not using the default stack name (overcloud
), set your stack name with the --stack STACK_NAME
option replacing STACK_NAME
with the name of your stack.
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the update command:
$ openstack overcloud update run --stack STACK_NAME --limit Compute --playbook all
- Wait until the Compute node update completes.
4.5. Updating all HCI Compute nodes
This process updates the Hyperconverged Infrastructure (HCI) Compute nodes. The process involves:
-
Running the
openstack overcloud update run
command and including the--nodes ComputeHCI
option to restrict operations to the HCI nodes only. -
Running the
openstack overcloud external-update run --tags ceph
command to perform an update to a containerized Red Hat Ceph Storage 4 cluster.
If you are not using the default stack name (overcloud
), set your stack name with the --stack STACK_NAME
option replacing STACK_NAME
with the name of your stack.
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the update command:
$ openstack overcloud update run --stack _STACK_NAME_ --limit ComputeHCI --playbook all
- Wait until the node update completes.
Run the Ceph Storage update command. For example:
$ openstack overcloud external-update run --stack _STACK_NAME_ --tags ceph
- Wait until the Compute HCI node update completes.
4.6. Updating all Ceph Storage nodes
This process updates the Ceph Storage nodes. The process involves:
-
Running the
openstack overcloud update run
command and including the--nodes CephStorage
option to restrict operations to the Ceph Storage nodes only. -
Running the
openstack overcloud external-update run
command to runceph-ansible
as an external process and update the Red Hat Ceph Storage 4 containers.
If you are not using the default stack name (overcloud
), set your stack name with the --stack STACK_NAME
option replacing STACK_NAME
with the name of your stack.
Procedure
Source the
stackrc
file:$ source ~/stackrc
Update group nodes.
To update all nodes in a group:
$ openstack overcloud update run --nodes <GROUP_NAME>
To update a single node in a group:
$ openstack overcloud update run --nodes <GROUP_NAME> [NODE_INDEX]
NoteEnsure that you update all nodes if you choose to update nodes individually.
The index of the first node in a group is zero (0). For example, to update the first node in a group named
CephStorage
, the command is:openstack overcloud update run --nodes CephStorage[0]
- Wait until the node update completes.
Run the Ceph Storage container update command:
$ openstack overcloud external-update run --stack _STACK_NAME_ --tags ceph
- Wait until the Ceph Storage container update completes.
4.7. Performing online database updates
Some overcloud components require an online upgrade (or migration) of their databases tables. This involves executing the online_upgrade
external update process. To execute this process, run the openstack overcloud external-update run
command against tasks tagged with the online_upgrade
tag. This performs online database updates to the following components:
- OpenStack Block Storage (cinder)
- OpenStack Compute (nova)
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the
openstack overcloud external-update run
command against tasks tagged with theonline_upgrade
tag:$ openstack overcloud external-update run --stack STACK_NAME --tags online_upgrade
4.8. Finalizing the update
The update requires a final step to update the overcloud stack. This ensures the stack’s resource structure aligns with a regular deployment of OpenStack Platform 16.0 and allows you to perform standard openstack overcloud deploy
functions in the future.
Procedure
Source the
stackrc
file:$ source ~/stackrc
Run the update finalization command:
$ openstack overcloud update converge \ --templates \ -r <ROLES DATA FILE> \ -n <NETWORK DATA FILE> \ -e <ENVIRONMENT FILE> \ -e <ENVIRONMENT FILE> \ --stack <STACK_NAME> \ …
Include the following options relevant to your environment:
+ * Custom configuration environment files (
-e
) * If using your own custom roles, include your custom roles (roles_data
) file (-r
) * If using custom networks, include your composable network (network_data
) file (-n
) * If the name of your overcloud stack is different to the default nameovercloud
, include the--stack
option in the update preparation command and replace<STACK_NAME>
with the name of your stack.- Wait until the update finalization completes.