- Fix option-describe typos
- Correct option and envvar markup, for commands that are using the
reference form instead of the definition form or are marking up
option arguments as options
- Avoid duplicate commands
- Fix some invalid docstrings
- Fix some invalid indentation
- Disable the murano plugin, which has invalid docs
- Correct issues with- and track the network-topology spec
- Include API modules in docs
Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
Additional API version options will be available depending on the installed
API libraries.
..option:: --os-interface <interface>
:option:`--os-interface` <interface>
Interface type. Valid options are `public`, `admin` and `internal`.
:option:`--os-profile` <hmac-key>
..option:: --os-profile <hmac-key>
Performance profiling HMAC key for encrypting context data
This key should be the value of one of the HMAC keys defined in the
configuration files of OpenStack services to be traced.
:option:`--os-beta-command`
..option:: --os-beta-command
Enable beta commands which are subject to change
:option:`--log-file` <LOGFILE>
..option:: --log-file <LOGFILE>
Specify a file to log output. Disabled by default.
:option:`-v, --verbose`
..option:: -v, --verbose
Increase verbosity of output. Can be repeated.
:option:`-q, --quiet`
..option:: -q, --quiet
Suppress output except warnings and errors
:option:`--debug`
..option:: --debug
Show tracebacks on errors and set verbosity to debug
..option:: --help
Show help message and exit
COMMANDS
========
@ -160,14 +211,16 @@ To get a description of a specific command::
Note that the set of commands shown will vary depending on the API versions
that are in effect at that time. For example, to force the display of the
Identity v3 commands:
Identity v3 commands::
openstack --os-identity-api-version 3 --help
:option:`complete`
..option:: complete
Print the bash completion functions for the current command set.
:option:`help <command>`
..option:: help <command>
Print help for an individual command
Additional information on the OpenStackClient command structure and arguments
@ -328,64 +381,85 @@ ENVIRONMENT VARIABLES
The following environment variables can be set to alter the behaviour of :program:`openstack`. Most of them have corresponding command-line options that take precedence if set.
:envvar:`OS_CLOUD`
..envvar:: OS_CLOUD
The name of a cloud configuration in ``clouds.yaml``.
:envvar:`OS_AUTH_PLUGIN`
..envvar:: OS_AUTH_PLUGIN
The authentication plugin to use when connecting to the Identity service, its version must match the Identity API version
:envvar:`OS_AUTH_URL`
..envvar:: OS_AUTH_URL
Authentication URL
:envvar:`OS_URL`
..envvar:: OS_URL
Service URL (when using the service token)
:envvar:`OS_DOMAIN_NAME`
..envvar:: OS_DOMAIN_NAME
Domain-level authorization scope (name or ID)
:envvar:`OS_PROJECT_NAME`
..envvar:: OS_PROJECT_NAME
Project-level authentication scope (name or ID)
:envvar:`OS_PROJECT_DOMAIN_NAME`
..envvar:: OS_PROJECT_DOMAIN_NAME
Domain name or ID containing project
:envvar:`OS_USERNAME`
..envvar:: OS_USERNAME
Authentication username
:envvar:`OS_TOKEN`
..envvar:: OS_TOKEN
Authenticated or service token
:envvar:`OS_PASSWORD`
..envvar:: OS_PASSWORD
Authentication password
:envvar:`OS_USER_DOMAIN_NAME`
..envvar:: OS_USER_DOMAIN_NAME
Domain name or ID containing user
:envvar:`OS_TRUST_ID`
..envvar:: OS_TRUST_ID
ID of the trust to use as a trustee user
:envvar:`OS_DEFAULT_DOMAIN`
..envvar:: OS_DEFAULT_DOMAIN
Default domain ID (Default: 'default')
:envvar:`OS_REGION_NAME`
..envvar:: OS_REGION_NAME
Authentication region name
:envvar:`OS_CACERT`
..envvar:: OS_CACERT
CA certificate bundle file
:envvar:`OS_CERT`
..envvar:: OS_CERT
Client certificate bundle file
:envvar:`OS_KEY`
..envvar:: OS_KEY
Client certificate key file
:envvar:`OS_IDENTITY_API_VERSION`
..envvar:: OS_IDENTITY_API_VERSION
Identity API version (Default: 2.0)
:envvar:`OS_XXXX_API_VERSION`
Additional API version options will be available depending on the installed API libraries.
..envvar:: OS_XXXX_API_VERSION
Additional API version options will be available depending on the installed
API libraries.
..envvar:: OS_INTERFACE
:envvar:`OS_INTERFACE`
Interface type. Valid options are `public`, `admin` and `internal`.
Stephen Finucane
6 years ago