summaryrefslogtreecommitdiff
path: root/doc/source/man/openstack.rst
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2013-12-05 13:23:44 -0600
committerDean Troyer <dtroyer@gmail.com>2013-12-05 17:29:35 -0600
commit4f1ebe8069a9b8e78f05eb4b3a0ccb7069b7c1f3 (patch)
tree4254767d5014b678e0ec5570a8ca19bf2bd726b4 /doc/source/man/openstack.rst
parente06e1a2cce0dbe9f7fd7e64467af73e7456a2aa5 (diff)
downloadpython-openstackclient-4f1ebe8069a9b8e78f05eb4b3a0ccb7069b7c1f3.tar.gz
Update docs for plugins and release notes
* Fill out the existing command and man page * Add a plugins page. * Begin the release notes for 0.3.0 Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36
Diffstat (limited to 'doc/source/man/openstack.rst')
-rw-r--r--doc/source/man/openstack.rst69
1 files changed, 62 insertions, 7 deletions
diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst
index c797f285..3a780e24 100644
--- a/doc/source/man/openstack.rst
+++ b/doc/source/man/openstack.rst
@@ -1,7 +1,8 @@
-=========
+====================
:program:`openstack`
-=========
+====================
+OpenStack Command Line
SYNOPSIS
========
@@ -10,6 +11,7 @@ SYNOPSIS
:program:`openstack help` <command>
+:program:`openstack` --help
DESCRIPTION
@@ -21,9 +23,8 @@ a distinct and consistent command structure.
:program:`openstack` uses a similar authentication scheme as the OpenStack project CLIs, with
the credential information supplied either as environment variables or as options on the
-command line. The primary difference is a preference for using
-``OS_PROJECT_NAME``/``OS_PROJECT_ID`` over the old tenant-based names. The old names work
-for now though.
+command line. The primary difference is the use of 'project' in the name of the options
+``OS_PROJECT_NAME``/``OS_PROJECT_ID`` over the old tenant-based names.
::
@@ -57,7 +58,22 @@ OPTIONS
Authentication region name
:option:`--os-default-domain <auth-domain>`
- Default domain ID (defaults to 'default')
+ Default domain ID (Default: 'default')
+
+:options:`--os-use-keyring`
+ Use keyring to store password (default: False)
+
+:option:`--os-cacert <ca-bundle-file>`
+ CA certificate bundle file
+
+:option:`--verify|--insecure`
+ Verify or ignore server certificate (default: verify)
+
+:option:`--os-identity-api-version <identity-api-version>`
+ Identity API version (Default: 2.0)
+
+:option:`--os-XXXX-api-version <XXXX-api-version>`
+ Additional API version options will be presend depending on the installed API libraries.
NOTES
@@ -78,6 +94,35 @@ To get a description of a specific command::
openstack help <command>
+:option:`complete`
+ Print the bash completion functions for the current command set.
+
+:option:`help <command>`
+ Print help for an individual command
+
+
+EXAMPLES
+========
+
+Show the detailed information for server ``appweb01``::
+
+ openstack --os-tenant-name ExampleCo --os-username demo --os-password secrete --os-auth-url http://localhost:5000:/v2.0 server show appweb01
+
+The same command if the auth environment variables (:envvar:`OS_AUTH_URL`, :envvar:`OS_PROJECT_NAME`,
+:envvar:`OS_USERNAME`, :envvar:`OS_PASSWORD`) are set::
+
+ openstack server show appweb01
+
+Create a new image::
+
+ openstack image create \
+ --disk-format=qcow2 \
+ --container-format=bare \
+ --public \
+ --copy-from http://somewhere.net/foo.img \
+ foo
+
+
FILES
=====
@@ -95,6 +140,12 @@ The following environment variables can be set to alter the behaviour of :progra
:envvar:`OS_PASSWORD`
Set the password
+:envvar:`OS_PROJECT_NAME`
+ Set the project name
+
+:envvar:`OS_AUTH_URL`
+ Set the authentication URL
+
BUGS
====
@@ -124,4 +175,8 @@ http://www.apache.org/licenses/LICENSE-2.0
SEE ALSO
========
-The OpenStack project CLIs, the OpenStack API references. <links TBD>
+The `OpenStackClient page <https://wiki.openstack.org/wiki/OpenStackClient>`_
+in the `OpenStack Wiki <https://wiki.openstack.org/>`_ contains further
+documentation.
+
+The individual OpenStack project CLIs, the OpenStack API references.