summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjohn-griffith <john.griffith8@gmail.com>2017-04-15 11:31:46 -0600
committerjohn-griffith <john.griffith8@gmail.com>2017-05-22 08:28:07 -0600
commitda4e8103ed829fbcce9caa13559aed30405a02f7 (patch)
tree96b56bc86e608e8a741e599841ac411eb53bd843 /doc
parent51f6668e482b35896018b26d24f8baf05441005f (diff)
downloadpython-cinderclient-da4e8103ed829fbcce9caa13559aed30405a02f7.tar.gz
Add doc for noauth usage
Sometimes docs are useful, let's add one for using noauth. Change-Id: I7d450031929ca5f6ea1b285e49f693776a63a23d
Diffstat (limited to 'doc')
-rw-r--r--doc/source/no_auth.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/source/no_auth.rst b/doc/source/no_auth.rst
new file mode 100644
index 0000000..9885df2
--- /dev/null
+++ b/doc/source/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