diff --git a/.gitreview b/.gitreview index d1b01d8f46f489d996de81e32930199e79838d69..30e3e63feec76534d1fb13c415fadf38a1f83c7f 100644 --- a/.gitreview +++ b/.gitreview @@ -2,3 +2,4 @@ host=review.opendev.org port=29418 project=openstack/oslo.limit.git +defaultbranch=stable/yoga diff --git a/doc/source/conf.py b/doc/source/conf.py index 56f24962bf79c9b8d57aff11796dd884022634e8..828b915f2793ec80a3fbbc00ff27672c81f7efef 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 e1b1cc94d55aacd8e9d44c4576e1742570688411..2ed6fba323efe5861633ed925c106eaaf25f5030 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 0000000000000000000000000000000000000000..80509b84fb9026b4c158f16ee5cd628bbb019cf7 --- /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 diff --git a/oslo_limit/opts.py b/oslo_limit/opts.py index b944649a3503e8776971b2af49da5849a7b66c66..c23e627af410c443d07113a8abc89a3105d2ed58 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 0000000000000000000000000000000000000000..548bbec9be927b577c229c73cc6b149573cce4be --- /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. diff --git a/tox.ini b/tox.ini index 54c1f1260e5b09a9e7517a2caf4be691ffafdcaf..06f4ba03003ec615b58a5e6e50a591bcae0c2176 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 =