diff options
| author | Anton Arefiev <aarefiev@mirantis.com> | 2016-07-20 13:26:57 +0300 |
|---|---|---|
| committer | Anton Arefiev <aarefiev@mirantis.com> | 2016-08-15 14:57:16 +0300 |
| commit | eb97ff32c4c8c3ee5f40c65b622f6f448128043b (patch) | |
| tree | 11c5ee106a6a8ad70dcda8963c5c44fe8557c5f0 /doc | |
| parent | d2debb7a3875d6979afc889bd375e275dd5414fd (diff) | |
| download | python-ironicclient-eb97ff32c4c8c3ee5f40c65b622f6f448128043b.tar.gz | |
Fail with more meaningful error while creating client
Parameter 'endpoint' in v1 client object is mandatory if
os_ironic_api_version isn't specified. It's used to fetch version
from cache[1] and as endpoint override in session client[2]. But
since it passed via *args, it could be missing, and creation fails
with IndexError.
[1] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/v1/client.py#L42
[2] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/common/http.py#L595
Change-Id: I0310f748a1254dd7e54d93f913cff53aadaff16b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/api_v1.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/source/api_v1.rst b/doc/source/api_v1.rst index 631f911..ffe4810 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:: |