tripleo-docs/doc/source/validations/cli.rst

2.3 KiB

CLI support for validations

The following section describes the options when running or listing the existing validations.

Note

Both running or listing validations are supported currently only by calling Mistral. It is expected to have support to call the Ansible playbooks directly.

Running validations

Validations can be executed by groups or individually. The current CLI implementation allows to run them using the following CLI options:

openstack tripleo validator run [options]

--plan: This option allows to execute the validations overriding the default plan name. The default value is set to overcloud. To override this options use for example:

openstack tripleo validator run --plan mycloud

--validation-name: This options allows to execute a set of specific validations. Specify them as <validation_id>[,<validation_id>,...] which means a comma separated list. The default value for this option is []. For example you can run this as:

openstack tripleo validator run --validation-name check-ftype,512e

`--group`: This option allows to run specific group validations, if more than one group is required, then separate the group names with commas. The default value for this option is ['pre-deployment']. Run this option for example like:

openstack tripleo validator run --group pre-upgrade,prep

Listing validations

Validations can be listed by groups and depending which validations will be listed, the output might be configured as a table, json or yaml. The user can list the validations using the following command:

openstack tripleo validator list [options]

--output: This option allows to change the default output for listing the validations. The options are json, yaml or table. Run this option for example like:

openstack tripleo validator list --output json

--group: This option allows to filter and list specific group validations, if more than one group is required to be listed, separate the group names with commas. By default all group validations will be listed.

openstack tripleo validator list --group pre-upgrade,prep