From 7e42fdb73fded55856b86d4c3da706a8ab609e5f Mon Sep 17 00:00:00 2001
From: Brian Rosmaita <rosmaita.fossdev@gmail.com>
Date: Mon, 15 Apr 2024 11:52:31 -0400
Subject: [PATCH] Deprecate iser_opts

The 'iser_helper' has been unused since Havana, and the code that
uses the others was removed during Newton development by change
I143b7b2fe9f5

Change-Id: I1723bc441492281d1bb18a0dd0ccb638cf702e71
---
 cinder/volume/driver.py                       | 25 +++++++++++++++----
 .../deprecate-iser-opts-b0af9a68b7b8578c.yaml | 11 ++++++++
 2 files changed, 31 insertions(+), 5 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-iser-opts-b0af9a68b7b8578c.yaml

diff --git a/cinder/volume/driver.py b/cinder/volume/driver.py
index 2bbe9e8ca5a..b8eedf48bc6 100644
--- a/cinder/volume/driver.py
+++ b/cinder/volume/driver.py
@@ -247,19 +247,34 @@ iser_opts = [
     cfg.IntOpt('num_iser_scan_tries',
                default=3,
                help='The maximum number of times to rescan iSER target '
-                    'to find volume'),
+                    'to find volume',
+               deprecated_for_removal=True,
+               deprecated_since='2025.1',
+               deprecated_reason='Has been unused since the Mitaka release.'),
     cfg.StrOpt('iser_target_prefix',
                default='iqn.2010-10.org.openstack:',
-               help='Prefix for iSER volumes'),
+               help='Prefix for iSER volumes',
+               deprecated_for_removal=True,
+               deprecated_since='2025.1',
+               deprecated_reason='Has been unused since the Mitaka release.'),
     cfg.StrOpt('iser_ip_address',
                default='$my_ip',
-               help='The IP address that the iSER daemon is listening on'),
+               help='The IP address that the iSER daemon is listening on',
+               deprecated_for_removal=True,
+               deprecated_since='2025.1',
+               deprecated_reason='Has been unused since the Mitaka release.'),
     cfg.PortOpt('iser_port',
                 default=3260,
-                help='The port that the iSER daemon is listening on'),
+                help='The port that the iSER daemon is listening on',
+                deprecated_for_removal=True,
+                deprecated_since='2025.1',
+                deprecated_reason='Has been unused since the Mitaka release.'),
     cfg.StrOpt('iser_helper',
                default='tgtadm',
-               help='The name of the iSER target user-land tool to use'),
+               help='The name of the iSER target user-land tool to use',
+               deprecated_for_removal=True,
+               deprecated_since='2025.1',
+               deprecated_reason='Has been unused since the Havana release.'),
 ]
 
 nvmeof_opts = [
diff --git a/releasenotes/notes/deprecate-iser-opts-b0af9a68b7b8578c.yaml b/releasenotes/notes/deprecate-iser-opts-b0af9a68b7b8578c.yaml
new file mode 100644
index 00000000000..72f1e1ea64a
--- /dev/null
+++ b/releasenotes/notes/deprecate-iser-opts-b0af9a68b7b8578c.yaml
@@ -0,0 +1,11 @@
+---
+deprecations:
+  - |
+    The following configuration options, which have been silently ignored since
+    the Mitaka release, are hereby deprecated for removal:
+
+    - ``num_iser_scan_tries``
+    - ``iser_target_prefix``
+    - ``iser_ip_address``
+    - ``iser_port``
+    - ``iser_helper``