From 281b8b0dafebc7511aa1610670f700ff30d49ad2 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Thu, 1 Feb 2024 03:19:21 +0900
Subject: [PATCH] Deprecate support for unsupported drivers

The following three volume drivers are no longer supported, because
the storage products are now EOL[1].

 - Dell SC Series Storage Driver (iSCSI, FC)
 - Dell VNX Storage Driver (FC, iSCSI)
 - Dell XtremeIO Storage Driver (iSCSI, FC)

This deprecates support for these volume drivers, so that we can remove
these drivers after 2024.1 release.

[1] https://lists.openstack.org/archives/list/openstack-discuss@lists.openstack.org/thread/7D7GUOI66BOD7Z3ZQWPWYYHH6VHAY4JJ/

Depends-on: https://review.opendev.org/c/openstack/cinder/+/907346
Change-Id: I1fbe1a4788c3c39f73b94af2209318c64154dcf5
---
 manifests/backend/dellemc_sc.pp                        |  3 +++
 manifests/backend/dellemc_xtremio.pp                   |  3 +++
 manifests/backend/emc_vnx.pp                           |  5 +++--
 ...-dell-storage-drivers-caracal-cc59ab61edeee1bf.yaml | 10 ++++++++++
 4 files changed, 19 insertions(+), 2 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-dell-storage-drivers-caracal-cc59ab61edeee1bf.yaml

diff --git a/manifests/backend/dellemc_sc.pp b/manifests/backend/dellemc_sc.pp
index a926884b..482f42ef 100644
--- a/manifests/backend/dellemc_sc.pp
+++ b/manifests/backend/dellemc_sc.pp
@@ -1,5 +1,6 @@
 # == define: cinder::backend::dellemc_sc
 #
+# DEPRECATED !!
 # Configure the Dell Storage Center Driver for cinder.
 #
 # === Parameters
@@ -134,6 +135,8 @@ define cinder::backend::dellemc_sc (
 
   include cinder::deps
 
+  warning('Support for Dell SC Series storage driver options has been deprecated.')
+
   $volume_driver = $sc_storage_protocol ? {
     'FC'    => 'cinder.volume.drivers.dell_emc.sc.storagecenter_fc.SCFCDriver',
     default => 'cinder.volume.drivers.dell_emc.sc.storagecenter_iscsi.SCISCSIDriver',
diff --git a/manifests/backend/dellemc_xtremio.pp b/manifests/backend/dellemc_xtremio.pp
index a372f8d5..992b0d8e 100644
--- a/manifests/backend/dellemc_xtremio.pp
+++ b/manifests/backend/dellemc_xtremio.pp
@@ -1,5 +1,6 @@
 # == define: cinder::backend::dellemc_xtremio
 #
+# DEPRECATED !!
 # Configure the Dell EMC XtremIO Driver for cinder.
 #
 # === Parameters
@@ -100,6 +101,8 @@ define cinder::backend::dellemc_xtremio (
 
   include cinder::deps
 
+  warning('Support for Dell XtremeIO storage driver options has been deprecated.')
+
   $driver = $xtremio_storage_protocol ? {
     'FC'    => 'dell_emc.xtremio.XtremIOFCDriver',
     default => 'dell_emc.xtremio.XtremIOISCSIDriver',
diff --git a/manifests/backend/emc_vnx.pp b/manifests/backend/emc_vnx.pp
index 1abdde8a..2bf70d2b 100644
--- a/manifests/backend/emc_vnx.pp
+++ b/manifests/backend/emc_vnx.pp
@@ -1,8 +1,8 @@
 #
 # == Define: cinder::backend::emc_vnx
 #
+# DEPRECATED !!
 # Setup Cinder to use the EMC VNX driver.
-# Compatible for multiple backends
 #
 # == Parameters
 #
@@ -159,7 +159,8 @@ define cinder::backend::emc_vnx (
 ) {
 
   include cinder::deps
-  include cinder::params
+
+  warning('Support for Dell VNX storage driver options has been deprecated.')
 
   cinder_config {
     "${name}/default_timeout":                  value => $default_timeout;
diff --git a/releasenotes/notes/deprecate-dell-storage-drivers-caracal-cc59ab61edeee1bf.yaml b/releasenotes/notes/deprecate-dell-storage-drivers-caracal-cc59ab61edeee1bf.yaml
new file mode 100644
index 00000000..0ad84cfa
--- /dev/null
+++ b/releasenotes/notes/deprecate-dell-storage-drivers-caracal-cc59ab61edeee1bf.yaml
@@ -0,0 +1,10 @@
+---
+deprecations:
+  - |
+    The following defined resource types have been deprecated and will be
+    removed in a future release. These support options for the storage drivers
+    which are no longer supported because of product EOL.
+
+    - ``cinder::backends::delemc_sc``
+    - ``cinder::backends::delemc_xtremio``
+    - ``cinder::backends::emc_vnx``