3 files changed, 139 insertions, 0 deletions
diff --git a/doc/source/user/cinder.rst b/doc/source/user/cinder.rst
new file mode 100644
index 0000000..50fb644
--- /dev/null
+++ b/doc/source/user/cinder.rst
@@ -0,0 +1,58 @@
+==============================
+:program:`cinder` CLI man page
+==============================
+
+.. program:: cinder
+.. highlight:: bash
+
+
+SYNOPSIS
+========
+
+:program:`cinder` [options] <command> [command-options]
+
+:program:`cinder help`
+
+:program:`cinder help` <command>
+
+
+DESCRIPTION
+===========
+
+The :program:`cinder` command line utility interacts with OpenStack Block
+Storage Service (Cinder).
+
+In order to use the CLI, you must provide your OpenStack username, password,
+project (historically called tenant), and auth endpoint. You can use
+configuration options :option:`--os-username`, :option:`--os-password`,
+:option:`--os-tenant-name` or :option:`--os-tenant-id`, and
+:option:`--os-auth-url` or set corresponding environment variables::
+
+    export OS_USERNAME=user
+    export OS_PASSWORD=pass
+    export OS_TENANT_NAME=myproject
+    export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+
+You can select an API version to use by :option:`--os-volume-api-version`
+option or by setting corresponding environment variable::
+
+    export OS_VOLUME_API_VERSION=2
+
+
+OPTIONS
+=======
+
+To get a list of available commands and options run::
+
+    cinder help
+
+To get usage and options of a command::
+
+    cinder help <command>
+
+
+BUGS
+====
+
+Cinder client is hosted in Launchpad so you can view current bugs at
+https://bugs.launchpad.net/python-cinderclient/.
diff --git a/doc/source/user/no_auth.rst b/doc/source/user/no_auth.rst
new file mode 100644
index 0000000..9885df2
--- /dev/null
+++ b/doc/source/user/no_auth.rst
@@ -0,0 +1,32 @@
+=========================
+CINDERCLIENT Using noauth
+=========================
+
+Cinder Server side API setup
+============================
+The changes in the cinder.conf on your cinder-api node
+are minimal, just set authstrategy to noauth::
+
+    [DEFAULT]
+    auth_strategy = noauth
+    ...
+
+Using cinderclient
+------------------
+To use the cinderclient you'll need to set the following env variables::
+
+    OS_AUTH_TYPE=noauth
+    CINDERCLIENT_BYPASS_URL=http://<cinder-api-url>:8776/v3
+    OS_PROJECT_ID=foo
+    OS_VOLUME_API_VERSION=3.10
+
+Note that you can have multiple projects, however we don't currently do
+any sort of authentication of ownership because, well that's the whole
+point, it's noauth.
+
+Each of these options can also be specified on the cmd line::
+
+    cinder --os-auth-type=noauth \
+    --bypass-url=http://<cinder-api-url>:8776/v3 \
+    --os-project-id=admin \
+    --os-volume-api-version=3.10 list
diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst
new file mode 100644
index 0000000..813b769
--- /dev/null
+++ b/doc/source/user/shell.rst
@@ -0,0 +1,49 @@
+The :program:`cinder` shell utility
+=========================================
+
+.. program:: cinder
+.. highlight:: bash
+
+The :program:`cinder` shell utility interacts with the OpenStack Cinder API
+from the command line. It supports the entirety of the OpenStack Cinder API.
+
+You'll need to provide :program:`cinder` with your OpenStack username and
+API key. You can do this with the :option:`--os-username`, :option:`--os-password`
+and :option:`--os-tenant-name` options, but it's easier to just set them as
+environment variables by setting two environment variables:
+
+.. envvar:: OS_USERNAME or CINDER_USERNAME
+
+    Your OpenStack Cinder username.
+
+.. envvar:: OS_PASSWORD or CINDER_PASSWORD
+
+    Your password.
+
+.. envvar:: OS_TENANT_NAME or CINDER_PROJECT_ID
+
+    Project for work.
+
+.. envvar:: OS_AUTH_URL or CINDER_URL
+
+    The OpenStack API server URL.
+
+.. envvar:: OS_VOLUME_API_VERSION
+
+    The OpenStack Block Storage API version.
+
+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://auth.example.com:5000/v2.0
+    export OS_VOLUME_API_VERSION=3
+
+From there, all shell commands take the form::
+
+    cinder <command> [arguments...]
+
+Run :program:`cinder help` to get a full list of all possible commands,
+and run :program:`cinder help <command>` to get detailed help for that
+command.