Chapter 14. Using the validation framework

Important

This feature is available in this release as a Technology Preview, and therefore is not fully supported by Red Hat. It should only be used for testing, and should not be deployed in a production environment. For more information about Technology Preview features, see Scope of Coverage Details.

Red Hat OpenStack Platform includes a validation framework that you can use to verify the requirements and functionality of the undercloud and overcloud. The framework includes two types of validations:

  • Manual Ansible-based validations, which you execute through the openstack tripleo validator command set.
  • Automatic in-flight validations, which execute during the deployment process.

14.1. Ansible-based validations

During the installation of Red Hat OpenStack Platform director, director also installs a set of playbooks from the openstack-tripleo-validations package. Each playbook contains tests for certain system requirements and a set of groups that define when to run the test:

no-op
Validations that run a no-op (no operation) task to verify to workflow functions correctly. These validations run on both the undercloud and overcloud.
prep
Validations that check the hardware configuration of the undercloud node. Run these validation before you run the openstack undercloud install command.
openshift-on-openstack
Validations that check that the environment meets the requirements to be able to deploy OpenShift on OpenStack.
pre-introspection
Validations to run before the nodes introspection using Ironic Inspector.
pre-deployment
Validations to run before the openstack overcloud deploy command.
post-deployment
Validations to run after the overcloud deployment has finished.
pre-upgrade
Validations to validate your OpenStack deployment before an upgrade.
post-upgrade
Validations to validate your OpenStack deployment after an upgrade.

14.2. Listing validations

Run the openstack tripleo validator list command to list the different types of validations available.

Procedure

  1. Source the stackrc file.

    $ source ~/stackrc
  2. Run the openstack tripleo validator list command:

    • To list all validations, run the command without any options:

      $ openstack tripleo validator list
    • To list validations in a group, run the command with the --group option:

      $ openstack tripleo validator list --group prep
Note

For a full list of options, run openstack tripleo validator list --help.

14.3. Running validations

To run a validation or validation group, use the openstack tripleo validator run command. To see a full list of options, use the openstack tripleo validator run --help command.

Procedure

  1. Source the stackrc file:

    $ source ~/stackrc
  2. Enter the openstack tripleo validator run command:

    • To run a single validation, enter the command with the --validation option and the name of the validation. For example, to check the undercloud memory requirements, enter --validation undercloud-ram:

      $ openstack tripleo validator run --validation undercloud-ram
    • To run all validations in a group, enter the command with the --group option:

      $ openstack tripleo validator run --group prep

14.4. In-flight validations

Red Hat OpenStack Platform includes in-flight validations in the templates of composable services. In-flight validations verify the operational status of services at key steps of the overcloud deployment process.

In-flight validations run automatically as part of the deployment process. Some in-flight validations also use the roles from the openstack-tripleo-validations package.