From b139fe94ae75765e6d80f7ffb5de8c62aa3cb9f6 Mon Sep 17 00:00:00 2001
From: Michael Johnson <johnsomor@gmail.com>
Date: Fri, 8 Nov 2024 01:45:36 +0000
Subject: [PATCH] Update octavia-tempest-plugin configref

This patch updates the octavia-tempest-plugin configuration reference
documentation to only include octavia-tempest-plugin specific
configuration options.
This simplifies our documentation and means bugs in other plugins will
not break our configuration reference docs job.

It also re-enables the docs job, disabled in a previous patch.

Change-Id: I53d81ca7bd910838927d594bfb0e72320b9d1ec6
---
 doc/source/configref.rst       |  4 +---
 octavia_tempest_plugin/opts.py | 21 +++++++++++++++++++++
 setup.cfg                      |  2 ++
 zuul.d/projects.yaml           |  3 +--
 4 files changed, 25 insertions(+), 5 deletions(-)
 create mode 100644 octavia_tempest_plugin/opts.py

diff --git a/doc/source/configref.rst b/doc/source/configref.rst
index f9db0424..4b58b126 100644
--- a/doc/source/configref.rst
+++ b/doc/source/configref.rst
@@ -19,8 +19,6 @@ Octavia Tempest Plugin Configuration Options
 .. contents:: Table of Contents
     :depth: 2
 
-.. note:: Not all of these options are used by the Octavia tempest tests.
-
 .. show-options::
 
-    tempest.config
+    octavia-tempest-plugin
diff --git a/octavia_tempest_plugin/opts.py b/octavia_tempest_plugin/opts.py
new file mode 100644
index 00000000..23850356
--- /dev/null
+++ b/octavia_tempest_plugin/opts.py
@@ -0,0 +1,21 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy
+# of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import octavia_tempest_plugin.config
+
+
+def list_opts():
+    return [
+        ('load_balancer', octavia_tempest_plugin.config.OctaviaGroup),
+        ('loadbalancer-feature-enabled',
+         octavia_tempest_plugin.config.LBFeatureEnabledGroup),
+    ]
diff --git a/setup.cfg b/setup.cfg
index 45e50303..ed187d41 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -29,3 +29,5 @@ packages =
 [entry_points]
 tempest.test_plugins =
     octavia-tempest-plugin = octavia_tempest_plugin.plugin:OctaviaTempestPlugin
+oslo.config.opts =
+    octavia-tempest-plugin = octavia_tempest_plugin.opts:list_opts
diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml
index e7b806d4..a1c7e36c 100644
--- a/zuul.d/projects.yaml
+++ b/zuul.d/projects.yaml
@@ -3,8 +3,7 @@
 - project:
     templates:
       - check-requirements
-      # TODO(tkajinam): Re-enable this
-      #- publish-openstack-docs-pti
+      - publish-openstack-docs-pti
       # TODO(gthiemonge): Re-enable this, pep8 is currently broken
       #- tempest-plugin-jobs
       - release-notes-jobs-python3