From 8a7201cd055a14769c60267077c467011633f7ae Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Fri, 3 Sep 2021 10:26:31 +0900
Subject: [PATCH] Manila: Deprecate ineffctive *DriverHandlesShareServers

In puppet-manila, the driver_handlers_share_servers parameter have been
deprecated for some backends[1] because these backends can only accept
true or false and accpepting arbitrary value results in manila service
failing to start.
This change deprecate the corresponding parameters in template files so
that we can remove usage of these deprecated parameters.

[1] 4c365c9064845e73a1da0f868ebba5a00c6a5c7a

Change-Id: I7cd02aa0f107e74ec35be3d1928d7aa661885d40
---
 deployment/manila/manila-backend-isilon.yaml          | 11 ++++++++++-
 deployment/manila/manila-backend-vmax.yaml            | 11 ++++++++++-
 deployment/manila/manila-backend-vnx.yaml             | 11 ++++++++++-
 ...driver_handles_share_servers-d6af4e7c25c34c6e.yaml |  8 ++++++++
 4 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-driver_handles_share_servers-d6af4e7c25c34c6e.yaml

diff --git a/deployment/manila/manila-backend-isilon.yaml b/deployment/manila/manila-backend-isilon.yaml
index 934bbae9a8..903f8b7590 100644
--- a/deployment/manila/manila-backend-isilon.yaml
+++ b/deployment/manila/manila-backend-isilon.yaml
@@ -52,6 +52,16 @@ parameters:
     description: Mapping of service endpoint -> protocol. Typically set
                  via parameter_defaults in the resource registry.
 
+parameter_groups:
+- label: deprecated
+  description: |
+   The following parameters are deprecated and will be removed. They should not
+   be relied on for new deployments. If you have concerns regarding deprecated
+   parameters, please contact the TripleO development team on IRC or the
+   OpenStack mailing list.
+  parameters:
+  - ManilaIsilonDriverHandlesShareServers
+
 outputs:
   role_data:
     description: Role data for the Manila Isilon backend.
@@ -60,7 +70,6 @@ outputs:
       config_settings:
         manila::backend::dellemc_isilon::title: {get_param: ManilaIsilonBackendName}
         manila::backend::dellemc_isilon::emc_nas_login: {get_param: ManilaIsilonNasLogin}
-        manila::backend::dellemc_isilon::driver_handles_share_servers: {get_param: ManilaIsilonDriverHandlesShareServers}
         manila::backend::dellemc_isilon::emc_nas_password: {get_param: ManilaIsilonNasPassword}
         manila::backend::dellemc_isilon::emc_nas_server: {get_param: ManilaIsilonNasServer}
         manila::backend::dellemc_isilon::emc_nas_root_dir: {get_param: ManilaIsilonNasRootDir}
diff --git a/deployment/manila/manila-backend-vmax.yaml b/deployment/manila/manila-backend-vmax.yaml
index eba4dd999c..f94cdca93e 100644
--- a/deployment/manila/manila-backend-vmax.yaml
+++ b/deployment/manila/manila-backend-vmax.yaml
@@ -52,6 +52,16 @@ parameters:
     description: Mapping of service endpoint -> protocol. Typically set
                  via parameter_defaults in the resource registry.
 
+parameter_groups:
+- label: deprecated
+  description: |
+   The following parameters are deprecated and will be removed. They should not
+   be relied on for new deployments. If you have concerns regarding deprecated
+   parameters, please contact the TripleO development team on IRC or the
+   OpenStack mailing list.
+  parameters:
+  - ManilaVMAXDriverHandlesShareServers
+
 outputs:
   role_data:
     description: Role data for the Manila VMAX backend.
@@ -60,7 +70,6 @@ outputs:
       config_settings:
         manila::backend::dellemc_vmax::title: {get_param: ManilaVMAXBackendName}
         manila::backend::dellemc_vmax::emc_nas_login: {get_param: ManilaVMAXNasLogin}
-        manila::backend::dellemc_vmax::driver_handles_share_servers: {get_param: ManilaVMAXDriverHandlesShareServers}
         manila::backend::dellemc_vmax::emc_nas_password: {get_param: ManilaVMAXNasPassword}
         manila::backend::dellemc_vmax::emc_nas_server: {get_param: ManilaVMAXNasServer}
         manila::backend::dellemc_vmax::emc_share_backend: vmax
diff --git a/deployment/manila/manila-backend-vnx.yaml b/deployment/manila/manila-backend-vnx.yaml
index 6d8196161b..2399d281ee 100644
--- a/deployment/manila/manila-backend-vnx.yaml
+++ b/deployment/manila/manila-backend-vnx.yaml
@@ -62,6 +62,16 @@ parameters:
     description: Mapping of service endpoint -> protocol. Typically set
                  via parameter_defaults in the resource registry.
 
+parameter_groups:
+- label: deprecated
+  description: |
+   The following parameters are deprecated and will be removed. They should not
+   be relied on for new deployments. If you have concerns regarding deprecated
+   parameters, please contact the TripleO development team on IRC or the
+   OpenStack mailing list.
+  parameters:
+  - ManilaVNXDriverHandlesShareServers
+
 outputs:
   role_data:
     description: Role data for the Manila VNX backend.
@@ -70,7 +80,6 @@ outputs:
       config_settings:
         manila::backend::dellemc_vnx::title: {get_param: ManilaVNXBackendName}
         manila::backend::dellemc_vnx::emc_nas_login: {get_param: ManilaVNXNasLogin}
-        manila::backend::dellemc_vnx::driver_handles_share_servers: {get_param: ManilaVNXDriverHandlesShareServers}
         manila::backend::dellemc_vnx::emc_nas_password: {get_param: ManilaVNXNasPassword}
         manila::backend::dellemc_vnx::emc_nas_server: {get_param: ManilaVNXNasServer}
         manila::backend::dellemc_vnx::emc_share_backend: vnx
diff --git a/releasenotes/notes/deprecate-driver_handles_share_servers-d6af4e7c25c34c6e.yaml b/releasenotes/notes/deprecate-driver_handles_share_servers-d6af4e7c25c34c6e.yaml
new file mode 100644
index 0000000000..c6650ad902
--- /dev/null
+++ b/releasenotes/notes/deprecate-driver_handles_share_servers-d6af4e7c25c34c6e.yaml
@@ -0,0 +1,8 @@
+---
+deprecations:
+  - |
+    The following parameters have been deprecated and have no effect.
+
+    - ManilaIsilonDriverHandlesShareServers
+    - ManilaVNXDriverHandlesShareServers
+    - ManilaVMAXDriverHandlesShareServers