Chapter 5. Overcloud adoption and preparation
Chapter 5. Overcloud adoption and preparation Perform the overcloud adoption and upgrade preparation on each stack in your environment. To perform the overcloud adoption and upgrade preparation in a DCN environment, see Overcloud adoption and preparation in a DCN environment . For information about the duration and impact of this upgrade procedure, see Upgrade duration and impact . 5.1. Performing the overcloud adoption and preparation You must perform the following tasks for overcloud adoption: On each stack, adopt the network and host provisioning configuration exports into the overcloud. Define new containers and additional compatibility configuration. After adoption, you must run the upgrade preparation script, which performs the following tasks: Updates the overcloud plan to OpenStack Platform 17.1 Prepares the nodes for the upgrade For information about the duration and impact of this upgrade procedure, see Upgrade duration and impact . Note If your roles include a large number of nodes, you can accelerate the RHOSP upgrade by splitting existing roles and dividing the nodes between the roles. For more information, see the Red Hat Knowledgebase solution How to split roles during upgrade from RHOSP 16.2 to RHOSP 17.1 . Prerequisites Confirm that all nodes are in the ACTIVE state: If any nodes are in the MAINTENANCE state, identify and troubleshoot the root cause of the nodes that are in MAINTENANCE by running the following command and checking the last_error field: Replace <node_uuid> with the UUID of the node. Unset the MAINTENANCE state: Wait three to five minutes to see if the node returns to the MAINTENANCE state. Important If any nodes remain in the MAINTENANCE state, you cannot proceed with the upgrade. If you are unable to remove the nodes from MAINTENANCE , contact Red Hat Support. Procedure Log in to the undercloud host as the stack user. Source the stackrc undercloud credentials file: Verify that the following files that were exported during the undercloud upgrade contain the expected configuration for the overcloud upgrade. You can find the following files in the ~/overcloud-deploy/USD(<stack>) directory: tripleo-<stack>-passwords.yaml tripleo-<stack>-network-data.yaml tripleo-<stack>-virtual-ips.yaml <stack>-network-environment.yaml tripleo-<stack>-baremetal-deployment.yaml Check that the value of HostnameMap in this file matches the HostnameMap value from your current overcloud, and correct the value if required. Replace <stack> with the name of your stack. Warning You must address the issues in Jinja2 comments, and then remove all Jinja2 comment blocks, from each nic-config template that is created by automated conversion tools such as convert_v1_net_data.py or convert_heat_nic_config_to_ansible_j2.py during the undercloud upgrade. If you do not remove these comment blocks, scaled-out nodes fail to provision, or you can lose control plane networking if network_config_update is set to true . Important If you have a multi-cell environment, review Overcloud adoption for multi-cell environments for an example of copying the files to each cell stack. On the main stack, copy the passwords.yaml file to the ~/overcloud-deploy/USD(<stack>) directory. Repeat this step on each stack in your environment: On the main stack, copy the network-data.yaml file to the stack user's home directory and deploy the networks. Repeat this step on each stack in your environment: For more information, see Provisioning and deploying your overcloud in Installing and managing Red Hat OpenStack Platform with director . On the main stack, copy the virtual-ips.yaml file to the stack user's home directory and provision the network VIPs. Repeat this step on each stack in your environment: On the main stack, copy the network-environment.yaml file to the stack user's home directory. Repeat this step on each stack in your environment: Note Ensure that the NetworkConfigTemplate parameters point to the generated .j2 files and that you delete the resource_registry mappings in the overcloud-network-environment.yaml file. For more information, see Manually converting NIC templates to Jinja2 Ansible format in Customizing your Red Hat OpenStack Platform deployment . On the main stack, copy the baremetal-deployment.yaml file to the stack user's home directory and provision the overcloud nodes. Repeat this step on each stack in your environment: Note This is the final step of the overcloud adoption. If your overcloud adoption takes longer than 10 minutes to complete, contact Red Hat Support. Complete the following steps to prepare the containers: Back up the containers-prepare-parameter.yaml file that you used for the undercloud upgrade: Define the following environment variables before you run the script to update the containers-prepare-parameter.yaml file: NAMESPACE : The namespace for the UBI9 images. For example, NAMESPACE='"namespace":"example.redhat.com:5002",' EL8_NAMESPACE : The namespace for the UBI8 images. NEUTRON_DRIVER : The driver to use and determine which OpenStack Networking (neutron) container to use. Set to the type of containers you used to deploy the original stack. For example, set to NEUTRON_DRIVER='"neutron_driver":"ovn",' to use OVN-based containers. EL8_TAGS : The tags of the UBI8 images, for example, EL8_TAGS='"tag":"17.1",' . Replace "17.1", with the tag that you use in your content view. EL9_TAGS : The tags of the UBI9 images, for example, EL9_TAGS='"tag":"17.1",' . Replace "17.1", with the tag that you use in your content view. For more information about the tag parameter, see Container image preparation parameters in Customizing your Red Hat OpenStack Platform deployment . CONTROL_PLANE_ROLES : The list of control plane roles using the --role option, for example, --role ControllerOpenstack, --role Database, --role Messaging, --role Networker, --role CephStorage . To view the list of control plane roles in your environment, run the following command: Replace <stack> with the name of your stack. COMPUTE_ROLES : The list of Compute roles using the --role option, for example, --Compute-1 . To view the list of Compute roles in your environment, run the following command: CEPH_OVERRIDE : If you deployed Red Hat Ceph Storage, specify the Red Hat Ceph Storage 5 container images. For example: CEPH_OVERRIDE='"ceph_image":"rhceph-5-rhel8","ceph_tag":"<latest>",' Replace <latest> with the latest ceph_tag version, for example, 5-499 . The following is an example of the containers-prepare-parameter.yaml file configuration: Run the following script to to update the containers-prepare-parameter.yaml file: Warning If you deployed Red Hat Ceph Storage, ensure that the CEPH_OVERRIDE environment variable is set to the correct values before executing the following command. Failure to do so results in issues when upgrading Red Hat Ceph Storage. The multi-rhel-container-image-prepare.py script supports the following parameters: --output-env-file Writes the environment file that contains the default ContainerImagePrepare value. --local-push-destination Triggers an upload to a local registry. --enable-registry-login Enables the flag that allows the system to attempt to log in to a remote registry prior to pulling the containers. Use this flag when --local-push-destination is not used and the target systems have network connectivity to remote registries. Do not use this flag for an overcloud that might not have network connectivity to a remote registry. --enable-multi-rhel Enables multi-rhel. --excludes Lists the services to exclude. --major-override Lists the override parameters for a major release. --minor-override Lists the override parameters for a minor release. --role The list of roles. --role-file The role_data.yaml file. If you deployed Red Hat Ceph Storage, open the containers-prepare-parameter.yaml file to confirm that the Red Hat Ceph Storage 5 container images are specified and that there are no references to Red Hat Ceph Storage 6 container images. If you have a director-deployed Red Hat Ceph Storage deployment, create a file called ceph_params.yaml and include the following content: Important Do not remove the ceph_params.yaml file after the RHOSP upgrade is complete. This file must be present in director-deployed Red Hat Ceph Storage environments. Additionally, any time you run openstack overcloud deploy , you must include the ceph_params.yaml file, for example, -e ceph_params.yaml . Note If your Red Hat Ceph Storage deployment includes short names, you must set the CephSpecFqdn parameter to false . If set to true , the inventory generates with both the short names and domain names, causing the Red Hat Ceph Storage upgrade to fail. Create an environment file called upgrades-environment.yaml in your templates directory and include the following content: Replace <dns_servers> with a comma-separated list of your DNS server IP addresses, for example, ["10.0.0.36", "10.0.0.37"] . Replace <undercloud_FQDN> with the fully qualified domain name (FQDN) of the undercloud host, for example, ["undercloud-0.ctlplane.redhat.local:8787"] . For more information about the upgrade parameters that you can configure in the environment file, see Upgrade parameters . On the undercloud, create a file called overcloud_upgrade_prepare.sh in your templates directory. You must create this file for each stack in your environment. This file includes the original content of your overcloud deploy file and the environment files that are relevant to your environment. For example: Note If you have a multi-cell environment, review Overcloud adoption for multi-cell environments for an example of creating the overcloud_upgrade_prepare.sh file for each cell stack. In the original network-environment.yaml file ( /home/stack/templates/network/network-environment.yaml ), remove all the resource_registry resources that point to OS::TripleO::*::Net::SoftwareConfig . In the overcloud_upgrade_prepare.sh file, include the following options relevant to your environment: The environment file ( upgrades-environment.yaml ) with the upgrade-specific parameters ( -e ). The environment file ( containers-prepare-parameter.yaml ) with your new container image locations ( -e ). In most cases, this is the same environment file that the undercloud uses. The environment file ( skip_rhel_release.yaml ) with the release parameters ( -e ). Any custom configuration environment files ( -e ) relevant to your deployment. If applicable, your custom roles ( roles_data ) file by using --roles-file . For Ceph deployments, the environment file ( ceph_params.yaml ) with the Ceph parameters ( -e ). If applicable, the environment file ( ipa-environment.yaml ) with your IPA service ( -e ). If you are using composable networks, the ( network_data ) file by using --network-file . The files that were generated during overcloud adoption ( networks-deployed.yaml , vip-deployed.yaml , baremetal-deployment.yaml ) ( -e ). These files must be placed last in the overcloud upgrade prepare script. Note Do not include the network-isolation.yaml file in your overcloud deploy file or the overcloud_upgrade_prepare.sh file. Network isolation is defined in the network_data.yaml file. If you use a custom stack name, pass the name with the --stack option. Note You must include the nova-hw-machine-type-upgrade.yaml file in your templates until all of your RHEL 8 Compute nodes are upgraded to RHEL 9 in the environment. If this file is excluded, an error appears in the nova_compute.log in the /var/log/containers/nova directory. After you upgrade all of your RHEL 8 Compute nodes to RHEL 9, you can remove this file from your configuration and update the stack. In the director-deployed Red Hat Ceph Storage use case, if you enabled the Shared File Systems service (manila) with CephFS through NFS on the deployment that you are upgrading, you must specify an additional environment file at the end of the overcloud_upgrade_prepare.sh script file. You must add the environment file at the end of the script because it overrides another environment file that is specified earlier in the script: In the external Red Hat Ceph Storage use case, if you enabled the Shared File Systems service (manila) with CephFS through NFS on the deployment that you are upgrading, you must check that the associated environment file in the overcloud_upgrade_prepare.sh script points to the tripleo-based ceph-nfs role. If present, remove the following environment file: And add the following environment file: Run the upgrade preparation script for each stack in your environment: Note If you have a multi-cell environment, you must run the script for each overcloud_upgrade_prepare.sh file that you created for each cell stack. For an example, see Overcloud adoption for multi-cell environments . Wait until the upgrade preparation completes. Download the container images: 5.2. Overcloud adoption for multi-cell environments Overcloud adoption involves copying the following files that were exported during the undercloud upgrade into the stack user's home directory: network-data.yaml virtual-ips.yaml baremetal-deployment.yaml You must copy the files to the overcloud stack first and then copy them to each cell stack. Note The network-data.yaml file is available only on the overcloud stack. You must copy the file from the overcloud stack to all the other cell stacks. The following example copies the virtual-ips.yaml file: Overcloud stack: Cell stack 1: Cell stack 2: Upgrade preparation Performing the upgrade prepare procedure for a multi-cell environment requires the following steps: Create the overcloud_upgrade_prepare.sh file for each cell stack, starting with the overcloud stack. Include the generated output file that you created for the cell stack in the overcloud_upgrade_prepare.sh file. Ensure that you include the environment files that are specific to each cell stack in the overcloud_upgrade_prepare.sh file. Run the overcloud_upgrade_prepare.sh script for each cell stack. The following example adds the generated-vip-deployed.yaml files that were generated per cell stack during overcloud adoption: Overcloud stack: Run the overcloud_upgrade_prepare.sh script for the overcloud stack. Cell stack 1: Run the overcloud_upgrade_prepare.sh script for cell stack 1. Cell stack 2: Run the overcloud_upgrade_prepare.sh script for cell stack 2. For more information about the overcloud adoption and preparation process, see Running the overcloud upgrade preparation .
openstack baremetal node list openstack baremetal node show <node_uuid> openstack baremetal node maintenance unset <node_uuid> source ~/stackrc {{# NOTE! Custom parameter {} was hard-coded in ' 'the converted template. To parameterize use the ' '{{role.name}}ExtraGroupVars THT interface and update the ' 'template to use an ansible var. +#}} cp ~/overcloud-deploy/<stack>/tripleo-<stack>-passwords.yaml ~/overcloud-deploy/<stack>/<stack>-passwords.yaml cp ~/overcloud-deploy/<stack>/tripleo-<stack>-network-data.yaml ~/ mkdir ~/overcloud_adopt openstack overcloud network provision --debug --output /home/stack/overcloud_adopt/generated-networks-deployed.yaml tripleo-<stack>-network-data.yaml cp ~/overcloud-deploy/<stack>/tripleo-<stack>-virtual-ips.yaml ~/ openstack overcloud network vip provision --debug --stack <stack> --output /home/stack/overcloud_adopt/generated-vip-deployed.yaml tripleo-<stack>-virtual-ips.yaml cp ~/overcloud-deploy/<stack>/<stack>-network-environment.yaml ~/overcloud_adopt/<stack>-network-environment.yaml cp ~/overcloud-deploy/<stack>/tripleo-<stack>-baremetal-deployment.yaml ~/ openstack overcloud node provision --debug --stack <stack> --output /home/stack/overcloud_adopt/baremetal-deployment.yaml tripleo-<stack>-baremetal-deployment.yaml cp containers-prepare-parameter.yaml containers-prepare-parameter.yaml.orig export STACK=<stack> sudo awk '/tripleo_role_name/ {print "--role " USD2}' /var/lib/mistral/USD{STACK}/tripleo-ansible-inventory.yaml | grep -vi compute sudo awk '/tripleo_role_name/ {print "--role " USD2}' /var/lib/mistral/USD{STACK}/tripleo-ansible-inventory.yaml | grep -i compute NAMESPACE='"namespace":"registry.redhat.io/rhosp-rhel9",' EL8_NAMESPACE='"namespace":"registry.redhat.io/rhosp-rhel8",' NEUTRON_DRIVER='"neutron_driver":"ovn",' EL8_TAGS='"tag":"17.1",' EL9_TAGS='"tag":"17.1",' CONTROL_PLANE_ROLES="--role Controller" COMPUTE_ROLES="--role Compute1 --role Compute2" CEPH_TAGS='"ceph_tag":"5",' python3 /usr/share/openstack-tripleo-heat-templates/tools/multi-rhel-container-image-prepare.py USD{COMPUTE_ROLES} USD{CONTROL_PLANE_ROLES} --enable-multi-rhel --excludes collectd --excludes nova-libvirt --minor-override "{USD{EL8_TAGS}USD{EL8_NAMESPACE}USD{CEPH_OVERRIDE}USD{NEUTRON_DRIVER}\"no_tag\":\"not_used\"}" --major-override "{USD{EL9_TAGS}USD{NAMESPACE}USD{CEPH_OVERRIDE}USD{NEUTRON_DRIVER}\"no_tag\":\"not_used\"}" --output-env-file /home/stack/containers-prepare-parameter.yaml parameter_defaults: CephSpecFqdn: true CephConfigPath: "/etc/ceph" CephAnsibleRepo: "rhceph-5-tools-for-rhel-8-x86_64-rpms" DeployedCeph: true GrafanaPlugins: [] parameter_defaults: ExtraConfig: nova::workarounds::disable_compute_service_check_for_ffu: true DnsServers: ["<dns_servers>"] DockerInsecureRegistryAddress: [<undercloud_FQDN>] UpgradeInitCommand: | sudo subscription-manager repos --disable=* if USD( grep -q 9.2 /etc/os-release ) then sudo subscription-manager repos --enable=rhel-9-for-x86_64-baseos-eus-rpms --enable=rhel-9-for-x86_64-appstream-eus-rpms --enable=rhel-9-for-x86_64-highavailability-eus-rpms --enable=openstack-17.1-for-rhel-9-x86_64-rpms --enable=fast-datapath-for-rhel-9-x86_64-rpms sudo podman ps | grep -q ceph && subscription-manager repos --enable=rhceph-5-tools-for-rhel-9-x86_64-rpms sudo subscription-manager release --set=9.2 else sudo subscription-manager repos --enable=rhel-8-for-x86_64-baseos-tus-rpms --enable=rhel-8-for-x86_64-appstream-tus-rpms --enable=rhel-8-for-x86_64-highavailability-tus-rpms --enable=openstack-17.1-for-rhel-8-x86_64-rpms --enable=fast-datapath-for-rhel-8-x86_64-rpms sudo podman ps | grep -q ceph && subscription-manager repos --enable=rhceph-5-tools-for-rhel-8-x86_64-rpms sudo subscription-manager release --set=8.4 fi if USD(sudo podman ps | grep -q ceph ) then sudo dnf -y install cephadm fi #!/bin/bash openstack overcloud upgrade prepare --yes --timeout 460 --templates /usr/share/openstack-tripleo-heat-templates --ntp-server 192.168.24.1 --stack <stack> -r /home/stack/roles_data.yaml -e /home/stack/templates/internal.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/services/neutron-ovs.yaml -e /home/stack/templates/network/network-environment.yaml -e /home/stack/templates/inject-trust-anchor.yaml -e /home/stack/templates/hostnames.yml -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible.yaml -e /home/stack/templates/nodes_data.yaml -e /home/stack/templates/debug.yaml -e /home/stack/templates/firstboot.yaml -e /home/stack/templates/upgrades-environment.yaml -e /home/stack/overcloud-params.yaml -e /home/stack/overcloud_adopt/overcloud-network-environment.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/nova-hw-machine-type-upgrade.yaml -e /home/stack/skip_rhel_release.yaml -e ~/containers-prepare-parameter.yaml -e /home/stack/overcloud_adopt/baremetal-deployment.yaml -e /home/stack/overcloud_adopt/generated-networks-deployed.yaml -e /home/stack/overcloud_adopt/generated-vip-deployed.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/manila-cephfsganesha-config.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/manila-cephfsganesha-config.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsganesha-config.yaml source stackrc chmod 755 /home/stack/overcloud_upgrade_prepare.sh sh /home/stack/overcloud_upgrade_prepare.sh openstack overcloud external-upgrade run --stack <stack> --tags container_image_prepare cp ~/overcloud-deploy/<overcloud>/tripleo-<overcloud>-virtual-ips.yaml ~/ cd ~/ openstack overcloud network vip provision --debug --stack <overcloud> --output /home/stack/overcloud_adopt/generated-vip-deployed.yaml \ tripleo-<overcloud>-virtual-ips.yaml cp ~/overcloud-deploy/<stack1>/tripleo-<stack1>-virtual-ips.yaml ~/ cd ~/ openstack overcloud network vip provision --debug --stack <stack1> --output /home/stack/overcloud_adopt/generated-<stack1>-vip-deployed.yaml \ tripleo-<stack1>-virtual-ips.yaml cp ~/overcloud-deploy/<stack2>/tripleo-<stack2>-virtual-ips.yaml ~/ cd ~/ openstack overcloud network vip provision --debug --stack <stack2> --output /home/stack/overcloud_adopt/generated-<stack2>-vip-deployed.yaml \ tripleo-<stack2>-virtual-ips.yaml #!/bin/bash openstack overcloud upgrade prepare --yes -e /home/stack/templates/upgrades-environment.yaml -e /home/stack/overcloud-params.yaml -e/home/stack/overcloud_adopt/generated-vip-deployed.yaml #!/bin/bash openstack overcloud upgrade prepare --yes -e /home/stack/templates/upgrades-environment.yaml -e /home/stack/stack1-params.yaml -e/home/stack/overcloud_adopt/generated-<stack1>-vip-deployed.yaml #!/bin/bash openstack overcloud upgrade prepare --yes -e /home/stack/templates/upgrades-environment.yaml -e /home/stack/stack2-params.yaml -e/home/stack/overcloud_adopt/generated-<stack2>-vip-deployed.yaml