From e73bf6a864e537a6530ddfb23e0425e58c4f51cd Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Sun, 16 May 2021 21:25:06 +0900
Subject: [PATCH] Deprecate the powerstore_appliances parameter

... because it was already deprecated[1] in cinder and has no effect.

[1] f328341ed0eb920a6471f7c65e06b27c3f719fbe
Change-Id: Ic25a2a88ccfc5eddf180d44cb109d69378c5277f
---
 manifests/backend/dellemc_powerstore.pp       | 19 ++++++++++++++-----
 ...owerstore_appliances-1a3ef9166d1b35ad.yaml |  6 ++++++
 .../cinder_backend_dellemc_powerstore_spec.rb |  2 --
 3 files changed, 20 insertions(+), 7 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-powerstore_appliances-1a3ef9166d1b35ad.yaml

diff --git a/manifests/backend/dellemc_powerstore.pp b/manifests/backend/dellemc_powerstore.pp
index 10b8f2fb..daa603e9 100644
--- a/manifests/backend/dellemc_powerstore.pp
+++ b/manifests/backend/dellemc_powerstore.pp
@@ -13,9 +13,6 @@
 # [*san_password*]
 #   (required) PowerStore REST password
 #
-# [*powerstore_appliances*]
-#   (required) PowerStore appliances
-#
 # [*powerstore_ports*]
 #   (optional) PowerStore allowed ports
 #
@@ -45,21 +42,31 @@
 #   Example:
 #     { 'dellemc_powerstore_backend/param1' => { 'value' => value1 } }
 #
+# DEPRECATED PARAMETERS
+#
+# [*powerstore_appliances*]
+#   (optional) PowerStore appliances
+#   Defaults to undef
+#
 define cinder::backend::dellemc_powerstore (
   $san_ip,
   $san_login,
   $san_password,
-  $powerstore_appliances,
   $powerstore_ports            = $::os_service_default,
   $storage_protocol            = 'iSCSI',
   $volume_backend_name         = $name,
   $backend_availability_zone   = $::os_service_default,
   $manage_volume_type          = false,
   $extra_options               = {},
+  $powerstore_appliances       = undef,
 ) {
 
   include cinder::deps
 
+  if $powerstore_appliances != undef {
+    warning('The powerstore_appliances parameter has been deprecated and has no effect')
+  }
+
   if $storage_protocol == 'iSCSI' {
     $driver = 'dell_emc.powerstore.driver.PowerStoreDriver'
   }
@@ -77,10 +84,12 @@ define cinder::backend::dellemc_powerstore (
     "${name}/san_ip":                    value => $san_ip;
     "${name}/san_login":                 value => $san_login;
     "${name}/san_password":              value => $san_password, secret => true;
-    "${name}/powerstore_appliances":     value => $powerstore_appliances;
     "${name}/powerstore_ports":          value => $powerstore_ports;
     "${name}/storage_protocol":          value => $storage_protocol;
+  }
 
+  cinder_config {
+    "${name}/powerstore_appliances": ensure => absent;
   }
 
   if $manage_volume_type {
diff --git a/releasenotes/notes/deprecate-powerstore_appliances-1a3ef9166d1b35ad.yaml b/releasenotes/notes/deprecate-powerstore_appliances-1a3ef9166d1b35ad.yaml
new file mode 100644
index 00000000..ba86fbe3
--- /dev/null
+++ b/releasenotes/notes/deprecate-powerstore_appliances-1a3ef9166d1b35ad.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    The ``cinder::backend::dellemc_powerstore::powerstore_appliances``
+    parameter has been deprecated and has no effect now. This parameter will be
+    removed in a future release.
diff --git a/spec/defines/cinder_backend_dellemc_powerstore_spec.rb b/spec/defines/cinder_backend_dellemc_powerstore_spec.rb
index 6fba4b07..a205459f 100644
--- a/spec/defines/cinder_backend_dellemc_powerstore_spec.rb
+++ b/spec/defines/cinder_backend_dellemc_powerstore_spec.rb
@@ -10,8 +10,6 @@ describe 'cinder::backend::dellemc_powerstore' do
       :san_ip                => '172.23.8.101',
       :san_login             => 'Admin',
       :san_password          => '12345',
-      :powerstore_appliances => 'Appliance-1',
-
     }
   end