From 74b6a633848dac684acb1e1b1c1c4939fcc38273 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Mon, 30 Sep 2024 21:36:23 +0900
Subject: [PATCH] Deprecate ineffective rabbit_notification_topic

This parameter has never been used since the initial release (6.0.0).

Change-Id: I645475b504940a5caffd5a69ad95b83cab4033e2
---
 manifests/init.pp                               | 17 ++++++++++++-----
 ...bit_notification_topic-50956d3673363355.yaml |  5 +++++
 2 files changed, 17 insertions(+), 5 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-rabbit_notification_topic-50956d3673363355.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index 42103349..1b133457 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -47,10 +47,6 @@
 #   (optional) Connect over SSL for RabbitMQ
 #   Defaults to $facts['os_service_default']
 #
-# [*rabbit_notification_topic*]
-#   (optional) Notification topic.
-#   Defaults to $facts['os_service_default']
-#
 # [*kombu_ssl_ca_certs*]
 #   (optional) SSL certification authority file (valid only if SSL enabled).
 #   Defaults to $facts['os_service_default']
@@ -240,6 +236,12 @@
 #   (optional) The state of the package.
 #   Defaults to 'present'
 #
+# DEPRECATED PARAMETERS
+#
+# [*rabbit_notification_topic*]
+#   (optional) Notification topic.
+#   Defaults to undef
+#
 class trove(
   $default_transport_url              = $facts['os_service_default'],
   $notification_transport_url         = $facts['os_service_default'],
@@ -247,7 +249,6 @@ class trove(
   $notification_topics                = $facts['os_service_default'],
   $rabbit_use_ssl                     = $facts['os_service_default'],
   $rabbit_ha_queues                   = $facts['os_service_default'],
-  $rabbit_notification_topic          = $facts['os_service_default'],
   $rabbit_heartbeat_timeout_threshold = $facts['os_service_default'],
   $rabbit_heartbeat_rate              = $facts['os_service_default'],
   $rabbit_heartbeat_in_pthread        = $facts['os_service_default'],
@@ -289,12 +290,18 @@ class trove(
   $volume_rootdisk_support            = $facts['os_service_default'],
   $volume_rootdisk_size               = $facts['os_service_default'],
   $package_ensure                     = 'present',
+  # DEPRECATED PARAMETERS
+  $rabbit_notification_topic          = undef,
 ) {
 
   include trove::deps
   include trove::policy
   include trove::params
 
+  if $rabbit_notification_topic != undef {
+    warning('The rabbit_notification_topic parameter is deprecated and has no effect.')
+  }
+
   package { 'trove':
     ensure => $package_ensure,
     name   => $::trove::params::common_package_name,
diff --git a/releasenotes/notes/deprecate-rabbit_notification_topic-50956d3673363355.yaml b/releasenotes/notes/deprecate-rabbit_notification_topic-50956d3673363355.yaml
new file mode 100644
index 00000000..3daad487
--- /dev/null
+++ b/releasenotes/notes/deprecate-rabbit_notification_topic-50956d3673363355.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``trove::rabbit_notification_topic`` parameter has been deperecated,
+    because it has had no effect.