Command Line Interface

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.

Command arguments:

  • --creds [ref]

Do not hide credentials from connection string

rally db upgrade

Upgrade Rally database to the latest state.

Category: deployment

Legacy environments (superseded by env).

rally deployment check

Check all credentials and list all available services.

Command arguments:

  • DEPLOYMENT [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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the deployment.

type: text

rally deployment config

Display configuration of the deployment.

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

Command arguments:

  • DEPLOYMENT [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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the deployment.

type: text

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.

Command arguments:

Name of the deployment.

type: text

  • --fromenv [ref]

Read environment variables instead of config file.

  • --filename [ref]

Path to the configuration file of the deployment.

type: text

  • --no-use [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.

Command arguments:

  • DEPLOYMENT [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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the deployment.

type: text

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.

Command arguments:

  • DEPLOYMENT [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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the deployment.

type: text

  • --filename [ref]

Path to the configuration file of the deployment.

type: text

rally deployment show

Show the credentials of the deployment.

Command arguments:

  • DEPLOYMENT [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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the deployment.

type: text

rally deployment use

Set active deployment.

Command arguments:

  • DEPLOYMENT [ref]

UUID or name of a deployment.

type: text

Category: env

Environments Rally tests against.

rally env check

Check availability of all platforms in environment.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the env.

type: text

Format output as JSON.

  • --detailed [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

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the env.

type: text

Format output as JSON.

rally env create

Create new environment.

Command arguments:

  • --name, -n [ref]

Name of the env.

type: text

  • --description, -d [ref]

Env description

type: text

  • --extras, -e [ref]

JSON or YAML dict with custom non validate info.

type: text

  • --spec, -s [ref]

Path to env spec.

type: text

  • --from-sysenv [ref]

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

Format output as JSON.

  • --no-use [ref]

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

rally env delete

Delete all records related to the environment from db.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the env.

type: text

  • --force [ref]

Delete DB records even if env is not destroyed.

rally env destroy

Destroy existing environment.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the env.

type: text

  • --skip-cleanup [ref]

Do not perform platforms cleanup before destroy.

Format output as JSON.

  • --detailed [ref]

Show detailed information.

rally env info

Retrieve and show environment information.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the env.

type: text

Format output as JSON.

rally env list

List existing environments.

Command arguments:

Format output as JSON.

rally env show

Show base information about the environment record.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the env.

type: text

Format output as JSON.

  • --only-spec [ref]

Print only a spec for the environment.

rally env use

Set default environment.

Command arguments:

UUID or name of the env.

type: text

Format output as JSON.

Category: plugin

Discover and inspect installed plugins.

rally plugin list

List all Rally plugins that match name and platform.

Command arguments:

List only plugins that match the given name.

type: text

  • --platform [ref]

List only plugins that are in the specified platform.

type: text

  • --plugin-base [ref]

Plugin base class.

type: text

rally plugin show

Show detailed information about a Rally plugin.

Command arguments:

Plugin name.

type: text

  • --platform [ref]

Plugin platform.

type: text

Category: task

Run scenario tests and benchmarks.

rally task abort

Abort a running task.

Command arguments:

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.

type: text

Abort task after current scenario finishes execution.

rally task delete

Delete task and its results.

Command arguments:

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.

type: text

  • --force [ref]

Force delete

rally task detailed

Print detailed information about given task.

Command arguments:

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.

type: text

  • --iterations-data [ref]

Print detailed results for each iteration.

  • --filter-by [ref]

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

type: text

rally task export

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

Command arguments:

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

type: text

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.

type: text

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.

type: text

Report all tasks for the defined environment.

type: text

rally task import

Import JSON results of a test into the Rally database.

Command arguments:

JSON file with task results

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the environment.

type: text

Mark the task with a tag or a few tags.

type: text

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.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the environment.

type: text

  • --all-envs [ref]

List tasks from all environments.

  • --all-deployments [ref]

  • --status [ref]

List tasks with the specified status.

type: choice

Tags to filter tasks by.

type: text

  • --uuids-only [ref]

List task UUIDs only.

rally task report

Generate a report for the specified task(s).

Command arguments:

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

type: text

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.

type: text

Open the output in a browser.

Generate HTML report.

  • --html-static [ref]

Generate static HTML report.

Generate JSON report.

Report all tasks for the defined environment.

type: text

rally task restart

Restart a task or some scenarios in workloads of task.

Command arguments:

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the environment.

type: text

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.

type: text

  • --scenario [ref]

Scenario name of workload

type: text

Mark the task with a tag or a few tags.

type: text

  • --no-use [ref]

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

  • --abort-on-sla-failure [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.

Command arguments:

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.

type: text

rally task sla-check

Display SLA check results table.

Command arguments:

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.

type: text

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.

Command arguments:

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

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the environment.

type: text

  • --task-args [ref]

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

type: text

  • --task-args-file [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.

type: text

Mark the task with a tag or a few tags.

type: text

  • --no-use [ref]

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

  • --abort-on-sla-failure [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.

Command arguments:

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

type: text

rally task use

Set active task.

Command arguments:

UUID of the task

type: text

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.

Command arguments:

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

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

UUID or name of the environment.

type: text

  • --task-args [ref]

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

type: text

  • --task-args-file [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.

type: text

Category: verify

Run external verifier test suites.

rally verify add-verifier-ext

Add a verifier extension.

Command arguments:

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

type: text

  • --source [ref]

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

type: text

  • --extra-settings [ref]

Extra installation settings for verifier extension.

type: text

rally verify configure-verifier

Configure a verifier for a specific deployment.

Command arguments:

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

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

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

type: text

  • --reconfigure [ref]

Reconfigure verifier.

  • --extend [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.

type: text

  • --override [ref]

Override verifier configuration by another one from a given source.

type: text

Show verifier configuration.

rally verify create-verifier

Create a verifier.

Command arguments:

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

type: text

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

type: text

  • --platform [ref]

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

type: text

default:

  • --source [ref]

Path or URL to the repo to clone verifier from.

type: text

  • --system-wide [ref]

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

  • --extra-settings [ref]

Extra installation settings for verifier.

type: text

  • --no-use [ref]

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

rally verify delete

Delete a verification or a few verifications.

Command arguments:

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

type: text

rally verify delete-verifier

Delete a verifier.

Command arguments:

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

type: text

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.

type: text

  • --force [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.

Command arguments:

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

type: text

Verifier extension name.

type: text

rally verify import

Import results of a test run into the Rally database.

Command arguments:

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

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

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

type: text

File to import test results from.

type: text

  • --run-args [ref]

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

type: text

  • --no-use [ref]

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

rally verify list

List all verifications.

Command arguments:

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

type: text

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

type: text

Tags to filter verifications by.

type: text

  • --status [ref]

Status to filter verifications by.

type: choice

rally verify list-plugins

List all plugins for verifiers management.

Command arguments:

  • --platform [ref]

Required platform (e.g. openstack).

type: text

rally verify list-verifier-exts

List all verifier extensions.

Command arguments:

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

type: text

rally verify list-verifier-tests

List all verifier tests.

Command arguments:

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

type: text

  • --pattern [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’).

type: text

default:

rally verify list-verifiers

List all verifiers.

Command arguments:

  • --status [ref]

Status to filter verifiers by.

type: choice

rally verify report

Generate a report for a verification or a few verifications.

Command arguments:

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.

type: text

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.

type: text

default: json

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.

type: text

Open the output file in a browser.

rally verify rerun

Rerun tests from a verification for a specific deployment.

Command arguments:

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.

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

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

type: text

  • --failed [ref]

Rerun only failed tests.

Mark verification with a tag or a few tags.

type: text

  • --concurrency [ref]

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

type: integer

  • --detailed [ref]

Show verification details such as errors of failed tests.

  • --no-use [ref]

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

rally verify show

Show detailed information about a verification.

Command arguments:

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.

type: text

  • --sort-by [ref]

Sort tests.

type: choice

default: name

  • --detailed [ref]

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

rally verify show-verifier

Show detailed information about a verifier.

Command arguments:

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

type: text

rally verify start

Start a verification (run verifier tests).

Command arguments:

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

type: text

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 deployment create, if the --no-use argument was not used.

Hint

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

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

type: text

Mark verification with a tag or a few tags.

type: text

  • --pattern [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’).

type: text

  • --concurrency [ref]

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

type: integer

default: 0

  • --load-list [ref]

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

type: text

  • --skip-list [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.

type: text

  • --xfail-list [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.

type: text

  • --detailed [ref]

Show verification details such as errors of failed tests.

  • --no-use [ref]

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

rally verify update-verifier

Update a verifier.

Command arguments:

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

type: text

  • --update-venv [ref]

Update the virtual environment for verifier.

  • --system-wide [ref]

Switch to using the system-wide environment.

  • --no-system-wide [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.

Command arguments:

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

type: text

rally verify use-verifier

Choose a verifier to use for the future operations.

Command arguments:

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

type: text