summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorj-griffith <john.griffith8@gmail.com>2018-03-22 10:50:51 -0600
committerj-griffith <john.griffith8@gmail.com>2018-03-22 10:50:51 -0600
commitd6c6011fc83ab9a3bbd65e8dd4557ebf25b363ae (patch)
tree211c9a342859d4521f86b38db43da42d6b0e6c45 /doc
parent6996474656d5927da1a382f35fe6a32cf03638fd (diff)
downloadpython-cinderclient-d6c6011fc83ab9a3bbd65e8dd4557ebf25b363ae.tar.gz
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
Diffstat (limited to 'doc')
-rw-r--r--doc/source/index.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8388162..abe5c0d 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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()