openstack
/
python-cinderclient
Code Issues Proposed changes

Update python usage docs 

The keystoneauth1 get_plugin_loader method requires that a
OS_USER_DOMAIN be specified.  Our docs don't include that
detail.

This change adds the extra needed field.  There's also some
problems currently with loading the client directly as it's
currently documented, which appears to be a bug in the client
code itself.

Change-Id: Idacbb47f9aae1e461379eec4a5e224b0157a8dc4
Partial-Bug: #1758104
This commit is contained in:
j-griffith 2018-03-22 10:50:51 -06:00
parent 6996474656
commit d6c6011fc8
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/index.rst
View File

@ -26,7 +26,8 @@ API::
>>> auth = loader.load_from_options(auth_url=AUTH_URL,
... username=USERNAME,
... password=PASSWORD,
... project_id=PROJECT_ID)
... project_id=PROJECT_ID,
... user_domain_name=USER_DOMAIN_NAME)
>>> sess = session.Session(auth=auth)
>>> cinder = client.Client(VERSION, session=sess)
>>> cinder.volumes.list()