From af280ffe3098b84123eae218989ea056e9935bf1 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 6 Sep 2019 11:36:22 -0400 Subject: [PATCH] Deprecate the XenAPIDriver After three months since the quality warning change merged [1] there has still been no progress in finding a maintainer for the xenapi driver or someone to get the third party CI running again - which has been off/broken for more than a release. This change formally deprecates the driver, logging a warning on startup along with providing a release note and warnings in the docs and [xenserver] config group help. Note that this does not mean the driver will absolutely be removed in the Ussuri release, but it leaves the option open to do so if the nova team decides that should happen. This was discussed at the 2019-09-05 nova meeting [2] and also at the Train PTG. [1] I7f8eb7d5c5a9b1cb0a8d5e607d719b49a22675d3 [2] http://eavesdrop.openstack.org/meetings/nova/2019/nova.2019-09-05-14.01.log.html#l-227 Change-Id: Ie7e66ff64185d9fd4be2265e040e1afc45b95174 --- doc/source/admin/configuration/hypervisor-xen-api.rst | 8 ++++++++ nova/conf/xenserver.py | 6 ++++++ nova/virt/xenapi/driver.py | 11 ++++++----- .../deprecate-xen-driver-train-bd57a16fa51ab679.yaml | 8 ++++++++ 4 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 releasenotes/notes/deprecate-xen-driver-train-bd57a16fa51ab679.yaml diff --git a/doc/source/admin/configuration/hypervisor-xen-api.rst b/doc/source/admin/configuration/hypervisor-xen-api.rst index 082a37bcbcbe..d18a7b705d64 100644 --- a/doc/source/admin/configuration/hypervisor-xen-api.rst +++ b/doc/source/admin/configuration/hypervisor-xen-api.rst @@ -4,6 +4,14 @@ XenServer (and other XAPI based Xen variants) ============================================= +.. deprecated:: 20.0.0 + + The xenapi driver is deprecated and may be removed in a future release. + The driver is not tested by the OpenStack project nor does it have clear + maintainer(s) and thus its quality can not be ensured. If you are using + the driver in production please let us know in freenode IRC and/or the + openstack-discuss mailing list. + .. todo:: os-xenapi version is 0.3.1 currently. diff --git a/nova/conf/xenserver.py b/nova/conf/xenserver.py index 00dc6eca411d..56e7e93b9cef 100644 --- a/nova/conf/xenserver.py +++ b/nova/conf/xenserver.py @@ -21,6 +21,12 @@ from oslo_utils import units xenserver_group = cfg.OptGroup('xenserver', title='Xenserver Options', help=""" +.. warning:: The xenapi driver is deprecated and may be removed in a future + release. The driver is not tested by the OpenStack project nor + does it have clear maintainer(s) and thus its quality can not be + ensured. If you are using the driver in production please let us + know in freenode IRC and/or the openstack-discuss mailing list. + XenServer options are used when the compute_driver is set to use XenServer (compute_driver=xenapi.XenAPIDriver). diff --git a/nova/virt/xenapi/driver.py b/nova/virt/xenapi/driver.py index 6be6671a7dc1..ef3eb810f535 100644 --- a/nova/virt/xenapi/driver.py +++ b/nova/virt/xenapi/driver.py @@ -112,11 +112,12 @@ class XenAPIDriver(driver.ComputeDriver): return self._host_state def init_host(self, host): - # TODO(mriedem): Consider deprecating the driver if there is still no - # working 3rd party CI by the end of the Train release. - LOG.warning('The xenapi driver is not tested by the OpenStack ' - 'project and thus its quality can not be ensured. The ' - 'driver may be deprecated in the future.') + LOG.warning('The xenapi driver is deprecated and may be removed in a ' + 'future release. The driver is not tested by the ' + 'OpenStack project nor does it have clear maintainer(s) ' + 'and thus its quality can not be ensured. If you are ' + 'using the driver in production please let us know in ' + 'freenode IRC and/or the openstack-discuss mailing list.') if CONF.xenserver.independent_compute: # Check various options are in the correct state: diff --git a/releasenotes/notes/deprecate-xen-driver-train-bd57a16fa51ab679.yaml b/releasenotes/notes/deprecate-xen-driver-train-bd57a16fa51ab679.yaml new file mode 100644 index 000000000000..b5a5681e4c73 --- /dev/null +++ b/releasenotes/notes/deprecate-xen-driver-train-bd57a16fa51ab679.yaml @@ -0,0 +1,8 @@ +--- +deprecations: + - | + The xenapi driver is deprecated and may be removed in a future release. + The driver is not tested by the OpenStack project nor does it have clear + maintainer(s) and thus its quality can not be ensured. If you are using + the driver in production please let us know in freenode IRC and/or the + openstack-discuss mailing list.