openstack
/
python-novaclient
Code Issues Proposed changes

Added documentation for NOVA_VERSION

This commit is contained in:
Antony Messerli 2011-08-07 14:00:23 -05:00
parent f5a078c7eb
commit cc9d68cf09
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -43,16 +43,19 @@ set them as environment variables::
export NOVA_API_KEY=yadayada
export NOVA_PROJECT_ID=myproject
You will also need to define the authentication url with ``--url``. Or set it as
an environment variable as well::
You will also need to define the authentication url with ``--url`` and the
version of the API with ``--version``. Or set them as an environment
variables as well::
export NOVA_URL=http://myserver:port/v1.0/
export NOVA_VERSION=1.0
You'll find complete documentation on the shell by running
``nova help``::
usage: nova [--username USERNAME] [--apikey APIKEY]
[--projectid PROJECTID] [--url AUTH_URL] <subcommand> ...
usage: nova [--username USERNAME] [--apikey APIKEY] [--projectid PROJECTID]
[--url URL] [--version VERSION]
<subcommand> ...
Command-line interface to the OpenStack Nova API.
@ -107,7 +110,9 @@ You'll find complete documentation on the shell by running
--apikey PROJECTID Defaults to env[NOVA_PROJECT_ID].
--url AUTH_URL Defaults to env[NOVA_URL] or
https://auth.api.rackspacecloud.com/v1.0
if undefined.
if undefined.
--version VERSION Accepts 1.0 or 1.1, defaults to
env[NOVA_VERSION].
See "nova help COMMAND" for help on a specific command.

5
docs/shell.rst
View File

@ -31,12 +31,17 @@ environment variables by setting two environment variables:
The OpenStack API server URL.
.. envvar:: NOVA_VERSION
The OpenStack API version.
For example, in Bash you'd use::
export NOVA_USERNAME=yourname
export NOVA_API_KEY=yadayadayada
export NOVA_PROJECT_ID=myproject
export NOVA_URL=http://...
export NOVA_VERSION=1.0
From there, all shell commands take the form::