From 2896fe16c001d8ed3bad130ff6ddc83db819f2bb Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Tue, 31 Oct 2023 15:30:28 +0900
Subject: [PATCH] Deprecate configuration support of BIND 9

Current implementation has a limited capability and is not suitable for
production use. This deprecates it to encourage people to use
puppet-dns (or any other different tools) to set up BIND 9 separately.

Change-Id: I2a53e927053abe13aa64de1b7f8207142e021d1a
---
 manifests/backend/bind9.pp                               | 9 ++++++---
 .../notes/deprecate-configure_bind-b9f5b8aa0833459b.yaml | 5 +++++
 2 files changed, 11 insertions(+), 3 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-configure_bind-b9f5b8aa0833459b.yaml

diff --git a/manifests/backend/bind9.pp b/manifests/backend/bind9.pp
index cc11a6bf..34e2209f 100644
--- a/manifests/backend/bind9.pp
+++ b/manifests/backend/bind9.pp
@@ -50,13 +50,13 @@
 #  packets to.
 #  Defaults to [].
 #
+# DEPRECATED PARAMETERS
+#
 # [*configure_bind*]
 #  (Optional) Enables running bind9/named configuration for hosts where
 #  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
@@ -73,8 +73,8 @@ class designate::backend::bind9 (
   Array[String[1], 1] $mdns_hosts   = ['127.0.0.1'],
   $mdns_port                        = 5354,
   Array[String[1]] $also_notifies   = [],
-  Boolean $configure_bind           = true,
   # DEPRECATED PARAMETERS
+  Boolean $configure_bind           = true,
   Boolean $manage_pool              = true,
 ) {
 
@@ -82,6 +82,9 @@ class designate::backend::bind9 (
   include designate::params
 
   if $configure_bind {
+    warning("Configuragion of BIND 9 by designate::backend::bind9 is deprecated \
+and will be removed in a future release.")
+
     $dns_additional_options = {
       'allow-new-zones'   => 'yes',
       # Recommended by Designate docs as a mitigation for potential cache
diff --git a/releasenotes/notes/deprecate-configure_bind-b9f5b8aa0833459b.yaml b/releasenotes/notes/deprecate-configure_bind-b9f5b8aa0833459b.yaml
new file mode 100644
index 00000000..ef90e59c
--- /dev/null
+++ b/releasenotes/notes/deprecate-configure_bind-b9f5b8aa0833459b.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    Configuration of BIND 9 service using the ``designate::backend::bind9``
+    class has been deprecated and will be removed.