Chapter 18. Using the validation framework

Procedure

1. Optional: Make a copy of the validation configuration file for editing:

   1. Copy /etc/validation.cfg to your home directory.
   2. Make the required edits to the new configuration file.

2. Run the validation command:

   $ validation run --config <configuration-file>

   • Replace <configuration-file> with the file path to the configuration file that you want to use.

     Note

     When you run a validation, the Reasons column in the output is limited to 79 characters. To view the validation result in full, view the validation log files.

Procedure

1. Source the stackrc file.

   $ source ~/stackrc

2. Run the validation list command:

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

     $ validation list

   • To list validations in a group, run the command with the --group option:

     $ validation list --group prep

Procedure

1. Source the stackrc file:

   $ source ~/stackrc

2. Validate a static inventory file called tripleo-ansible-inventory.yaml.

   $ validation run --group pre-introspection -i tripleo-ansible-inventory.yaml

   Note

   You can find the inventory file in the ~/tripleo-deploy/<stack> directory for a standalone or undercloud deployment or in the ~/overcloud-deploy/<stack> directory for an overcloud deployment.

3. Enter the validation 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 memory requirements of each node, enter --validation check-ram:

     $ validation run --validation check-ram

     To run multiple specific validations, use the --validation option with a comma-separated list of the validations that you want to run. For more information about viewing the list of available validations, see Listing validations.

   • To run all validations in a group, enter the command with the --group option:

     $ validation run --group prep

     To view detailed output from a specific validation, run the validation history get --full command against the UUID of the specific validation from the report:

     $ validation history get --full <UUID>

Procedure

1. Create your validation:

   $ validation init <my-new-validation>

   • Replace <my-new-validation> with the name of your new validation.

     The execution of this command results in the creation of the following directory and sub-directories:

     /home/stack/community-validations
     ├── library
     ├── lookup_plugins
     ├── playbooks
     └── roles

     Note

     If you see the error message "The Community Validations are disabled by default, ensure that the enable_community_validations parameter is set to True in the validation configuration file. The default name and location of this file is /etc/validation.cfg.

2. Edit the role to suit your requirements.

Procedure

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

2. Source the stackrc file:

   $ source ~/stackrc

3. You can view a list of all validations or the most recent validations:

   • View a list of all validations:

     $ validation history list

   • View history for a specific validation type by using the --validation option:

     $ validation history get --validation <validation-type>

     • Replace <validation-type> with the type of validation, for example, ntp.

4. View the log for a specific validation UUID:

   $ validation show run --full 7380fed4-2ea1-44a1-ab71-aab561b44395