Chapter 6. Upgrading the overcloud

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the fast forward upgrade preparation command with all relevant options and environment files appropriate to your deployment:

   $ openstack overcloud ffwd-upgrade prepare \
       --templates \
       -e /home/stack/templates/overcloud_images.yaml \
       -e /home/stack/templates/deprecated_cli_options.yaml \
       -e /home/stack/templates/custom_repositories_script.yaml \
       -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible.yaml \
       -e /home/stack/templates/ceph-customization.yaml \
       -e <ENVIRONMENT FILE>

   Copy to Clipboard Toggle word wrap

   Include the following options relevant to your environment:

   • Custom configuration environment files (-e). For example:

     • The environment file with your container image locations (overcloud_images.yaml). Note that the upgrade command might display a warning about using the --container-registry-file. You can ignore this warning as this option is deprecated in favor of using -e for the container image environment file.
     • If applicable, an environment file that maps deprecated CLI options to Heat parameters using deprecated_cli_options.yaml.
     • If applicable, an environment file with your custom repository script using custom_repositories_script.yaml.
     • If using Ceph Storage nodes, the relevant environment files.
     • Any additional environment files relevant to your environment.
   • If using a custom stack name, pass the name with the --stack option.
   • If applicable, your custom roles (roles_data) file using --roles-file.
   Important

   A prompt will ask if you are sure you want to perform the ffwd-upgrade command. Enter yes.

   Note

   You can run the openstack ffwd-upgrade prepare command multiple times. If the command fails, you can fix an issue in your templates and then rerun the command.

3. The overcloud plan updates to the OpenStack Platform 13 version. Wait until the fast forward upgrade preparation completes.
4. Create a snapshot or backup of the overcloud before proceding with the upgrade.

5. Run the fast forward upgrade command:

   $ openstack overcloud ffwd-upgrade run

   Copy to Clipboard Toggle word wrap
   • If using a custom stack name, pass the name with the --stack option.
   Important

   A prompt will ask if you are sure you want to perform the ffwd-upgrade command. Enter yes.

   Note

   You can run the openstack ffwd-upgrade run command multiple times. If the command fails, you can fix an issue in your templates and then rerun the command.

6. Wait until the fast forward upgrade completes.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. If you use monolithic Controller nodes, run the upgrade command against the Controller role:

   $ openstack overcloud upgrade run --nodes Controller --skip-tags validation

   Copy to Clipboard Toggle word wrap
   • If you use a custom stack name, pass the name with the --stack option.

3. If you use Controller services split across multiple roles:

   1. Run the upgrade command for roles with Pacemaker services:

      $ openstack overcloud upgrade run --nodes ControllerOpenStack --skip-tags validation
      $ openstack overcloud upgrade run --nodes Database --skip-tags validation
      $ openstack overcloud upgrade run --nodes Messaging --skip-tags validation
      $ openstack overcloud upgrade run --nodes Telemetry --skip-tags validation

      Copy to Clipboard Toggle word wrap
      • If you use a custom stack name, pass the name with the --stack option.

   2. Run the upgrade command for the Networker role:

      $ openstack overcloud upgrade run --nodes Networker --skip-tags validation

      Copy to Clipboard Toggle word wrap
      • If you use a custom stack name, pass the name with the --stack option.

   3. Run the upgrade command for any remaining custom roles, except for Compute or CephStorage roles:

      $ openstack overcloud upgrade run --nodes ObjectStorage --skip-tags validation

      Copy to Clipboard Toggle word wrap
      • If you use a custom stack name, pass the name with the --stack option.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the upgrade command:

   $ openstack overcloud upgrade run --nodes compute-0 --skip-tags validation

   Copy to Clipboard Toggle word wrap
   Note

   The command uses --skip-tags validation because OpenStack Platform services are inactive on the overcloud and cannot be validated.

   • If using a custom stack name, pass the name with the --stack option.
3. Wait until the test node upgrade completes.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the upgrade command:

   $ openstack overcloud upgrade run --nodes Compute --skip-tags validation

   Copy to Clipboard Toggle word wrap
   Note

   The command uses --skip-tags validation because OpenStack Platform services are inactive on the overcloud and cannot be validated.

   • If you are using a custom stack name, pass the name with the --stack option.
   • If you are using custom Compute roles, ensure that you include the role names with the --nodes option.
3. Wait until the Compute node upgrade completes.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the upgrade command:

   $ openstack overcloud upgrade run --nodes CephStorage --skip-tags validation

   Copy to Clipboard Toggle word wrap
   Note

   The command uses --skip-tags validation because OpenStack Platform services are inactive on the overcloud and cannot be validated.

   • If using a custom stack name, pass the name with the --stack option.
3. Wait until the node upgrade completes.

4. Run the Ceph Storage upgrade command. For example:

   $ openstack overcloud ceph-upgrade run \
       --templates \
       -e <ENVIRONMENT FILE> \
       -e /home/stack/templates/overcloud_images.yaml \
       -e /home/stack/templates/deprecated_cli_options.yaml \
       -e /home/stack/templates/custom_repositories_script.yaml
       -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible.yaml \
       -e /home/stack/templates/ceph-customization.yaml \
       --ceph-ansible-playbook '/usr/share/ceph-ansible/infrastructure-playbooks/switch-from-non-containerized-to-containerized-ceph-daemons.yml,/usr/share/ceph-ansible/infrastructure-playbooks/rolling_update.yml'

   Copy to Clipboard Toggle word wrap

   Include the following options relevant to your environment:

   • Custom configuration environment files (-e). For example:

     • The environment file with your container image locations (overcloud_images.yaml). Note that the upgrade command might display a warning about using the --container-registry-file. You can ignore this warning as this option is deprecated in favor of using -e for the container image environment file.
     • If applicable, an environment file that maps deprecated CLI options to Heat parameters using deprecated_cli_options.yaml.
     • If applicable, an environment file with your custom repository script using custom_repositories_script.yaml.
     • The relevant environment files for your Ceph Storage nodes.
     • Any additional environment files relevant to your environment.
   • If using a custom stack name, pass the name with the --stack option.
   • If applicable, your custom roles (roles_data) file using --roles-file.
   • The following ansible playbooks:
   • /usr/share/ceph-ansible/infrastructure-playbooks/switch-from-non-containerized-to-containerized-ceph-daemons.yml
   • /usr/share/ceph-ansible/infrastructure-playbooks/rolling_update.yml
5. Wait until the Ceph Storage node upgrade completes.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the upgrade command:

   $ openstack overcloud upgrade run --roles ComputeHCI

   Copy to Clipboard Toggle word wrap

   If you are using a custom stack name, pass the name to the upgrade command with the --stack option.

3. Run the Ceph Storage upgrade command. For example:

   $ openstack overcloud ceph-upgrade run \
       --templates \
       -e /home/stack/templates/overcloud_images.yaml \
       -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible.yaml \
       -e /home/stack/templates/ceph-customization.yaml \
       -e <ENVIRONMENT FILE>

   Copy to Clipboard Toggle word wrap

   Include the following options relevant to your environment:

   • Custom configuration environment files (-e). For example:

     • The environment file with your container image locations (overcloud_images.yaml). Note that the upgrade command might display a warning about using the --container-registry-file. You can ignore this warning as this option is deprecated in favor of using -e for the container image environment file.
     • If applicable, an environment file that maps deprecated CLI options to Heat parameters using deprecated_cli_options.yaml.
     • If applicable, an environment file with your custom repository script using custom_repositories_script.yaml.
     • The relevant environment files for your Ceph Storage nodes.
   • If using a custom stack name, pass the name with the --stack option.
   • If applicable, your custom roles (roles_data) file using --roles-file.
   • The following ansible playbooks:
   • /usr/share/ceph-ansible/infrastructure-playbooks/switch-from-non-containerized-to-containerized-ceph-daemons.yml
   • /usr/share/ceph-ansible/infrastructure-playbooks/rolling_update.yml
4. Wait until the Ceph Storage node upgrade completes.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the upgrade command for the Compute node:

   $ openstack overcloud upgrade run --roles Compute
   If using a custom stack name, pass the name with the --stack option.

   Copy to Clipboard Toggle word wrap
3. Wait until the node upgrade completes.

4. Run the upgrade command for the ComputeHCI node:

   $ openstack overcloud upgrade run --roles ComputeHCI
   If using a custom stack name, pass the name with the --stack option.

   Copy to Clipboard Toggle word wrap
5. Wait until the node upgrade completes.

6. Run the upgrade command for the Ceph Storage node:

   $ openstack overcloud upgrade run --roles CephStorage

   Copy to Clipboard Toggle word wrap
7. Wait until the Ceph Storage node upgrade completes.

8. Run the Ceph Storage upgrade command. For example:

   $ openstack overcloud ceph-upgrade run \
       --templates \
       -e /home/stack/templates/overcloud_images.yaml \
       -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible.yaml \
       -e /home/stack/templates/ceph-customization.yaml \
       -e <ENVIRONMENT FILE>

   Copy to Clipboard Toggle word wrap

   Include the following options relevant to your environment:

   • Custom configuration environment files (-e). For example:

     • The environment file with your container image locations (overcloud_images.yaml). Note that the upgrade command might display a warning about using the --container-registry-file. You can ignore this warning as this option is deprecated in favor of using -e for the container image environment file.
     • If applicable, an environment file that maps deprecated CLI options to Heat parameters using deprecated_cli_options.yaml.
     • If applicable, an environment file with your custom repository script using custom_repositories_script.yaml.
     • The relevant environment files for your Ceph Storage nodes.
     • Any additional environment files relevant to your environment.
   • If using a custom stack name, pass the name with the --stack option.
   • If applicable, your custom roles (roles_data) file using --roles-file.
   • The following ansible playbooks:
   • /usr/share/ceph-ansible/infrastructure-playbooks/switch-from-non-containerized-to-containerized-ceph-daemons.yml
   • /usr/share/ceph-ansible/infrastructure-playbooks/rolling_update.yml
9. Wait until the Ceph Storage node upgrade completes.

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the fast forward upgrade finalization command:

   $ openstack overcloud ffwd-upgrade converge \
       --templates \
       -e /home/stack/templates/overcloud_images.yaml \
       -e /home/stack/templates/deprecated_cli_options.yaml \
       -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible.yaml \
       -e /home/stack/templates/ceph-customization.yaml \
       -e <OTHER ENVIRONMENT FILES>

   Copy to Clipboard Toggle word wrap

   Include the following options relevant to your environment:

   • Custom configuration environment files (-e). For example:

     • The environment file with your container image locations (overcloud_images.yaml). Note that the upgrade command might display a warning about using the --container-registry-file. You can ignore this warning as this option is deprecated in favor of using -e for the container image environment file.
     • If applicable, an environment file that maps deprecated CLI options to Heat parameters using deprecated_cli_options.yaml.
     • If using Ceph Storage nodes, the relevant environment files.
     • Any additional environment files relevant to your environment.
   • If using a custom stack name, pass the name with the --stack option.
   • If applicable, your custom roles (roles_data) file using --roles-file.
   Important

   A prompt will ask if you are sure you want to perform the ffwd-upgrade command. Enter yes.

3. Wait until the fast forward upgrade finalization completes.