From e0cb3c62764dbec7bccb5148a04c82547334afab Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Tue, 13 Jul 2021 11:17:31 +0900
Subject: [PATCH] Deprecate ineffective ManilaCephFSCephFSEnableSnapshots

The cephfs_enable_snapshots parameter was deprecated in Manila[1]
during Victoria and was removed during Wallaby. Now Manila always
enables snapshot support for CephFS backend. Following that deprecation
in Manila, the corresponding parameter of puppet-manila was deprecated
during the Victoria cycle [2] and it is being removed during the Xena
cycle.

This deprecates the corresponding parameter from tripleo-heat-tempaltes
because it has no effect since Wallaby.

[1] 2d7c46445396b0db780ba456ffb9284b177a6ae4
[2] 2388d7510d600e358c76becf13d08581b489f2a7

Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com>
Change-Id: I81565290603eb60c8c18e64c95ead7b761e8cb78
---
 deployment/manila/manila-backend-cephfs.yaml  | 21 +++++++++++++++----
 environments/manila-cephfsganesha-config.yaml |  1 -
 environments/manila-cephfsnative-config.yaml  |  1 -
 ...phfs-enable-snapshot-7857604802378720.yaml |  6 ++++++
 4 files changed, 23 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-manila-cephfs-enable-snapshot-7857604802378720.yaml

diff --git a/deployment/manila/manila-backend-cephfs.yaml b/deployment/manila/manila-backend-cephfs.yaml
index 8bb6dbe91e..8e1a0c6024 100644
--- a/deployment/manila/manila-backend-cephfs.yaml
+++ b/deployment/manila/manila-backend-cephfs.yaml
@@ -57,9 +57,6 @@ parameters:
   ManilaCephFSCephFSAuthId:
     type: string
     default: 'manila'
-  ManilaCephFSCephFSEnableSnapshots:
-    type: boolean
-    default: false
   ManilaCephFSCephVolumeMode:
     type: string
     default: '0755'
@@ -70,6 +67,23 @@ parameters:
     type: string
     constraints:
     - allowed_values: ['CEPHFS', 'NFS']
+  # Deprecated parameters
+  ManilaCephFSCephFSEnableSnapshots:
+    type: boolean
+    description: |
+      Enable snapshot support in CephFS driver. Note that this parameter has
+      no effect now and snapshot support is always enabled.
+    default: false
+
+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:
+  - ManilaCephFSCephFSEnableSnapshots
 
 outputs:
   role_data:
@@ -90,6 +104,5 @@ outputs:
             - .conf
         manila::backend::cephfs::cephfs_auth_id: {get_param: ManilaCephFSCephFSAuthId}
         manila::backend::cephfs::cephfs_cluster_name: {get_param: CephClusterName}
-        manila::backend::cephfs::cephfs_enable_snapshots: {get_param: ManilaCephFSCephFSEnableSnapshots}
         manila::backend::cephfs::cephfs_volume_mode: {get_param: ManilaCephFSCephVolumeMode}
         manila::backend::cephfs::cephfs_protocol_helper_type: {get_param: ManilaCephFSCephFSProtocolHelperType}
diff --git a/environments/manila-cephfsganesha-config.yaml b/environments/manila-cephfsganesha-config.yaml
index 4429c41090..55943cf25b 100644
--- a/environments/manila-cephfsganesha-config.yaml
+++ b/environments/manila-cephfsganesha-config.yaml
@@ -14,7 +14,6 @@ resource_registry:
 parameter_defaults:
   ManilaCephFSBackendName: cephfs
   ManilaCephFSDriverHandlesShareServers: false
-  ManilaCephFSCephFSEnableSnapshots: false
   ManilaCephFSCephVolumeMode: '0755'
   # manila cephfs driver supports either native cephfs backend - 'CEPHFS'
   # (users mount shares directly from ceph cluster), or nfs-ganesha backend -
diff --git a/environments/manila-cephfsnative-config.yaml b/environments/manila-cephfsnative-config.yaml
index 05d6747921..3d4efd2fc5 100644
--- a/environments/manila-cephfsnative-config.yaml
+++ b/environments/manila-cephfsnative-config.yaml
@@ -12,7 +12,6 @@ parameter_defaults:
   ManilaCephFSBackendName: cephfs
   ManilaCephFSDriverHandlesShareServers: false
   ManilaCephFSCephFSAuthId: 'manila'
-  ManilaCephFSCephFSEnableSnapshots: false
   ManilaCephFSCephVolumeMode: '0755'
   # manila cephfs driver supports either native cephfs backend - 'CEPHFS'
   # (users mount shares directly from ceph cluster), or nfs-ganesha backend -
diff --git a/releasenotes/notes/deprecate-manila-cephfs-enable-snapshot-7857604802378720.yaml b/releasenotes/notes/deprecate-manila-cephfs-enable-snapshot-7857604802378720.yaml
new file mode 100644
index 0000000000..90d0041bce
--- /dev/null
+++ b/releasenotes/notes/deprecate-manila-cephfs-enable-snapshot-7857604802378720.yaml
@@ -0,0 +1,6 @@
+---
+deprecations:
+  - |
+    The ``ManilaCephFSCephFSEnableSnapshots`` parameter has been deprecated,
+    and has no effect now. Manila always enables snapshot support in Ceph FS
+    backend since Wallaby.