neutron/doc/source/admin/config-experimental-framework.rst
Miguel Lavalle 7f0413c84c Implement experimental features framework
During the Zed PTG it was decided to handle unsupported features in
Neutron as experimental. See section titled "When we say something is
not supported?", day 2 in [1]. The agreement was:

"We keep existing jobs for linuxbridge driver for example, but when the
tests start to fail we skip them and finally we stop the job also.
To make it clear for operators we add warning logs highlighting that the
given feature/driver is experimental, and introduce cfg option to enable
such features explicitly."

This commit implements this agreement, initially with Linuxbridge

Depends-On: https://review.opendev.org/c/openstack/neutron-tempest-plugin/+/845646

[1] https://lists.openstack.org/pipermail/openstack-discuss/2022-April/028164.html

Change-Id: Ib18efa3f472736b58c8967847b1061da0e3897d7
2022-06-30 17:59:49 -05:00

38 lines
1.4 KiB
ReStructuredText

.. _config-experimental-framework:
===============================
Experimental features framework
===============================
Some Neutron features are not supported because the community doesn't have
the resources and/or technical expertise to maintain them anymore. As they
arise, the Neutron team designates these features as experimental. Deployers
can continue using these features at their own risk, by explicitly enabling
them in the ``experimental`` section of ``neutron.conf``.
.. note::
Of course, the Neutron core team would love to return experimetal features
to the supported status, if interested parties step up to maintain them. If
you are interested in maintaining any of the experimental features listed
below, please contact the PTL shown in the
`Neutron project page
<https://governance.openstack.org/tc/reference/projects/neutron.html>`_.
The following table shows the Neutron features currently designated as
experimetal:
.. table:: **Neutron Experimental features**
========================= ===================================
Feature Option in neutron.conf to enable
========================= ===================================
ML2 Linuxbridge driver linuxbridge
========================= ===================================
This is an example of how to enable the use of an experimental feature:
.. code-block:: none
[experimental]
linuxbridge = true