From 579a9284fdbffe4171a4e2581c6a6fd458ae8d01 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Fri, 19 Jul 2019 12:22:49 -0400 Subject: [PATCH] Deprecate Sheepdog driver As there was no response to the ML announcement [0], proceed with deprecation of the Sheepdog driver, scheduled for removal in the 'U' cycle. [0] http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006725.html Change-Id: Ie41b166e51e4d7b674f893c2b71d576e5a8b51a0 --- doc/source/user/drivers.rst | 12 ++++++++++ glance_store/_drivers/sheepdog.py | 23 +++++++++++++++++++ ...cate-sheepdog-driver-1f9689c327f313d4.yaml | 12 ++++++++++ 3 files changed, 47 insertions(+) create mode 100644 releasenotes/notes/deprecate-sheepdog-driver-1f9689c327f313d4.yaml diff --git a/doc/source/user/drivers.rst b/doc/source/user/drivers.rst index c3808a87..24169fe7 100644 --- a/doc/source/user/drivers.rst +++ b/doc/source/user/drivers.rst @@ -11,34 +11,46 @@ below the table of supported drivers and maintainers: :header-rows: 1 * - Driver + - Status - Maintainer - Email - IRC Nick * - File System + - Supported - Glance Team - openstack-discuss@lists.openstack.org - openstack-glance * - HTTP + - Supported - Glance Team - openstack-discuss@lists.openstack.org - openstack-glance * - RBD + - Supported - Fei Long Wang - flwang@catalyst.net.nz - flwang * - Cinder + - Supported - Tomoki Sekiyama - tomoki.sekiyama@gmail.com - * - Swift + - Supported - Matthew Oliver - matt@oliver.net.au - mattoliverau * - VMware + - Supported - Sabari Murugesan - smurugesan@vmware.com - sabari * - Sheepdog + - DEPRECATED - YAMADA Hideki - yamada.hideki@lab.ntt.co.jp - yamada-h + +.. warning:: + The Sheepdog driver is subject to removal early in the 'U' + development cycle. diff --git a/glance_store/_drivers/sheepdog.py b/glance_store/_drivers/sheepdog.py index 2b1f4519..08f3e819 100644 --- a/glance_store/_drivers/sheepdog.py +++ b/glance_store/_drivers/sheepdog.py @@ -44,6 +44,13 @@ _SHEEPDOG_OPTS = [ cfg.IntOpt('sheepdog_store_chunk_size', min=1, default=DEFAULT_CHUNKSIZE, + deprecated_for_removal=True, + deprecated_since='Train', + deprecated_reason=""" +The Sheepdog project is no longer actively maintained. The +Sheepdog driver is scheduled for removal in the 'U' development +cycle. +""", help=""" Chunk size for images to be stored in Sheepdog data store. @@ -67,6 +74,13 @@ Related Options: """), cfg.PortOpt('sheepdog_store_port', default=DEFAULT_PORT, + deprecated_for_removal=True, + deprecated_since='Train', + deprecated_reason=""" +The Sheepdog project is no longer actively maintained. The +Sheepdog driver is scheduled for removal in the 'U' development +cycle. +""", help=""" Port number on which the sheep daemon will listen. @@ -89,6 +103,13 @@ Related Options: """), cfg.HostAddressOpt('sheepdog_store_address', default=DEFAULT_ADDR, + deprecated_for_removal=True, + deprecated_since='Train', + deprecated_reason=""" +The Sheepdog project is no longer actively maintained. The +Sheepdog driver is scheduled for removal in the 'U' development +cycle. +""", help=""" Address to bind the Sheepdog daemon to. @@ -122,6 +143,8 @@ class SheepdogImage(object): self.port = port self.name = name self.chunk_size = chunk_size + LOG.warning("The Sheepdog driver is deprecated and will be removed " + "in the 'U' release.") def _run_command(self, command, data, *params): cmd = ['collie', 'vdi'] diff --git a/releasenotes/notes/deprecate-sheepdog-driver-1f9689c327f313d4.yaml b/releasenotes/notes/deprecate-sheepdog-driver-1f9689c327f313d4.yaml new file mode 100644 index 00000000..fb0d3c59 --- /dev/null +++ b/releasenotes/notes/deprecate-sheepdog-driver-1f9689c327f313d4.yaml @@ -0,0 +1,12 @@ +--- +deprecations: + - | + The Sheepdog driver is deprecated in this release and is subject to + removal at the beginning of the 'U' development cycle, following the + `OpenStack standard deprecation policy + `_. + + The driver is being removed because `Sheepdog is not maintained upstream + `_. + Additionally, the Sheepdog driver is no longer tested in the OpenStack + gate.