summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-08-18 20:42:26 +0000
committerGerrit Code Review <review@openstack.org>2016-08-18 20:42:26 +0000
commit324fa6d22ecbb89f62af7c04284f9770b69677d1 (patch)
tree603ca3a532692e1904282cbb5b927bcf262d9eb2 /doc/source
parent5b0469e1e1a92df5085e2a92ad01014f62c5ee28 (diff)
parenteb97ff32c4c8c3ee5f40c65b622f6f448128043b (diff)
downloadpython-ironicclient-324fa6d22ecbb89f62af7c04284f9770b69677d1.tar.gz
Merge "Fail with more meaningful error while creating client"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/api_v1.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/source/api_v1.rst b/doc/source/api_v1.rst
index d2e2c68..3af1d4f 100644
--- a/doc/source/api_v1.rst
+++ b/doc/source/api_v1.rst
@@ -22,13 +22,18 @@ credentials to `ironicclient.client.get_client()`_. By default, the
Bare Metal Provisioning system is configured so that only administrators
(users with 'admin' role) have access.
+.. note::
+ Explicit instantiation of `ironicclient.v1.client.Client`_ may cause
+ errors since it doesn't verify provided arguments, using
+ `ironicclient.client.get_client()` is prefered way to get client object.
+
There are two different sets of credentials that can be used::
* ironic endpoint and auth token
* Identity Service (keystone) credentials
Using ironic endpoint and auth token
-.....................................
+....................................
An auth token and the ironic endpoint can be used to authenticate::