The OpenStack Benchmark service 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.
The rally client is the command-line interface (CLI) for the Benchmark service API and its extensions. This chapter documents rally version 0.7.0.
For help on a specific rally command, enter:
$ rally help COMMAND
usage: rally [-h] [--config-dir DIR] [--config-file PATH] [--debug]
[--log-config-append PATH] [--log-date-format DATE_FORMAT]
[--log-dir LOG_DIR] [--log-file PATH] [--nodebug]
[--norally-debug] [--nouse-syslog] [--noverbose]
[--nowatch-log-file] [--plugin-paths PLUGIN_PATHS]
[--rally-debug] [--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-syslog] [--verbose] [--version] [--watch-log-file]
{version,bash-completion,show,task,plugin,verify,deployment} ...17.2. rally Optional Arguments
- -h, --help
show this help message and exit
- --config-dir DIR
Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a
predictable parse order if individual options are
over-ridden. The set is parsed after the file(s)
specified via previous --config-file, arguments hence
over-ridden options in the directory take precedence.
- --config-file PATH
Path to a config file to use. Multiple config files
can be specified, with values in later files taking
precedence. Defaults to None.
- --debug, -d
If set to true, the logging level will be set to DEBUG
instead of the default INFO level.
- --log-config-append PATH, --log_config PATH
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, logging_context_format_string).
- --log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log
records. Default: None . This option is ignored if
log_config_append is set.
- --log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative
log_file paths. This option is ignored if
log_config_append is set.
- --log-file PATH, --logfile PATH
(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.
- --nodebug
- --norally-debug
The inverse of --rally-debug
- --nouse-syslog
The inverse of --use-syslog
- --noverbose
- --nowatch-log-file
The inverse of --watch-log-file
- --plugin-paths PLUGIN_PATHS
Additional custom plugin locations. Multiple files or
directories may be specified. All plugins in the
specified directories and subdirectories will be
imported. Plugins in /opt/rally/plugins and
~/.rally/plugins will always be imported.
- --rally-debug
Print debugging output only for Rally. Off-site
components stay quiet.
- --syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is
ignored if log_config_append is set.
- --use-syslog
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.
- --verbose, -v
If set to false, the logging level will be set to
WARNING instead of the default INFO level.
- --version
show program's version number and exit
- --watch-log-file
Uses logging handler designed to watch file system.
When log file is moved or removed this handler will
open a new log file with specified path
instantaneously. It makes sense only if log_file
option is specified and Linux platform is used. This
option is ignored if log_config_append is set.
