From 260f09d59808c55bd8f9e7d04ec6c3ebe17a3b79 Mon Sep 17 00:00:00 2001 From: OpenStack Release Bot Date: Fri, 4 Mar 2022 17:18:09 +0000 Subject: [PATCH 1/4] Update .gitreview for stable/yoga Change-Id: I7bfec3b73438fb558aebf749eb2ceb71a2c8a96d --- .gitreview | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitreview b/.gitreview index d1b01d8..30e3e63 100644 --- a/.gitreview +++ b/.gitreview @@ -2,3 +2,4 @@ host=review.opendev.org port=29418 project=openstack/oslo.limit.git +defaultbranch=stable/yoga -- GitLab From 174093de6fa2f59a9c85a269670e43e5f9eb6488 Mon Sep 17 00:00:00 2001 From: OpenStack Release Bot Date: Fri, 4 Mar 2022 17:18:10 +0000 Subject: [PATCH 2/4] Update TOX_CONSTRAINTS_FILE for stable/yoga Update the URL to the upper-constraints file to point to the redirect rule on releases.openstack.org so that anyone working on this branch will switch to the correct upper-constraints list automatically when the requirements repository branches. Until the requirements repository has as stable/yoga branch, tests will continue to use the upper-constraints list on master. Change-Id: Ie2d096d324ffceb9f63cc0e727516c35602b6698 --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 54c1f12..06f4ba0 100644 --- a/tox.ini +++ b/tox.ini @@ -6,7 +6,7 @@ ignore_basepython_conflict = true [testenv] basepython = python3 deps = - -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/yoga} -r{toxinidir}/test-requirements.txt -r{toxinidir}/requirements.txt commands = @@ -26,7 +26,7 @@ commands = {posargs} [testenv:docs] deps = - -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/yoga} -r{toxinidir}/doc/requirements.txt allowlist_externals = rm commands = -- GitLab From 594aff58952e35a8f0c578cd21c9754db32d2bd4 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Mon, 28 Feb 2022 01:23:14 +0900 Subject: [PATCH 3/4] oslo-config-generator: Fix ValueError This fixes how the opts data is formatted to fix auto-generation of config file using oslo-config-generator with oslo.limit entry point. Closes-Bug: #1962406 Change-Id: I176a7b2b8e2edb50659783a2139c3cc13e8f2f53 (cherry picked from commit ce5aa7dccad4b95db6758c988287a07574ddb918) --- oslo_limit/opts.py | 6 +++--- releasenotes/notes/bug-1962406-e239d60400c726c8.yaml | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 releasenotes/notes/bug-1962406-e239d60400c726c8.yaml diff --git a/oslo_limit/opts.py b/oslo_limit/opts.py index b944649..c23e627 100644 --- a/oslo_limit/opts.py +++ b/oslo_limit/opts.py @@ -44,9 +44,9 @@ def list_opts(): return [(_option_group, copy.deepcopy(_options) + loading.get_session_conf_options() + - loading.get_auth_plugin_conf_options('password'), - loading.get_auth_plugin_conf_options('v2password'), - loading.get_auth_plugin_conf_options('v3password'), + loading.get_auth_plugin_conf_options('password') + + loading.get_auth_plugin_conf_options('v2password') + + loading.get_auth_plugin_conf_options('v3password') + loading.get_adapter_conf_options(include_deprecated=False) )] diff --git a/releasenotes/notes/bug-1962406-e239d60400c726c8.yaml b/releasenotes/notes/bug-1962406-e239d60400c726c8.yaml new file mode 100644 index 0000000..548bbec --- /dev/null +++ b/releasenotes/notes/bug-1962406-e239d60400c726c8.yaml @@ -0,0 +1,7 @@ +--- +fixes: + - | + `bug 1962406` `_: + Fixed the wrong format of options data, which was causing failure with + ``oslo-config-generator`` command if the ``oslo.limit`` entry point is + included. -- GitLab From 63536c6da62a8365ecc2b13ec40e4f0a92bc49da Mon Sep 17 00:00:00 2001 From: melanie witt Date: Thu, 3 Mar 2022 00:28:56 +0000 Subject: [PATCH 4/4] Add documentation for config options This adds a doc page for oslo.limit config options by auto-generating them. Change-Id: I49070fdbf2172f87bafd4d2bd08af282c9ef29a4 (cherry picked from commit 9f7a66a27317c3e9d67f7c3ecc25f6ef7b592171) --- doc/source/conf.py | 3 ++- doc/source/reference/index.rst | 15 ++++++++++++--- doc/source/reference/opts.rst | 9 +++++++++ 3 files changed, 23 insertions(+), 4 deletions(-) create mode 100644 doc/source/reference/opts.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 56f2496..828b915 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'openstackdocstheme', - 'sphinxcontrib.apidoc' + 'sphinxcontrib.apidoc', + 'oslo_config.sphinxext', ] apidoc_module_dir = '../../oslo_limit' diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index e1b1cc9..2ed6fba 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -1,7 +1,16 @@ -======================== -oslo.limit API Reference -======================== +========= +Reference +========= .. toctree:: + :maxdepth: 2 + + opts + +API +=== + +.. toctree:: + :maxdepth: 1 api/modules diff --git a/doc/source/reference/opts.rst b/doc/source/reference/opts.rst new file mode 100644 index 0000000..80509b8 --- /dev/null +++ b/doc/source/reference/opts.rst @@ -0,0 +1,9 @@ +===================== +Configuration Options +===================== + +oslo.limit uses oslo.config to define and manage configuration +options to allow the deployer to control how an application uses the +underlying quota limits and enforcement. + +.. show-options:: oslo.limit -- GitLab