summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-07-26 22:18:37 +0000
committerGerrit Code Review <review@openstack.org>2017-07-26 22:18:37 +0000
commitb4abd9cdef341a68102deee602dd6f6624227c2a (patch)
treef5a171ce41c663f36129a8be5bb503be0fc2bb99
parent63ac82a55489d55246da939b5ae60b8a65fb9ec7 (diff)
parent9c36efa39c163354b145ecda897aef50dcdb4d57 (diff)
downloadpython-cinderclient-b4abd9cdef341a68102deee602dd6f6624227c2a.tar.gz
Merge "Update cinder.rst and shell.rst"
-rw-r--r--doc/source/man/cinder.rst25
-rw-r--r--doc/source/shell.rst4
2 files changed, 27 insertions, 2 deletions
diff --git a/doc/source/man/cinder.rst b/doc/source/man/cinder.rst
index 50fb644..4cd9571 100644
--- a/doc/source/man/cinder.rst
+++ b/doc/source/man/cinder.rst
@@ -51,6 +51,31 @@ To get usage and options of a command::
cinder help <command>
+EXAMPLES
+========
+
+Get information about volume create command::
+
+ cinder help create
+
+List all the volumes::
+
+ cinder list
+
+Create new volume::
+
+ cinder create 1 --name volume01
+
+Describe a specific volume::
+
+ cinder show 65d23a41-b13f-4345-ab65-918a4b8a6fe6
+
+Create a snapshot::
+
+ cinder snapshot-create 65d23a41-b13f-4345-ab65-918a4b8a6fe6 \
+ --name qt-snap
+
+
BUGS
====
diff --git a/doc/source/shell.rst b/doc/source/shell.rst
index 96b4f4f..813b769 100644
--- a/doc/source/shell.rst
+++ b/doc/source/shell.rst
@@ -37,8 +37,8 @@ For example, in Bash you'd use::
export OS_USERNAME=yourname
export OS_PASSWORD=yadayadayada
export OS_TENANT_NAME=myproject
- export OS_AUTH_URL=http://...
- export OS_VOLUME_API_VERSION=1
+ export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+ export OS_VOLUME_API_VERSION=3
From there, all shell commands take the form::