Command Line Interface

Note

A few things are common for all commands, so they are not repeated for every command below.

  • Every command and every category accepts --help, i.e. rally task --help and rally task start --help.

  • Values can be passed as --opt value or as --opt=value.

  • Flags take no value. Some of them have a negative form, i.e. --use and --no-use.

  • Shell completion is available. Run rally --install-completion once for your shell, or rally --show-completion to print the script and install it yourself.

General

These options are accepted by every command and have to be placed before the category name, i.e. rally --debug task start ... and not rally task start --debug ....

Global options:

  • --config-file (string, repeatable) [ref]

    Path to a config file. Repeatable; later files take precedence.

  • --config-dir (string, repeatable) [ref]

    Path to a config directory. Repeatable.

  • --plugin-paths (string, repeatable) [ref]

    Additional custom plugin locations.

    Environment variable: RALLY_PLUGIN_PATHS

  • --version (flag) [ref]

    Print the Rally version and exit.

  • --rally-debug (flag) [ref]

    Print debugging output only for Rally. Off-site components stay quiet.

  • --debug (flag) [ref]

    If set to true, the logging level will be set to DEBUG instead of the default INFO level.

  • --log-config-append (string) [ref]

    The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).

  • --log-date-format (string) [ref]

    Defines the format string for %(asctime)s in log records. Default: %Y-%m-%d %H:%M:%S . This option is ignored if log_config_append is set.

  • --log-file (string) [ref]

    (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

  • --log-dir (string) [ref]

    (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

  • --use-syslog (flag) [ref]

    Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

  • --use-journal (flag) [ref]

    Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

  • --syslog-log-facility (string) [ref]

    Syslog facility to receive log lines. This option is ignored if log_config_append is set.

  • --use-json (flag) [ref]

    Use JSON formatting for logging. This option is ignored if log_config_append is set.

  • --install-completion (flag) [ref]

    Install completion for the current shell.

  • --show-completion (flag) [ref]

    Show completion for the current shell, to copy it or customize the installation.

rally version

Print the Rally version.

Category: db

Create, upgrade and inspect the database.

rally db create

Create Rally database.

rally db ensure

Create Rally database if it doesn’t exist.

rally db recreate

Drop and create Rally database.

This will delete all existing data.

rally db revision

Print current Rally database revision UUID.

rally db show

Show the connection string.

Options:

  • --creds (flag) [ref]

    Do not hide credentials from connection string

rally db upgrade

Upgrade Rally database to the latest state.

Category: deployment

Warning

These commands are deprecated. Use the env commands instead, they are described at the Environment Component page.

Legacy environments (superseded by env).

rally deployment check

Check all credentials and list all available services.

Positional arguments:

  • DEPLOYMENT (string) [ref]

    Note

    The default value for the DEPLOYMENT argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the deployment.

    Environment variable: RALLY_ENV

rally deployment config

Display configuration of the deployment.

Output is the configuration of the deployment in a pretty-printed JSON format.

Positional arguments:

  • DEPLOYMENT (string) [ref]

    Note

    The default value for the DEPLOYMENT argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the deployment.

    Environment variable: RALLY_ENV

rally deployment create

Create new deployment.

This command will create a new deployment record in rally database. In the case of ExistingCloud deployment engine, it will use the cloud represented in the configuration. If the cloud doesn’t exist, Rally can deploy a new one for you with Devstack or Fuel. Different deployment engines exist for these cases (see rally plugin list –plugin-base Engine for more details).

If you use the ExistingCloud deployment engine, you can pass the deployment config by environment variables with --fromenv:

OS_USERNAME OS_PASSWORD OS_AUTH_URL OS_TENANT_NAME or OS_PROJECT_NAME OS_ENDPOINT_TYPE or OS_INTERFACE OS_ENDPOINT OS_REGION_NAME OS_CACERT OS_INSECURE OS_IDENTITY_API_VERSION

All other deployment engines need more complex configuration data, so it should be stored in a configuration file.

You can use physical servers, LXC containers, KVM virtual machines or virtual machines in OpenStack for deploying the cloud. Except physical servers, Rally can create cluster nodes for you. Interaction with virtualization software, OpenStack cloud or physical servers is provided by server providers.

Options:

  • --name (string, required) [ref]

    Name of the deployment.

  • --fromenv (flag) [ref]

    Read environment variables instead of config file.

  • --filename (string) [ref]

    Path to the configuration file of the deployment.

  • --no-use (flag) [ref]

    Don’t set new deployment as default for future operations.

rally deployment destroy

Destroy existing deployment.

This will delete all containers, virtual machines, OpenStack instances or Fuel clusters created during Rally deployment creation. Also it will remove the deployment record from the Rally database.

Positional arguments:

  • DEPLOYMENT (string) [ref]

    Note

    The default value for the DEPLOYMENT argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the deployment.

    Environment variable: RALLY_ENV

rally deployment list

List existing deployments.

rally deployment recreate

Destroy and create an existing deployment.

Unlike ‘deployment destroy’, the deployment database record will not be deleted, so the deployment UUID stays the same.

Positional arguments:

  • DEPLOYMENT (string) [ref]

    Note

    The default value for the DEPLOYMENT argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the deployment.

    Environment variable: RALLY_ENV

Options:

  • --filename (string) [ref]

    Path to the configuration file of the deployment.

rally deployment show

Show the credentials of the deployment.

Positional arguments:

  • DEPLOYMENT (string) [ref]

    Note

    The default value for the DEPLOYMENT argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the deployment.

    Environment variable: RALLY_ENV

rally deployment use

Set active deployment.

Positional arguments:

  • DEPLOYMENT (string, required) [ref]

    UUID or name of a deployment.

Category: env

Environments Rally tests against.

rally env check

Check availability of all platforms in environment.

Positional arguments:

  • ENV (string) [ref]

    Note

    The default value for the ENV argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the env.

    Environment variable: RALLY_ENV

Options:

  • --json (flag) [ref]

    Format output as JSON.

  • --detailed (flag) [ref]

    Show detailed information.

rally env cleanup

Perform disaster cleanup for specified environment.

Cases when Rally can leave undeleted resources after performing workload:

  • Rally execution was interrupted and cleanup was not performed

  • The environment or a particular platform became unreachable which fail Rally execution of cleanup

Positional arguments:

  • ENV (string) [ref]

    Note

    The default value for the ENV argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the env.

    Environment variable: RALLY_ENV

Options:

  • --json (flag) [ref]

    Format output as JSON.

rally env create

Create new environment.

Options:

  • --name, -n (string, required) [ref]

    Name of the env.

  • --description, -d (string) [ref]

    Env description

  • --extras, -e (string) [ref]

    JSON or YAML dict with custom non validate info.

  • --spec, -s (string) [ref]

    Path to env spec.

  • --from-sysenv (flag) [ref]

    Iterate over all available platforms and check system environment for credentials.

  • --json (flag) [ref]

    Format output as JSON.

  • --no-use (flag) [ref]

    Don’t set new env as default for future operations.

rally env delete

Delete all records related to the environment from db.

Positional arguments:

  • ENV (string) [ref]

    Note

    The default value for the ENV argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the env.

    Environment variable: RALLY_ENV

Options:

  • --force (flag) [ref]

    Delete DB records even if env is not destroyed.

rally env destroy

Destroy existing environment.

Positional arguments:

  • ENV (string) [ref]

    Note

    The default value for the ENV argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the env.

    Environment variable: RALLY_ENV

Options:

  • --skip-cleanup (flag) [ref]

    Do not perform platforms cleanup before destroy.

  • --json (flag) [ref]

    Format output as JSON.

  • --detailed (flag) [ref]

    Show detailed information.

rally env info

Retrieve and show environment information.

Positional arguments:

  • ENV (string) [ref]

    Note

    The default value for the ENV argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the env.

    Environment variable: RALLY_ENV

Options:

  • --json (flag) [ref]

    Format output as JSON.

rally env list

List existing environments.

Options:

  • --json (flag) [ref]

    Format output as JSON.

rally env show

Show base information about the environment record.

Positional arguments:

  • ENV (string) [ref]

    Note

    The default value for the ENV argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the env.

    Environment variable: RALLY_ENV

Options:

  • --json (flag) [ref]

    Format output as JSON.

  • --only-spec (flag) [ref]

    Print only a spec for the environment.

rally env use

Set default environment.

Positional arguments:

  • ENV (string, required) [ref]

    UUID or name of the env.

Options:

  • --json (flag) [ref]

    Format output as JSON.

Category: plugin

Discover and inspect installed plugins.

rally plugin list

List all Rally plugins that match name and platform.

Positional arguments:

  • NAME (string) [ref]

    List only plugins that match the given name.

Options:

  • --platform (string) [ref]

    List only plugins that are in the specified platform.

  • --plugin-base (string) [ref]

    Plugin base class.

rally plugin show

Show detailed information about a Rally plugin.

Positional arguments:

  • NAME (string, required) [ref]

    Plugin name.

Options:

  • --platform (string) [ref]

    Plugin platform.

Category: task

Run scenario tests and benchmarks.

rally task abort

Abort a running task.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task.

    Environment variable: RALLY_TASK

Options:

  • --soft (flag) [ref]

    Abort task after current scenario finishes execution.

rally task delete

Delete task and its results.

Positional arguments:

  • UUID (string, repeatable) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task or a list of task UUIDs.

    Environment variable: RALLY_TASK

Options:

  • --force (flag) [ref]

    Force delete

rally task detailed

Print detailed information about given task.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task. If “last”, the results of the most recently created task will be displayed.

    Environment variable: RALLY_TASK

Options:

  • --iterations-data (flag) [ref]

    Print detailed results for each iteration.

  • --filter-by (string, repeatable) [ref]

    Filter the displayed workloads. <sla-failures>: only display the failed workloads. <scenarios>: filter the workloads by scenarios, scenarios=scenario_name1[,scenario_name2]…

rally task export

Export task results to the custom task’s exporting system.

Positional arguments:

  • UUID (string, repeatable) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUIDs of tasks or json reports of tasks

    Environment variable: RALLY_TASK

Options:

  • --type (string, required) [ref]

    Report type. Out-of-the-box types: JSON, HTML, HTML-Static, Elastic, JUnit-XML. HINT: You can list all types, executing rally plugin list –plugin-base TaskExporter command.

  • --to (string) [ref]

    Report destination. Can be a path to a file (in case of JSON, HTML, HTML-Static, JUnit-XML, Elastic etc. types) to save the report to or a connection string. It depends on the report type.

  • --env (string) [ref]

    Report all tasks for the defined environment.

rally task import

Import JSON results of a test into the Rally database.

Options:

  • --file (string, required) [ref]

    JSON file with task results

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the environment.

    Environment variable: RALLY_ENV

  • --tag (string, repeatable) [ref]

    Mark the task with a tag or a few tags.

rally task list

List tasks, started and finished.

Displayed tasks can be filtered by status or environment. By default ‘rally task list’ will display tasks from the active environment without filtering by status.

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the environment.

    Environment variable: RALLY_ENV

  • --all-envs (flag) [ref]

    List tasks from all environments.

  • --all-deployments (flag) [ref]

  • --status [ref]

    List tasks with the specified status.

    Set of expected values: aborted, aborting, crashed, finished, init, paused, running, sla_failed, soft_aborting, validated, validating, validation_failed.

  • --tag (string, repeatable) [ref]

    Tags to filter tasks by.

  • --uuids-only (flag) [ref]

    List task UUIDs only.

rally task report

Generate a report for the specified task(s).

Positional arguments:

  • UUID (string, repeatable) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUIDs of tasks or json reports of tasks

    Environment variable: RALLY_TASK

Options:

  • --out (string) [ref]

    Report destination. Can be a path to a file (in case of HTML, HTML-STATIC, etc. types) to save the report to or a connection string.

  • --open (flag) [ref]

    Open the output in a browser.

  • --html (flag) [ref]

    Generate HTML report.

  • --html-static (flag) [ref]

    Generate static HTML report.

  • --json (flag) [ref]

    Generate JSON report.

  • --env (string) [ref]

    Report all tasks for the defined environment.

rally task restart

Restart a task or some scenarios in workloads of task.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task.

    Environment variable: RALLY_TASK

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the environment.

    Environment variable: RALLY_ENV

  • --scenario (string, repeatable) [ref]

    Scenario name of workload

  • --tag (string, repeatable) [ref]

    Mark the task with a tag or a few tags.

  • --no-use (flag) [ref]

    Don’t set new task as default for future operations.

  • --abort-on-sla-failure (flag) [ref]

    Abort the execution of a task when any SLA check for it fails for subtask or workload.

rally task results

DEPRECATED since Rally 3.0.0.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task.

    Environment variable: RALLY_TASK

rally task sla-check

Display SLA check results table.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task.

    Environment variable: RALLY_TASK

Options:

  • --json (flag) [ref]

    Output in JSON format.

rally task start

Run task.

If both task_args and task_args_file are specified, they are going to be merged. task_args has a higher priority so it overrides values from task_args_file. There are 3 kinds of return codes, 0: no error, 1: running error, 2: sla check failed.

Positional arguments:

  • TASK (string, required) [ref]

    Path to the input task file (or ‘-’ for stdin).

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the environment.

    Environment variable: RALLY_ENV

  • --task-args (string) [ref]

    Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.

  • --task-args-file (string) [ref]

    Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.

  • --tag (string, repeatable) [ref]

    Mark the task with a tag or a few tags.

  • --no-use (flag) [ref]

    Don’t set new task as default for future operations.

  • --abort-on-sla-failure (flag) [ref]

    Abort the execution of a task when any SLA check for it fails for subtask or workload.

rally task status

Display the current status of a task.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally task use <uuid> (ref).

    UUID of task

    Environment variable: RALLY_TASK

rally task use

Set active task.

Positional arguments:

  • UUID (string, required) [ref]

    UUID of the task

rally task validate

Validate a task configuration file.

This will check that task configuration file has valid syntax and all required options of scenarios, contexts, SLA and runners are set.

If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.

Positional arguments:

  • TASK (string, required) [ref]

    Path to the input task file (or ‘-’ for stdin).

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    UUID or name of the environment.

    Environment variable: RALLY_ENV

  • --task-args (string) [ref]

    Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.

  • --task-args-file (string) [ref]

    Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.

Category: verify

Run external verifier test suites.

rally verify add-verifier-ext

Add a verifier extension.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --source (string, required) [ref]

    Path or URL to the repo to clone verifier extension from.

  • --version (string) [ref]

    Branch, tag or commit ID to checkout before installation of the verifier extension (the ‘master’ branch is used by default).

  • --extra-settings (string) [ref]

    Extra installation settings for verifier extension.

rally verify configure-verifier

Configure a verifier for a specific deployment.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    Environment name or UUID. HINT: You can list all environments, executing command rally env list.

    Environment variable: RALLY_ENV

  • --reconfigure (flag) [ref]

    Reconfigure verifier.

  • --extend (string) [ref]

    Extend verifier configuration with extra options. If options are already present, the given ones will override them. Can be a path to a regular config file or just a json/yaml.

  • --override (string) [ref]

    Override verifier configuration by another one from a given source.

  • --show (flag) [ref]

    Show verifier configuration.

rally verify create-verifier

Create a verifier.

Options:

  • --name (string, required) [ref]

    Verifier name (for example, ‘My verifier’).

  • --type (string, required) [ref]

    Verifier plugin name. HINT: You can list all verifier plugins, executing command rally verify list-plugins.

  • --platform (string) [ref]

    Verifier plugin platform. Should be specified in case of two verifier plugins with equal names but in different platforms.

    Defaults to "".

  • --source (string) [ref]

    Path or URL to the repo to clone verifier from.

  • --version (string) [ref]

    Branch, tag or commit ID to checkout before verifier installation (the ‘master’ branch is used by default).

  • --system-wide (flag) [ref]

    Use the system-wide environment for verifier instead of a virtual environment.

  • --extra-settings (string) [ref]

    Extra installation settings for verifier.

  • --no-use (flag) [ref]

    Not to set the created verifier as the default verifier for future operations.

rally verify delete

Delete a verification or a few verifications.

Positional arguments:

  • UUID (string, repeatable, required) [ref]

    UUIDs of verifications. HINT: You can list all verifications, executing command rally verify list.

rally verify delete-verifier

Delete a verifier.

Positional arguments:

  • ID (string, required) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

Options:

  • --env (string) [ref]

    Environment name or UUID. If specified, only the environment-specific data will be deleted for verifier. HINT: You can list all environments, executing command rally env list.

  • --force (flag) [ref]

    Delete all stored verifications of the specified verifier. If a deployment specified, only verifications of this deployment will be deleted. Use this argument carefully! You can delete verifications that may be important to you.

rally verify delete-verifier-ext

Delete a verifier extension.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --name (string, required) [ref]

    Verifier extension name.

rally verify import

Import results of a test run into the Rally database.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    Environment name or UUID. HINT: You can list all environments, executing command rally env list.

    Environment variable: RALLY_ENV

  • --file (string, required) [ref]

    File to import test results from.

  • --run-args (string) [ref]

    Arguments that might be used when running tests. For example, ‘{concurrency: 2, pattern: set=identity}’.

  • --no-use (flag) [ref]

    Not to set the created verification as the default verification for future operations.

rally verify list

List all verifications.

Options:

  • --id (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

  • --env (string) [ref]

    Environment name or UUID. HINT: You can list all environments, executing command rally env list.

  • --tag (string, repeatable) [ref]

    Tags to filter verifications by.

  • --status [ref]

    Status to filter verifications by.

    Set of expected values: crashed, failed, finished, init, running.

rally verify list-plugins

List all plugins for verifiers management.

Options:

  • --platform (string) [ref]

    Required platform (e.g. openstack).

rally verify list-verifier-exts

List all verifier extensions.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

rally verify list-verifier-tests

List all verifier tests.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --pattern (string) [ref]

    Pattern which will be used for matching. Can be a regexp or a verifier-specific entity (for example, in case of Tempest you can specify ‘set=smoke’).

    Defaults to "".

rally verify list-verifiers

List all verifiers.

Options:

  • --status [ref]

    Status to filter verifiers by.

    Set of expected values: extending, failed, init, installed, installing, updating.

rally verify report

Generate a report for a verification or a few verifications.

Positional arguments:

  • UUID (string, repeatable) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally verify use <uuid> (ref).

    UUIDs of verifications. HINT: You can list all verifications, executing command rally verify list.

    Environment variable: RALLY_VERIFICATION

Options:

  • --type (string) [ref]

    Report type (Defaults to JSON). Out-of-the-box types: HTML, HTML-Static, JSON, JUnit-XML. HINT: You can list all types, executing rally plugin list –plugin-base VerificationReporter command.

    Defaults to json.

  • --to (string) [ref]

    Report destination. Can be a path to a file (in case of HTML, JSON, etc. types) to save the report to or a connection string. It depends on the report type.

  • --open (flag) [ref]

    Open the output file in a browser.

rally verify rerun

Rerun tests from a verification for a specific deployment.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally verify use <uuid> (ref).

    Verification UUID. HINT: You can list all verifications, executing command rally verify list.

    Environment variable: RALLY_VERIFICATION

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    Environment name or UUID. HINT: You can list all environments, executing command rally env list.

    Environment variable: RALLY_ENV

  • --failed (flag) [ref]

    Rerun only failed tests.

  • --tag (string, repeatable) [ref]

    Mark verification with a tag or a few tags.

  • --concurrency (integer) [ref]

    How many processes to be used for running verifier tests. The default value (0) auto-detects your CPU count.

  • --detailed (flag) [ref]

    Show verification details such as errors of failed tests.

  • --no-use (flag) [ref]

    Not to set the finished verification as the default verification for future operations.

rally verify show

Show detailed information about a verification.

Positional arguments:

  • UUID (string) [ref]

    Note

    The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally verify use <uuid> (ref).

    Verification UUID. HINT: You can list all verifications, executing command rally verify list.

    Environment variable: RALLY_VERIFICATION

Options:

  • --sort-by [ref]

    Sort tests.

    Set of expected values: name, duration, status.

    Defaults to name.

  • --detailed (flag) [ref]

    Show verification details such as run arguments and errors of failed tests.

rally verify show-verifier

Show detailed information about a verifier.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

rally verify start

Start a verification (run verifier tests).

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --env (string) [ref]

    Note

    The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally env create, if the --no-use argument was not used.

    Hint

    You can set the default value by executing rally env use <uuid> (ref).

    Environment name or UUID. HINT: You can list all environments, executing command rally env list.

    Environment variable: RALLY_ENV

  • --tag (string, repeatable) [ref]

    Mark verification with a tag or a few tags.

  • --pattern (string) [ref]

    Pattern which will be used for running tests. Can be a regexp or a verifier-specific entity (for example, in case of Tempest you can specify ‘set=smoke’).

  • --concurrency (integer) [ref]

    How many processes to be used for running verifier tests. The default value (0) auto-detects your CPU count.

    Defaults to 0.

  • --load-list (string) [ref]

    Path to a file with a list of tests to run.

  • --skip-list (string) [ref]

    Path to a file with a list of tests to skip. Format: json or yaml like a dictionary where keys are regexes matching test names and values are reasons.

  • --xfail-list (string) [ref]

    Path to a file with a list of tests that will be considered as expected failures. Format: json or yaml like a dictionary where keys are test names and values are reasons.

  • --detailed (flag) [ref]

    Show verification details such as errors of failed tests.

  • --no-use (flag) [ref]

    Not to set the finished verification as the default verification for future operations.

rally verify update-verifier

Update a verifier.

Positional arguments:

  • ID (string) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

    Environment variable: RALLY_VERIFIER

Options:

  • --update-venv (flag) [ref]

    Update the virtual environment for verifier.

  • --version (string) [ref]

    Branch, tag or commit ID to checkout. HINT: Specify the same version to pull the latest repo code.

  • --system-wide (flag) [ref]

    Switch to using the system-wide environment.

  • --no-system-wide (flag) [ref]

    Switch to using the virtual environment. If the virtual environment doesn’t exist, it will be created.

rally verify use

Choose a verification to use for the future operations.

Positional arguments:

  • UUID (string, required) [ref]

    Verification UUID. HINT: You can list all verifications, executing command rally verify list.

rally verify use-verifier

Choose a verifier to use for the future operations.

Positional arguments:

  • ID (string, required) [ref]

    Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.