Procedure

1. Log in to the undercloud host as the stack user.
2. Edit the undercloud.conf file located in the home directory of the stack user.

3. Set the enable_tempest parameter to true.

   enable_tempest = true

4. Run the openstack undercloud install command to include the extra configuration in the undercloud:

   $ openstack undercloud install

Procedure

1. Ensure that the following networks are available within your Red Hat OpenStack Platform (RHOSP) environment:

   • An external network that can provide a floating IP.

   • A private network.

     Connect these networks through a router.

     1. To create the private network, specify the following options according to your network deployment:

        $ openstack network create <network_name> --share
        $ openstack subnet create <subnet_name> --subnet-range <address/prefix> \
          --network <network_name>
        $ openstack router create <router_name>
        $ openstack router add subnet <router_name> <subnet_name>

     2. To create the public network, specify the following options according to your network deployment:

        $ openstack network create <network_name> --external \
          --provider-network-type flat \
          --provider-physical-network datacentre
        $ openstack subnet create <subnet_name> --subnet-range <address/prefix> \
          --gateway <default_gateway> --no-dhcp --network <network_name>
        $ openstack router set <router_name> --external-gateway <public_network_name>

2. Install the packages related to the Integration Test Suite:

   $ sudo dnf -y install openstack-tempest

   This command does not install any tempest plugins. You must install the plugins manually, depending on your RHOSP installation.

3. Install the appropriate tempest plugin for each component in your environment. For example, enter the following command to install the keystone, neutron, cinder, and telemetry plugins:

   $ sudo dnf install python3-keystone-tests-tempest python3-neutron-tests-tempest python3-cinder-tests-tempest python3-telemetry-tests-tempest

   For a full list of packages, see Integration Test Suite packages.

Procedure

1. Source the credentials for the target deployment:

   • If the target is in the undercloud, source the credentials for the undercloud:

     # source stackrc

   • If the target is in the overcloud, source the credentials for the overcloud:

     # source overcloudrc

2. Initialize tempest:

   # tempest init mytempest
   # cd mytempest

   This command creates a tempest workspace named mytempest.

3. Optional: Enter the following command to view a list of existing workspaces:

   # tempest workspace list

4. Generate the etc/tempest.conf file:

   # discover-tempest-config --deployer-input ~/tempest-deployer-input.conf \
   --debug --create --network-id <UUID>

   Replace UUID with the UUID of the external network.

   discover-tempest-config was formerly called config_tempest.py and uses the same parameters. python-tempestconf is as a dependency of openstack-tempest and provides the discover-tempest-config.

   Note

   To generate the etc/tempest.conf file for the undercloud, ensure that the region name in the tempest-deployer-input.conf file is the same as the name in the undercloud deployment. If these names do not match, update the region name in the tempest-deployer-input.conf file to match the region name of your undercloud.

5. To inspect the region name of your undercloud, enter the following commands:

   $ source stackrc
   $ openstack region list

6. To inspect the region name of your overcloud, enter the following commands:

   $ source overcloudrc
   $ openstack region list

Procedure

1. In tempest.conf, under the [DEFAULT] section, set log_dir to the desired directory:

   [DEFAULT]
   log_dir = <directory>

2. If you have your own logging configuration file, in tempest.conf, under the [DEFAULT] section, set log_config_append to your file:

   [DEFAULT]
   log_config_append = <file>

Procedure

1. Configure options in the tempest.conf configuration file to specify the target microversions. Configure these options to ensure that the supported microversions correspond to the microversions in the OpenStack cloud.

2. You can specify a range of target microversions to run multiple microversion tests in a single Integration Test Suite operation.

   For example, to limit the range of microversions for the compute service, in the [compute] section of your configuration file, assign values to the min_microversion and max_microversion parameters:

   [compute]
   min_microversion = 2.14
   max_microversion = latest

Procedure

1. Change to the /home/stack directory.

   $ cd /home/stack

2. Download the tempest container:

   $ podman pull registry.redhat.io/rhosp-rhel8/openstack-tempest:16.0

   This container includes all tempest plugins. Running tests globally with this container includes tests for plugins. For example, if you enter the tempest run --regex '(*.)' command, Integration Test Suite runs all plug-in tests. These tests fail if your deployment does not contain configuration for all plug-ins. Enter the tempest list-plugins command to view all installed plugins. To exclude tests, you must include the tests that you want to exclude in a blocklist file. For more information, see Section 4.5, “Skipping tests by using blocklist files”

3. Create directories to use to exchange data between the host machine and the container:

   $ mkdir container_tempest tempest_workspace

4. Copy the necessary files to the container_tempest directory. This directory is the file source for the container:

   $ cp stackrc overcloudrc tempest-deployer-input.conf container_tempest

5. List the available container images:

   $ podman images
   REPOSITORY                                                  TAG        IMAGE ID            CREATED             SIZE
   registry.redhat.io/rhosp-rhel8/openstack-tempest   latest     881f7ac24d8f        10 days ago         641 MB

6. Create an alias to facilitate easier command entry. Ensure that you use absolute paths when you mount the directories:

   $ alias podman-tempest="podman run -i --privileged=true\
       -v "$(pwd)"/container_tempest:/home/stack/container_tempest:z \
       -v "$(pwd)"/tempest_workspace:/home/stack/tempest_workspace:z \
       registry.redhat.io/rhosp-rhel8/openstack-tempest:16.0 \
       /bin/bash"

7. To retrieve a list of available tempest plugins in the container, enter the following command:

   $ podman-tempest -c "rpm -qa | grep tempest"

Procedure

1. Create a tempest script that you can use to execute within the container to generate the tempest.conf file and run the tempest tests.

2. Copy the following set of commands and paste them in a Linux console to create your tempest script:

   $ cat <<'EOF'>> /home/stack/container_tempest/tempest_script.sh
   set -e
   source /home/stack/container_tempest/overcloudrc
   tempest init /home/stack/tempest_workspace
   pushd /home/stack/tempest_workspace
   
   export TEMPESTCONF="/usr/bin/discover-tempest-config"
   
   $TEMPESTCONF \
     --out /home/stack/tempest_workspace/etc/tempest.conf \
     --deployer-input /home/stack/container_tempest/tempest-deployer-input.conf \
     --debug \
     --create \
     object-storage.reseller_admin ResellerAdmin
   
   tempest run --smoke

   The script performs the following actions:

   • set -e
   • Sets the exit status for the command.
   • Sources the overcloudrc file if you want to run tempest against the overcloud. Sources the stackrc file if you want to run tempest against the undercloud.
   • Runs tempest init to create a tempest workspace. Use the shared directory so that the files are also accessible from the host.
   • Changes directory to tempest_workspace
   • Exports the TEMPESTCONF environment variable for ease of use at a later stage.
   • Executes discover-tempest-config to generate the tempest.conf file. For more information about the options that you can include in the discover-tempest-config command, run discover-tempest-config --help.
   • Sets --out to home/stack/tempest_workspace/tempest.conf so that the tempest.conf file is accessible from the host machine.
   • Sets --deployer-input to point to the tempest-deployer-input.conf file in the shared directory.

   • Runs tempest tests. This example script runs the smoke test tempest run --smoke.

     If you already have a tempest.conf file and you want to run only the tempest tests, omit TEMPESTCONF from the script and replace it with a command to copy your tempest.conf file from the container_tempest directory to the tempest_workspace/etc directory:

     $ cp /home/stack/container_tempest/tempest.conf /home/stack/tempest_workspace/etc/tempest.conf

3. Set executable privileges on the tempest_script.sh script:

   $ chmod +x container_tempest/tempest_script.sh

4. Run the tempest script from the container by using the alias that you created in a previous step:

   $ podman-tempest -c 'set -e; /home/stack/container_tempest/tempest_script.sh'

5. Inspect the .stestr directory for information about the test results.

6. If you want to rerun the tempest tests, you must first remove and recreate the tempest workspace:

   $ sudo rm -rf /home/stack/tempest_workspace
   $ mkdir /home/stack/tempest_workspace

Procedure

1. If you want to run tempest tests against the overcloud, source the overcloudrc file.

   # source /home/stack/container_tempest/overcloudrc

2. If you want to run tempest tests against the undercloud, source the stackrc file:

   # source /home/stack/container_tempest/stackrc

3. Create a tempest workspace. Use the shared directory so that the files are also accessible from the host:

   # tempest init /home/stack/tempest_workspace

4. Generate the tempest.conf file:

   # discover-tempest-config \
   --out /home/stack/tempest_workspace/tempest.conf \
   --deployer-input /home/stack/container_tempest/tempest-deployer-input-conf \
   --debug \
   --create \
   object-storage.reseller_admin ResellerAdmin

   For more information about the options that you can include in the discover-tempest-config command, enter discover-tempest-config --help.

5. Execute the tempest tests. For example, enter the following command to execute the tempest smoke test with the alias you created in a previous step:

   # podman-tempest -c "tempest run --smoke"

6. Inspect the .stestr directory for information about the test results.

7. If you want to rerun the tempest tests, you must first remove and recreate the tempest workspace:

   $ sudo rm -rf /home/stack/tempest_workspace
   $ mkdir /home/stack/tempest_workspace

Procedure

1. Initialize the saved state to create the file saved_state.json, which prevents the cleanup from deleting necessary objects:

   # tempest cleanup --init-saved-state

2. Perform the cleanup:

   # tempest cleanup

Procedure

1. Complete the dry run:

   # tempest cleanup --dry-run

2. Review the dry_run.json file to ensure that the cleanup does not delete any files that you require for your environment.