Framework for Upgrades (13 to 16.1)

1. Before you can upgrade your Red Hat OpenStack Platform deployment from version 13 to version 16.1, you must upgrade your Red Hat Ceph Storage cluster from version 3 to version 4. For more information, see Upgrading a Red Hat Ceph Storage cluster in the Red Hat Ceph Storage 4 Installation Guide.
2. After you upgrade your Red Hat Ceph Storage cluster from version 3 to version 4, Red Hat OpenStack Platform 13 might still run RHCSv3 client components, however these are compatible against the RHCSv4 cluster.
3. You can follow the upgrade path described in the Framework For Upgrades (13 to 16.1) document, and where applicable, you must complete the conditional steps that support this particular scenario. A conditional step starts with the following statement: "If you are upgrading with external Ceph deployments".
4. When you upgrade with external Ceph deployments, you install RHCSv4 ceph-ansible as part of the overcloud upgrade process. When you upgrade a Ceph cluster that was deployed using director, you install RHCSv4 ceph-ansible after the overcloud upgrade process is complete.

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Create a bash script called pre-upgrade-validations.sh and include the following content in the script:

   #!/bin/bash
   for VALIDATION in $(openstack action execution run tripleo.validations.list_validations '{"groups": ["pre-upgrade"]}' | jq ".result[] | .id")
   do
     echo "=== Running validation: $VALIDATION ==="
     STACK_NAME=$(openstack stack list -f value -c 'Stack Name')
     ID=$(openstack workflow execution create -f value -c ID tripleo.validations.v1.run_validation "{\"validation_name\": $VALIDATION, \"plan\": \"$STACK_NAME\"}")
     while [ $(openstack workflow execution show $ID -f value -c State) == "RUNNING" ]
     do
       sleep 1
     done
     echo ""
     openstack workflow execution output show $ID | jq -r ".stdout"
     echo ""
   done

   Copy to Clipboard Toggle word wrap

4. Add permission to run the script:

   $ chmod +x pre-upgrade-validations.sh

   Copy to Clipboard Toggle word wrap

5. Run the script:

   $ ./pre-upgrade-validations.sh

   Copy to Clipboard Toggle word wrap

   Review the script output to determine which validations succeed and fail:

   === Running validation: "check-ftype" ===
   
   Success! The validation passed for all hosts:
   * undercloud

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Create an Ansible playbook named playbook-nics.yaml and copy the following content into the playbook:

   ---
   - name: Rename eth devices
     hosts: all
     become: yes
     vars:
       prefix: "em"
       undercloud_conf: "/home/stack/undercloud.conf"
       osnet_conf: "/etc/os-net-config/config.json"
     tasks:
       - set_fact:
           eth_interfaces: "{{ ansible_interfaces | select('match','eth.*') | list }}"
       - debug:
           msg: "{{ eth_interfaces }}"
       - name: Update udev rules
         lineinfile:
           line: "SUBSYSTEM==\"net\", ACTION==\"add\", DRIVERS==\"?*\", ATTR{address}==\"{{ ansible_facts[item]['perm_macaddress'] | default(ansible_facts[item]['macaddress']) }}\", NAME=\"{{ item|replace('eth',prefix) }}\""
           path: /etc/udev/rules.d/70-rhosp-persistent-net.rules
           create: True
         with_items: "{{ eth_interfaces }}"
       - name: Rename eth files
         block:
           - name: Check that eth files exists
             stat:
               path: /etc/sysconfig/network-scripts/ifcfg-{{ item }}
             register: nic_result
             with_items: "{{ eth_interfaces }}"
           - name: Copy nic files using the new prefix
             copy:
               remote_src: True
               src: "{{ item.stat.path }}"
               dest: "{{ item.stat.path|replace('eth',prefix) }}"
             with_items: "{{ nic_result.results }}"
             when: item.stat.exists
           - name: Edit NAME in new network-script files
             lineinfile:
               regexp: "^NAME=.*"
               line: "NAME={{ item.item|replace('eth',prefix) }}"
               path: "{{ item.stat.path|replace('eth',prefix) }}"
             with_items: "{{ nic_result.results }}"
             when: item.stat.exists
           - name: Edit DEVICE in new network-script files
             lineinfile:
               regexp: "^DEVICE=.*"
               line: "DEVICE={{ item.item|replace('eth',prefix) }}"
               path: "{{ item.stat.path|replace('eth',prefix) }}"
             with_items: "{{ nic_result.results }}"
             when: item.stat.exists
           - name: Backup old eth network-script files
             copy:
               remote_src: True
               src: "{{ item.stat.path }}"
               dest: "{{ item.stat.path }}.bak"
             with_items: "{{ nic_result.results }}"
             when: item.stat.exists
           - name: Remove old eth network-script files
             file:
               path: "{{ item.stat.path }}"
               state: absent
             with_items: "{{ nic_result.results }}"
             when: item.stat.exists
       - name: Rename route files
         block:
           - name: Check that route files exists
             stat:
               path: /etc/sysconfig/network-scripts/route-{{ item }}
             register: route_result
             with_items: "{{ eth_interfaces }}"
           - name: Copy route files using the new prefix
             copy:
               remote_src: True
               src: "{{ item.stat.path }}"
               dest: "{{ item.stat.path|replace('eth',prefix) }}"
             with_items: "{{ route_result.results }}"
             when: item.stat.exists
           - name: Update prefix in route files that use IP command arguments format
             replace:
               regexp: "eth"
               replace: "{{ prefix }}"
               path: "{{ item.stat.path|replace('eth',prefix) }}"
             with_items: "{{ route_result.results }}"
             when: item.stat.exists
           - name: Backup old route files
             copy:
               remote_src: True
               src: "{{ item.stat.path }}"
               dest: "{{ item.stat.path }}.bak"
             with_items: "{{ route_result.results }}"
             when: item.stat.exists
           - name: Remove old route files
             file:
               path: "{{ item.stat.path }}"
               state: absent
             with_items: "{{ route_result.results }}"
             when: item.stat.exists
       - name: Perform a final regex for any remaining eth prefixes in ifcfg files
         block:
           - name: Get a list of all ifcfg files
             find:
               paths: /etc/sysconfig/network-scripts/
               patterns: 'ifcfg-*'
               excludes: '*.bak'
             register: ifcfg_files
           - name: Perform final regex on ifcfg files
             replace:
               path: "{{ item[0].path }}"
               regexp: "{{ item[1] }}"
               replace: "{{ item[1]|replace('eth',prefix) }}"
             with_nested:
               - "{{ ifcfg_files.files }}"
               - "{{ eth_interfaces }}"
       - name: Replace interface name in files referencing old eth interface
         block:
           - name: Check if undercloud.conf exists
             stat:
               path: "{{ undercloud_conf }}"
             register: undercloud_conf_stat
           - name: Replace interface name in undercloud.conf
             replace:
               path: "{{ undercloud_conf }}"
               regexp: 'eth(\d+)'
               replace: "{{ prefix }}\\1"
             when: undercloud_conf_stat.stat.exists
           - name: Check if os-net-config's config.json exists
             stat:
               path: "{{ osnet_conf }}"
             register: osnet_conf_stat
           - name: Replace interface name in config.json
             replace:
               path: "{{ osnet_conf }}"
               regexp: 'eth(\d+)'
               replace: "{{ prefix }}\\1"
             when: osnet_conf_stat.stat.exists
       - name: Patch vlan devices
         block:
           - name: Check that vlan files exists
             stat:
               path: /etc/sysconfig/network-scripts/ifcfg-{{ item }}
             register: nic_result
             when: item.startswith("vlan")
             with_items: "{{ ansible_interfaces }}"
           - name: Backup old vlan network-script files
             copy:
               remote_src: True
               src: "{{ item.stat.path }}"
               dest: "{{ item.stat.path }}.bak"
             when: item.item.startswith("vlan") and item.stat.exists
             with_items: "{{ nic_result.results }}"
           - name: Edit PHYSDEV in new network-script files
             replace:
               path: "{{ item.stat.path }}"
               regexp: "^PHYSDEV=eth"
               replace: "PHYSDEV={{ prefix }}"
             when: item.item.startswith("vlan") and item.stat.exists
             with_items: "{{ nic_result.results }}"

   Copy to Clipboard Toggle word wrap
   Note

   You will use this playbook to rename the overcloud NICs at a later stage in the upgrade process.

3. Run the playbook-nics.yaml playbook on the undercloud:

   $ ansible-playbook -c local -i localhost, playbook-nics.yaml

   Copy to Clipboard Toggle word wrap

   The playbook sets the new NIC prefix to em. To set a different NIC prefix, set the prefix variable when running the playbook:

   $ ansible-playbook -c local -i localhost, -e prefix="mynic" ~/playbook-nics.yaml

   Copy to Clipboard Toggle word wrap

   The NIC changes are only applied after the Leapp upgrade process completes and the node is rebooted.

Procedure

1. Log in to the undercloud as the stack user.

2. Check the /etc/ssh/sshd_config file for the PermitRootLogin parameter:

   $ sudo grep PermitRootLogin /etc/ssh/sshd_config

   Copy to Clipboard Toggle word wrap

3. If the parameter is not in the /etc/ssh/sshd_config file, edit the file and set the PermitRootLogin parameter:

   PermitRootLogin no

   Copy to Clipboard Toggle word wrap
4. Save the file.

Procedure

1. Check the current list of hardware types enabled:

   $ source ~/stackrc
   $ openstack baremetal driver list --type dynamic

   Copy to Clipboard Toggle word wrap

2. If you use a hardware type driver that is not enabled, enable the driver using the enabled_hardware_types parameter in the undercloud.conf file:

   enabled_hardware_types = ipmi,redfish,idrac

   Copy to Clipboard Toggle word wrap

3. Save the file and refresh the undercloud:

   $ openstack undercloud install

   Copy to Clipboard Toggle word wrap

4. Run the following commands, substituting the OLDDRIVER and NEWDRIVER variables for your power management type:

   $ source ~/stackrc
   $ OLDDRIVER="pxe_ipmitool"
   $ NEWDRIVER="ipmi"
   $ for NODE in $(openstack baremetal node list --driver $OLDDRIVER -c UUID -f value) ; do openstack baremetal node set $NODE --driver $NEWDRIVER; done

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Disable the main OpenStack services on the undercloud:

   $ sudo systemctl stop 'openstack-*' httpd haproxy mariadb 'rabbitmq*' docker xinetd

   Copy to Clipboard Toggle word wrap

3. Remove the main OpenStack services from the undercloud, except OpenvSwitch and certain Python 2 packages that are required for the upgrade:

   $ sudo yum -y remove '*el7ost*' 'galera*' 'haproxy*' \
       httpd 'mysql*' 'pacemaker*' xinetd python-jsonpointer \
       qemu-kvm-common-rhev qemu-img-rhev 'rabbit*' \
       'redis*' \
       -- \
       -'*openvswitch*' -python-docker -python-PyMySQL \
       -python-pysocks -python2-asn1crypto -python2-babel \
       -python2-cffi -python2-cryptography -python2-dateutil \
       -python2-idna -python2-ipaddress -python2-jinja2 \
       -python2-jsonpatch -python2-markupsafe -python2-pyOpenSSL \
       -python2-requests -python2-six -python2-urllib3 \
       -python-httplib2 -python-passlib -python2-netaddr -ceph-ansible

   Copy to Clipboard Toggle word wrap

4. Remove the content from the /etc/httpd and /var/lib/docker directories:

   $ sudo rm -rf /etc/httpd /var/lib/docker

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Install the Leapp utility and jq:

   $ sudo yum install leapp
   $ sudo yum install jq

   Copy to Clipboard Toggle word wrap
3. Download the additional required data files (RPM package changes and RPM repository mapping) attached to the Knowledge Base article Data required by the Leapp utility for an in-place upgrade from RHEL 7 to RHEL 8 and place these files in the /etc/leapp/files/ directory.

4. Update your Red Hat subscription:

   • If your undercloud uses the Red Hat Customer Portal for registration, refresh your current subscription to obtain access to the Red Hat Enterprise Linux 8.2 content:

     $ sudo subscription-manager refresh

     Copy to Clipboard Toggle word wrap

   • If your undercloud uses Red Hat Satellite Server for registration, re-register the undercloud to a content view associated with your Red Hat OpenStack Platform (RHOSP)16.1 activation key.

     $ sudo subscription-manager register --force --org ORG --activationkey ACTIVATION_KEY

     Copy to Clipboard Toggle word wrap
     Note

     The content view that you create for Red Hat OpenStack Platform 16.1 must contain content for Red Hat Enterprise Linux 8.2.

5. Red Hat OpenStack Platform 16.1 uses a newer version of Open vSwitch`. Substitute the Open vSwitch version through the to_remove and to_install transaction files:

   $ echo 'openvswitch2.11' | sudo tee -a /etc/leapp/transaction/to_remove
   $ echo 'openvswitch2.13' | sudo tee -a /etc/leapp/transaction/to_install

   Copy to Clipboard Toggle word wrap

6. Retain the Red Hat Ceph Storage 3 version of ceph-ansible through the upgrade with the to_keep transaction file:

   $ echo 'ceph-ansible' | sudo tee -a /etc/leapp/transaction/to_keep

   Copy to Clipboard Toggle word wrap

7. Adjust the kernel modules that are no longer supported in RHEL 8:

   $ if [ -f /usr/share/leapp-repository/repositories/system_upgrade/el7toel8/actors/kernel/checkkerneldrivers/files/removed_drivers.txt ]; then
       for module in pata_acpi floppy; do
           sudo sed -i "/^${module}$/d" /usr/share/leapp-repository/repositories/system_upgrade/el7toel8/actors/kernel/checkkerneldrivers/files/removed_drivers.txt
       done
   else
       for module in pata_acpi floppy; do
           jq ". | del(.data[] | select(.driver_name == \"${module}\"))" /etc/leapp/files/device_driver_deprecation_data.json | sudo tee /etc/leapp/files/device_driver_deprecation_data.json_modified
           mv /etc/leapp/files/device_driver_deprecation_data.json_modified /etc/leapp/files/device_driver_deprecation_data.json
       done
   fi

   Copy to Clipboard Toggle word wrap

8. Run the leapp answer command and specify the Leapp answer to remove the pam_pkcs11 module:

   $ sudo leapp answer --add --section remove_pam_pkcs11_module_check.confirm=True

   Copy to Clipboard Toggle word wrap

9. Optional: If your environment is deployed with a TLS-Everywhere architecture and it uses the deprecated authconfig utility to configure authentication on your system, configure your RHEL 8 system with the authselect utility:

   $ sudo leapp answer --add --section authselect_check.confirm=True

   Copy to Clipboard Toggle word wrap

   For more information about authentication configuration during the Leapp upgrade process, see Known issues in Upgrading from RHEL 7 to RHEL 8.

10. Set the LEAPP_DEVEL_TARGET_RELEASE and LEAPP_UNSUPPORTED environment variables to specify the RHEL 8 minor version that you want to upgrade to. For RHOSP 16.1, you must set the RHEL 8 minor version to 8.2:

    $ export LEAPP_UNSUPPORTED=1
    $ export LEAPP_DEVEL_TARGET_RELEASE=8.2

    Copy to Clipboard Toggle word wrap

    You must use the LEAPP_UNSUPPORTED environment variable every time you use a environment variable with the LEAPP_DEVEL prefix.

11. Remove the persistent network names actor from the Leapp process:

    Note

    If you do not rename the network interface names before you perform the Leapp upgrade process, the interface names might change after the upgrade to RHEL 8.2 is complete. For more information about renaming the network interface names, see Section 4.3, “Using predictable NIC names for the undercloud node”.

    $ sudo rm -f /usr/share/leapp-repository/repositories/system_upgrade/el7toel8/actors/persistentnetnamesdisable/actor.py

    Copy to Clipboard Toggle word wrap

12. Start the Leapp upgrade process:

    $ sudo -E leapp upgrade --debug --enablerepo rhel-8-for-x86_64-baseos-tus-rpms --enablerepo rhel-8-for-x86_64-appstream-tus-rpms --enablerepo fast-datapath-for-rhel-8-x86_64-rpms --enablerepo ansible-2.9-for-rhel-8-x86_64-rpms

    Copy to Clipboard Toggle word wrap

    Use the --enablerepo option to set the repositories that you want to enable during the Leapp upgrade process. You must include these repositories to facilitate the Red Hat OpenStack Platform 16.1 transition, especially with the newer version of Open vSwitch.

13. Wait for the leapp upgrade command to successfully complete.

14. Create an empty .autorelabel file in your root directory:

    $ sudo touch /.autorelabel

    Copy to Clipboard Toggle word wrap

    After a reboot, SELinux detects this file and automatically relabels the file system.

15. Reboot the undercloud:

    $ sudo reboot

    Copy to Clipboard Toggle word wrap

16. Remove the Leapp packages from the transaction exclusion that is defined in the DNF configuration:

    $ sudo dnf config-manager --save --setopt exclude=''

    Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Lock the undercloud to a specific version with the subscription-manager release command:

   $ sudo subscription-manager release --set=8.2

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to your undercloud as the stack user.

2. Disable all default repositories, and enable the required Red Hat Enterprise Linux repositories:

   [stack@director ~]$ sudo subscription-manager repos --disable=*
   [stack@director ~]$ 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=ansible-2.9-for-rhel-8-x86_64-rpms --enable=openstack-16.1-for-rhel-8-x86_64-rpms --enable=fast-datapath-for-rhel-8-x86_64-rpms --enable=advanced-virt-for-rhel-8-x86_64-eus-rpms

   Copy to Clipboard Toggle word wrap

   These repositories contain packages that the director installation requires.

3. Set the container-tools repository module to version 2.0:

   [stack@director ~]$ sudo dnf module reset container-tools
   [stack@director ~]$ sudo dnf module enable -y container-tools:2.0

   Copy to Clipboard Toggle word wrap

4. Synchronize the operating system to ensure that your system packages match the operating system version:

   [stack@director ~]$ sudo dnf distro-sync -y
   [stack@director ~]$ sudo reboot

   Copy to Clipboard Toggle word wrap

Procedure

1. Install the command line tools for director installation and configuration:

   [stack@director ~]$ sudo dnf install -y python3-tripleoclient

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to your undercloud host as the stack user.

2. Generate the default container image preparation file:

   $ sudo openstack tripleo container image prepare default \
     --local-push-destination \
     --output-env-file containers-prepare-parameter.yaml

   Copy to Clipboard Toggle word wrap

   This command includes the following additional options:

   • --local-push-destination sets the registry on the undercloud as the location for container images. This means that director pulls the necessary images from the Red Hat Container Catalog and pushes them to the registry on the undercloud. Director uses this registry as the container image source. To pull directly from the Red Hat Container Catalog, omit this option.

   • --output-env-file is an environment file name. The contents of this file include the parameters for preparing your container images. In this case, the name of the file is containers-prepare-parameter.yaml.

     Note

     You can use the same containers-prepare-parameter.yaml file to define a container image source for both the undercloud and the overcloud.

3. Modify the containers-prepare-parameter.yaml to suit your requirements.

Procedure

1. Log in to your undercloud host as the stack user.
2. Edit the containers-prepare-parameter.yaml file.

3. Add the transitional container parameters to set in the ContainerImagePrepare parameter. Set the parameters in one of the following ways depending on your type of deployment.

   • If your deployment uses a Red Hat Ceph Storage cluster that was deployed using director, add the following parameters:

     parameter_defaults:
       ContainerImagePrepare:
       - push_destination: true
         set:
           ...
           name_prefix_stein: openstack-
           name_suffix_stein: ''
           namespace_stein: registry.redhat.io/rhosp15-rhel8
           tag_stein: 15.0
           ceph3_namespace: registry.redhat.io/rhceph
           ceph3_tag: latest
           ceph3_image: rhceph-3-rhel7
           ...

     Copy to Clipboard Toggle word wrap
     • The *_stein parameters define the container images for Red Hat OpenStack Platform 15, which the upgrade process uses for database migration.
     • The ceph3_* parameters define the current Red Hat Ceph Storage container images that the overcloud uses. The overcloud requires both the ceph3_* and ceph_* parameters for the transition from Red Hat Ceph Storage 3 to 4.
     • If you use Red Hat Satellite Server for container image storage, set the namespaces to the image locations on your Red Hat Satellite Server.

   • If your deployment uses an external Ceph Storage cluster, add the following parameters:

     parameter_defaults:
       ContainerImagePrepare:
       - push_destination: true
         set:
           ...
           name_prefix_stein: openstack-
           name_suffix_stein: ''
           namespace_stein: registry.redhat.io/rhosp15-rhel8
           tag_stein: 15.0
           ceph_namespace: registry.redhat.io/rhceph
           ceph_tag: latest
           ceph_image: rhceph-4-rhel8
           ...

     Copy to Clipboard Toggle word wrap
     • The *_stein parameters define the container images for Red Hat OpenStack Platform 15, which the upgrade process uses for database migration.
     • The ceph_* parameters define the current Red Hat Ceph Storage 4 container images that the overcloud uses.
     • If you use Red Hat Satellite Server for container image storage, set the namespaces to the image locations on your Red Hat Satellite Server.

4. Change the neutron_driver parameter to openvswitch:

   parameter_defaults:
     ContainerImagePrepare:
     - push_destination: true
       set:
         ...
         neutron_driver: openvswitch
         ...

   Copy to Clipboard Toggle word wrap

   The upgrade retains Open vSwitch compatibility throughout the process. After you complete the upgrade to Red Hat OpenStack Platform 16.1, you migrate the overcloud from Open vSwitch to Open Virtual Network (OVN).

5. Save the containers-prepare-parameter.yaml file.

Procedure

1. Log in to your undercloud host as the stack user.
2. Edit the undercloud.conf file.

3. Add the following parameter to the DEFAULT section in the file:

   container_images_file = /home/stack/containers-prepare-parameter.yaml

   Copy to Clipboard Toggle word wrap

   This parameter defines the location of the containers-prepare-parameter.yaml environment file so that director pulls container images for the undercloud from the correct location.

4. Check the generate_service_certificate parameter. The default for this parameter changes from false to true, which enables SSL/TLS on your undercloud, during the upgrade.
5. Check the local_interface parameter if you have migrated to a predictable NIC naming convention.
6. If you set the masquerade_network parameter in Red Hat OpenStack Platform 13, remove this parameter and set masquerade = true for each subnet.
7. Check all other parameters in the file for any changes.
8. Save the file.

Procedure

1. Run the following command to upgrade the director on the undercloud:

   $ openstack undercloud upgrade

   Copy to Clipboard Toggle word wrap

   This command launches the director configuration script. The director upgrades its packages and configures its services to suit the settings in the undercloud.conf. This script takes several minutes to complete.

   Note

   The director configuration script prompts for confirmation before proceeding. Bypass this confirmation using the -y option:

   $ openstack undercloud upgrade -y

   Copy to Clipboard Toggle word wrap

2. The script also starts all OpenStack Platform service containers on the undercloud automatically. You manage each service through a systemd resource. Check the systemd resources:

   $ sudo systemctl list-units "tripleo_*"

   Copy to Clipboard Toggle word wrap

   Each systemd service controls a container. Check the enabled containers using the following command:

   $ sudo podman ps

   Copy to Clipboard Toggle word wrap

3. The script adds the stack user to the docker group to ensure that the stack user has access to container management commands. Refresh the stack user permissions with the following command:

   $ exec su -l stack

   Copy to Clipboard Toggle word wrap

   The command prompts you to log in again. Enter the stack user password.

4. To initialize the stack user to use the command line tools, run the following command:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

   The prompt now indicates OpenStack commands authenticate and execute against the undercloud;

   (undercloud) $

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file.

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Create a static inventory file of all nodes:

   $ tripleo-ansible-inventory --static-yaml-inventory ~/inventory.yaml --stack STACK_NAME

   Copy to Clipboard Toggle word wrap

   If you are not using the default overcloud stack name, set your stack name with the --stack STACK NAME option replacing STACK NAME with the name of your stack.

4. To execute Ansible playbooks on your environment, run the ansible-playbook command and include the full path of the dynamic inventory tool using the -i option. For example:

   (undercloud) $ ansible-playbook -i ~/inventory.yaml PLAYBOOK

   Copy to Clipboard Toggle word wrap

Procedure

1. Source the stackrc file.

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the openstack tripleo validator run command with the --group pre-upgrade option and include the /usr/libexec/platform-python python runtime environment:

   $ openstack tripleo validator run --group pre-upgrade --python-interpreter /usr/libexec/platform-python -i inventory.yaml

   Copy to Clipboard Toggle word wrap

3. Review the results of the validation report. To view detailed output from a specific validation, run the openstack tripleo validator show run --full command against the UUID of the specific validation from the report:

   $ openstack tripleo validator show run  --full <UUID>

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file.

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Log in to a Controller node and run the Pacemaker command to disable fencing:

   $ ssh heat-admin@CONTROLLER_IP "sudo pcs property set stonith-enabled=false"

   Copy to Clipboard Toggle word wrap
4. In the fencing.yaml environment file, set the EnableFencing parameter to false to ensure that fencing stays disabled during the upgrade process.

Procedure

1. Select an environment file and the check if it has an ExtraConfig parameter:

   $ grep ExtraConfig ~/templates/custom-config.yaml

   Copy to Clipboard Toggle word wrap
2. If the results show an ExtraConfig parameter for any role (e.g. ControllerExtraConfig) in the chosen file, check the full parameter structure in that file.

3. If the parameter contains any puppet Hierdata with a SECTION/parameter syntax followed by a value, it might have been been replaced with a parameter with an actual Puppet class. For example:

   parameter_defaults:
     ExtraConfig:
       neutron::config::dhcp_agent_config:
         'DEFAULT/dnsmasq_local_resolv':
           value: 'true'

   Copy to Clipboard Toggle word wrap

4. Check the director’s Puppet modules to see if the parameter now exists within a Puppet class. For example:

   $ grep dnsmasq_local_resolv

   Copy to Clipboard Toggle word wrap

   If so, change to the new interface.

5. The following are examples to demonstrate the change in syntax:

   • Example 1:

     parameter_defaults:
       ExtraConfig:
         neutron::config::dhcp_agent_config:
           'DEFAULT/dnsmasq_local_resolv':
             value: 'true'

     Copy to Clipboard Toggle word wrap

     Changes to:

     parameter_defaults:
       ExtraConfig:
         neutron::agents::dhcp::dnsmasq_local_resolv: true

     Copy to Clipboard Toggle word wrap

   • Example 2:

     parameter_defaults:
       ExtraConfig:
         ceilometer::config::ceilometer_config:
           'oslo_messaging_rabbit/rabbit_qos_prefetch_count':
             value: '32'

     Copy to Clipboard Toggle word wrap

     Changes to:

     parameter_defaults:
       ExtraConfig:
         oslo::messaging::rabbit::rabbit_qos_prefetch_count: '32'

     Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Create an environment file called upgrades-environment.yaml in your templates directory:

   $ touch templates/upgrades-environment.yaml

   Copy to Clipboard Toggle word wrap

3. Edit the file and add the following mandatory content:

   parameter_defaults:
     UpgradeLeappDevelSkip: "LEAPP_UNSUPPORTED=1 LEAPP_DEVEL_TARGET_RELEASE=8.2"
     LeappInitCommand: |
       for module in pata_acpi floppy; do sudo sed -i "/^${module}$/d" /usr/share/leapp-repository/repositories/system_upgrade/el7toel8/actors/kernel/checkkerneldrivers/files/removed_drivers.txt; done
       sudo rm -f /usr/share/leapp-repository/repositories/system_upgrade/el7toel8/actors/persistentnetnamesdisable/actor.py
       sudo yum -y remove mariadb-server* || true
     UpgradeInitCommand: "sudo dnf config-manager --save --setopt exclude=''"

   Copy to Clipboard Toggle word wrap
   • UpgradeLeappDevelSkip skips Leapp checks and sets environment variables when Leapp runs.
   • LeappInitCommand passes commands or script snippets that run on each of the overcloud nodes, and prepares the nodes for the Leapp upgrade.
   • UpgradeInitCommand passes commands or script snippets that run on each of the overcloud nodes. The dnf config-manager --save --setopt exclude='' command removes Leapp packages from DNF exclusion so that automatic removal of python2 packages is successful.

4. Optional: If you use TLS-Everywhere in your environment and want to migrate from authconfig to authselect, set the authselect_check.confirm parameter to True to avoid bug BZ#1978228 - OSP13→16.2 Leapp upgrade failed with TLSEverywhere:

   parameter_defaults:
     LeappInitCommand: |
       sudo leapp answer --section authselect_check.confirm=True --add

   Copy to Clipboard Toggle word wrap

   Otherwise, set the value to False.

   Note

   Use the | syntax to pass multiple commands to the LeappInitCommand parameter:

   parameter-defaults:
     LeappInitCommand: |
       <command_1>
       <command_2>

   Copy to Clipboard Toggle word wrap
5. Save the upgrades-environment.yaml file.

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file.

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Create a static inventory file of all the nodes in your environment:

   $ tripleo-ansible-inventory --static-yaml-inventory ~/inventory.yaml --stack STACK_NAME

   Copy to Clipboard Toggle word wrap

   If you are not using the default overcloud stack name, set your stack name with the --stack STACK NAME option replacing STACK NAME with the name of your stack.

4. To copy the leapp data to the overcloud nodes, run the following synchronize Ansible command:

   $ ansible -i ~/inventory.yaml --become -m synchronize -a "src=/etc/leapp/files dest=/etc/leapp/" overcloud

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user.

2. Run the playbook-nics.yaml playbook on all overcloud nodes:

   $ ansible-playbook -i ~/inventory.yaml playbook-nics.yaml

   Copy to Clipboard Toggle word wrap

   The playbook sets the new NIC prefix to em. To set a different NIC prefix, set the prefix variable when running the playbook:

   $ ansible-playbook -i ~/inventory.yaml -e prefix="mynic" playbook-nics.yaml

   Copy to Clipboard Toggle word wrap

   The NIC changes are only applied after the Leapp upgrade process completes and the node is rebooted.

Procedure

1. Search for custom environment files that use composable services. You usually store custom environment files in the /home/stack/templates directory:

   $ cd ~/templates/
   $ grep "OS::TripleO::Services" *

   Copy to Clipboard Toggle word wrap

   In this scenario, one of the files shows an outdated mapping:

     OS::TripleO::Services::CephMgr: /usr/share/openstack-tripleo-heat-templates/docker/services/ceph-ansible/ceph-mgr.yaml

   Copy to Clipboard Toggle word wrap

2. Identify the new ceph-mgr.yaml location in /usr/share/openstack-tripleo-heat-templates/. This file is now located in the `deployment/ceph-ansible' directory:

   $ find /usr/share/openstack-tripleo-heat-templates/ -name ceph-mgr.yaml
   /usr/share/openstack-tripleo-heat-templates/deployment/ceph-ansible/ceph-mgr.yaml

   Copy to Clipboard Toggle word wrap

3. Edit the service in the custom environment file:

   resource_registry:
     OS::TripleO::Services::CephMgr: /usr/share/openstack-tripleo-heat-templates/deployment/ceph-ansible/ceph-mgr.yaml

   Copy to Clipboard Toggle word wrap

   Save the file.

Procedure

1. Log in to the undercloud as the stack user.

2. Obtain the control plane host name on the undercloud:

   $ sudo hiera container_image_prepare_node_names
   ["undercloud.ctlplane.localdomain"]

   Copy to Clipboard Toggle word wrap

3. Edit the containers-prepare-parameter.yaml file and add the DockerInsecureRegistryAddress parameter with a YAML list that contains the control plane host name of the undercloud and the IP address of the undercloud on the provisioning network:

   parameter_defaults:
     DockerInsecureRegistryAddress:
     - undercloud.ctlplane.localdomain:8787
     - 192.168.24.1:8787
     ...

   Copy to Clipboard Toggle word wrap

   You must also append the port number of the overcloud registry to the host name and IP address values. The port number is 8787.

Procedure

1. Log in to the undercloud as the stack user.

2. Set the Compute naming format:

   • If you use a custom roles_data file, edit the custom roles_data file and set the HostnameFormatDefault parameter for the Compute role:

     - name: Compute
       …​
       HostnameFormatDefault: '%stackname%-compute-%index%'
       …​

     Copy to Clipboard Toggle word wrap

     Save the custom roles_data file.

   • If you use the default roles_data file in openstack-tripleo-heat-templates, set the naming format in an environment file. Edit the environment file with your node counts and flavors, which is usually named node-info.yaml. Add the ComputeHostnameFormat parameter to the parameter_defaults section:

     parameter_defaults:
       …​
       ComputeHostnameFormat: '%stackname%-compute-%index%'
       …​

     Copy to Clipboard Toggle word wrap

     Save the node-info.yaml file.

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file:

   [stack@director ~]$ source ~/stackrc

   Copy to Clipboard Toggle word wrap
3. Open an environment file.

4. Add the following configuration to your environment file to specify that the instance serial number is based on the serial number of the host:

   parameter_defaults:
     <Role>ExtraConfig:
       nova::config::nova_config:
         libvirt/sysinfo_serial:
           value: auto

   Copy to Clipboard Toggle word wrap
5. Save the updates to your environment file, and add the file to your overcloud upgrade and deployment commands.

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap
3. Edit your custom overcloud SSL/TLS public endpoint file, which is usually named ~/templates/enable-tls.yaml.

4. Remove the NodeTLSData resource from the `resource_registry:

   resource_registry:
     OS::TripleO::NodeTLSData: /usr/share/openstack-tripleo-heat-templates/puppet/extraconfig/tls/tls-cert-inject.yaml
     …​

   Copy to Clipboard Toggle word wrap

   The overcloud deployment uses a new service in HAProxy to determine if SSL/TLS is enabled.

   Note

   If this is the only resource in the resource_registry section of the enable-tls.yaml file, remove the complete resource_registry section.

5. Save the SSL/TLS public endpoint file file.

Procedure

1. Edit the post-configuration template.

2. Under the parameters section, add the EndpointMap parameter and its sub-parameters:

   parameters:
     servers:
       type: json
     nameserver_ip:
       type: string
     DeployIdentifier:
       type: string
     EndpointMap:
       default: {}
       type: json

   Copy to Clipboard Toggle word wrap
3. Save the template.

Procedure

1. Exclude the rhel-registration environment files from future deployments operations. In most cases, exclude the following files:

   • rhel-registration/environment-rhel-registration.yaml
   • rhel-registration/rhel-registration-resource-registry.yaml

2. If you use a custom roles_data file, ensure that each role in your roles_data file contains the OS::TripleO::Services::Rhsm composable service. For example:

   - name: Controller
     description: |
       Controller role that has all the controller services loaded and handles
       Database, Messaging and Network functions.
     CountDefault: 1
     ...
     ServicesDefault:
       ...
       - OS::TripleO::Services::Rhsm
       ...

   Copy to Clipboard Toggle word wrap
3. Add the environment file for rhsm composable service parameters to future deployment operations.

Procedure

1. Create an environment file named templates/rhsm.yml to store the configuration.

2. Include your configuration in the environment file. For example:

   resource_registry:
     OS::TripleO::Services::Rhsm: /usr/share/openstack-tripleo-heat-templates/deployment/rhsm/rhsm-baremetal-ansible.yaml
   parameter_defaults:
     RhsmVars:
       rhsm_repos:
         - rhel-8-for-x86_64-baseos-tus-rpms
         - rhel-8-for-x86_64-appstream-tus-rpms
         - rhel-8-for-x86_64-highavailability-tus-rpms
         …​
       rhsm_username: "myusername"
       rhsm_password: "p@55w0rd!"
       rhsm_org_id: "1234567"
       rhsm_pool_ids: "1a85f9223e3d5e43013e3d6e8ff506fd"
       rhsm_method: "portal"
       rhsm_release: 8.2

   Copy to Clipboard Toggle word wrap
   • The resource_registry section associates the rhsm composable service with the OS::TripleO::Services::Rhsm resource, which is available on each role.
   • The RhsmVars variable passes parameters to Ansible for configuring your Red Hat registration.
3. Save the environment file.

Procedure

1. Create an environment file named templates/rhsm.yml to store the configuration.

2. Include your configuration in the environment file. For example:

   resource_registry:
     OS::TripleO::Services::Rhsm: /usr/share/openstack-tripleo-heat-templates/deployment/rhsm/rhsm-baremetal-ansible.yaml
   parameter_defaults:
     ControllerParameters:
       RhsmVars:
         rhsm_repos:
           - rhel-8-for-x86_64-baseos-tus-rpms
           - rhel-8-for-x86_64-appstream-tus-rpms
           - rhel-8-for-x86_64-highavailability-tus-rpms
           - ansible-2.9-for-rhel-8-x86_64-rpms
           - advanced-virt-for-rhel-8-x86_64-eus-rpms
           - openstack-16.1-for-rhel-8-x86_64-rpms
           - fast-datapath-for-rhel-8-x86_64-rpms
         rhsm_username: "myusername"
         rhsm_password: "p@55w0rd!"
         rhsm_org_id: "1234567"
         rhsm_pool_ids: "55d251f1490556f3e75aa37e89e10ce5"
         rhsm_method: "portal"
         rhsm_release: 8.2
     ComputeParameters:
       RhsmVars:
         rhsm_repos:
           - rhel-8-for-x86_64-baseos-tus-rpms
           - rhel-8-for-x86_64-appstream-tus-rpms
           - rhel-8-for-x86_64-highavailability-tus-rpms
           - ansible-2.9-for-rhel-8-x86_64-rpms
           - advanced-virt-for-rhel-8-x86_64-eus-rpms
           - openstack-16.1-for-rhel-8-x86_64-rpms
           - fast-datapath-for-rhel-8-x86_64-rpms
         rhsm_username: "myusername"
         rhsm_password: "p@55w0rd!"
         rhsm_org_id: "1234567"
         rhsm_pool_ids: "55d251f1490556f3e75aa37e89e10ce5"
         rhsm_method: "portal"
         rhsm_release: 8.2
     CephStorageParameters:
       RhsmVars:
         rhsm_repos:
           - rhel-8-for-x86_64-baseos-tus-rpms
           - rhel-8-for-x86_64-appstream-tus-rpms
           - rhel-8-for-x86_64-highavailability-tus-rpms
           - ansible-2.9-for-rhel-8-x86_64-rpms
           - openstack-16.1-deployment-tools-for-rhel-8-x86_64-rpms
         rhsm_username: "myusername"
         rhsm_password: "p@55w0rd!"
         rhsm_org_id: "1234567"
         rhsm_pool_ids: "68790a7aa2dc9dc50a9bc39fabc55e0d"
         rhsm_method: "portal"
         rhsm_release: 8.2

   Copy to Clipboard Toggle word wrap

   The resource_registry associates the rhsm composable service with the OS::TripleO::Services::Rhsm resource, which is available on each role.

   The ControllerParameters, ComputeParameters, and CephStorageParameters parameters each use a separate RhsmVars parameter to pass subscription details to their respective roles.

   Note

   Set the RhsmVars parameter within the CephStorageParameters parameter to use a Red Hat Ceph Storage subscription and repositories specific to Ceph Storage. Ensure the rhsm_repos parameter contains the standard Red Hat Enterprise Linux repositories instead of the Extended Update Support (EUS) repositories that Controller and Compute nodes require.

3. Save the environment file.

Procedure

1. Exclude the rhel-registration environment files from future deployments operations. In most cases, exclude the following files:

   • rhel-registration/environment-rhel-registration.yaml
   • rhel-registration/rhel-registration-resource-registry.yaml

2. If you use a custom roles_data file, ensure that each role in your roles_data file contains the OS::TripleO::Services::Rhsm composable service. For example:

   - name: Controller
     description: |
       Controller role that has all the controller services loaded and handles
       Database, Messaging and Network functions.
     CountDefault: 1
     ...
     ServicesDefault:
       ...
       - OS::TripleO::Services::Rhsm
       ...

   Copy to Clipboard Toggle word wrap
3. Add the environment file for rhsm composable service parameters to future deployment operations.