openstack/openstacksdk
Code Issues Proposed changes

Add docs for common keystoneauth settings

Browse Source 
The `api_timeout` parameter appears undocumented.  Add docs for
it, as well as another sibling parameter, `collect_timing`.  This
is where these values are used:

8091075e3b/openstack/config/cloud_region.py (L709-L710)

Change-Id: I1fa4cf618f1f420e5614784a4922836de673b65e
This commit is contained in:
James E. Blair 2024-05-20 07:21:04 -07:00
parent 0d5d48f65f
commit 1f21b86414
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/user/config/configuration.rst
View File

@ -139,6 +139,21 @@ as a result of a chosen plugin need to go into the auth dict. For password
auth, this includes `auth_url`, `username` and `password` as well as anything auth, this includes `auth_url`, `username` and `password` as well as anything
related to domains, projects and trusts. related to domains, projects and trusts.
API Settings
------------
The following settings are passed to keystoneauth and are common to
all services.
``api_timeout``
A timeout for API requests. This should be a numerical value
indicating some amount (or fraction) of seconds or 0 for no
timeout. (optional, defaults to 0)
``collect_timing``
Whether or not to collect per-method timing information for each
API call. (optional, defaults to False)
Splitting Secrets Splitting Secrets
----------------- -----------------