openstack/python-cinderclient
Code Issues Proposed changes

Add doc for noauth usage

Browse Source 
Sometimes docs are useful, let's add one for using noauth.

Change-Id: I7d450031929ca5f6ea1b285e49f693776a63a23d
This commit is contained in:
john-griffith
2017-04-15 11:31:46 -06:00
parent 51f6668e48
commit da4e8103ed
1 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/source/no_auth.rst Normal file
View File

@@ -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