From 1f21b864147ed345e243a62c851bfbcb5c5fc72b Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Mon, 20 May 2024 07:21:04 -0700 Subject: [PATCH] Add docs for common keystoneauth settings 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: https://opendev.org/openstack/openstacksdk/src/commit/8091075e3b8a9bb160eaee8cd4b24fb3c6410642/openstack/config/cloud_region.py#L709-L710 Change-Id: I1fa4cf618f1f420e5614784a4922836de673b65e --- doc/source/user/config/configuration.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source/user/config/configuration.rst b/doc/source/user/config/configuration.rst index 72cfaa510..febee1486 100644 --- a/doc/source/user/config/configuration.rst +++ b/doc/source/user/config/configuration.rst @@ -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 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 -----------------