From 9c36efa39c163354b145ecda897aef50dcdb4d57 Mon Sep 17 00:00:00 2001 From: junboli Date: Sat, 24 Jun 2017 15:56:16 +0800 Subject: [PATCH] Update cinder.rst and shell.rst In the file doc/source/man/cinder.rst, add cinder command examples, In the file doc/source/shell.rst, update OS_AUTH_URL and OS_VOLUME_API_VERSION Change-Id: I6ed2c5228daad8dd6dcab1d7278f8a0b049c0490 --- doc/source/man/cinder.rst | 25 +++++++++++++++++++++++++ doc/source/shell.rst | 4 ++-- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/doc/source/man/cinder.rst b/doc/source/man/cinder.rst index 50fb644f0..4cd957159 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 +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 96b4f4fff..813b7693b 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::