From e19976ade6608db3abb084a58be5aed7657e5f7a Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Tue, 31 Oct 2023 15:35:43 +0900
Subject: [PATCH] Deprecate manage_pool parameters

The designate::backend::bind9 class and the designate::backend::pdns4
class configures (almost) nothing in case manage_pool parameter is
false, so these parameters are just redundant.

Change-Id: I82ec568c27b8fc5ee167b1451f159cfe7a915290
---
 manifests/backend/bind9.pp                                   | 5 +++++
 manifests/backend/pdns4.pp                                   | 5 +++++
 .../notes/deprecate-manage_pool-0682004d3f435994.yaml        | 4 ++++
 3 files changed, 14 insertions(+)
 create mode 100644 releasenotes/notes/deprecate-manage_pool-0682004d3f435994.yaml

diff --git a/manifests/backend/bind9.pp b/manifests/backend/bind9.pp
index 86903758..cc11a6bf 100644
--- a/manifests/backend/bind9.pp
+++ b/manifests/backend/bind9.pp
@@ -55,6 +55,8 @@
 #  designate and designate bind services are collocated.
 #  Defaults to true
 #
+# DEPRECATED PARAMETERS
+#
 # [*manage_pool*]
 #  (Optional) Manage pools.yaml and update pools by designate-manage command
 #  Defaults to true
@@ -72,6 +74,7 @@ class designate::backend::bind9 (
   $mdns_port                        = 5354,
   Array[String[1]] $also_notifies   = [],
   Boolean $configure_bind           = true,
+  # DEPRECATED PARAMETERS
   Boolean $manage_pool              = true,
 ) {
 
@@ -119,5 +122,7 @@ class designate::backend::bind9 (
       require     => Anchor['designate::service::end'],
       subscribe   => File['/etc/designate/pools.yaml'],
     }
+  } else {
+    warning('The manage_pool parameter is deprecated and will be removed in a future release')
   }
 }
diff --git a/manifests/backend/pdns4.pp b/manifests/backend/pdns4.pp
index 4a789eac..2824ebe3 100644
--- a/manifests/backend/pdns4.pp
+++ b/manifests/backend/pdns4.pp
@@ -37,6 +37,8 @@
 #  packets to.
 #  Defaults to [].
 #
+# DEPRECATED PARAMETERS
+#
 # [*manage_pool*]
 #  (Optional) Manage pools.yaml and update pools by designate-manage command
 #  Defaults to true
@@ -50,6 +52,7 @@ class designate::backend::pdns4 (
   String[1] $api_endpoint           = 'http://127.0.0.1:8081',
   Optional[String[1]] $tsigkey_name = undef,
   Array[String[1]] $also_notifies   = [],
+  # DEPRECATED PARAMETERS
   Boolean $manage_pool              = true,
 ) {
 
@@ -77,5 +80,7 @@ class designate::backend::pdns4 (
       require     => Anchor['designate::service::end'],
       subscribe   => File['/etc/designate/pools.yaml'],
     }
+  } else {
+    warning('The manage_pool parameter is deprecated and will be removed in a future release')
   }
 }
diff --git a/releasenotes/notes/deprecate-manage_pool-0682004d3f435994.yaml b/releasenotes/notes/deprecate-manage_pool-0682004d3f435994.yaml
new file mode 100644
index 00000000..c60e0ab3
--- /dev/null
+++ b/releasenotes/notes/deprecate-manage_pool-0682004d3f435994.yaml
@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    The ``manage_pool`` parameter has been deprecated.