From 4d11399e729a9c3a6ebfac874c6f7ee4014b7b13 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Tue, 18 Feb 2025 11:12:28 +0900
Subject: [PATCH] Deprecate support for [oslo_messaging_rabbit]
 heartbeat_in_pthread

... because the option has been deprecated.

Depends-on: https://review.opendev.org/925778
Change-Id: I73330dfaad5ab97fd6cbc5888df90c3b2ce928cc
---
 manifests/init.pp                             | 25 +++++++++++--------
 ...heartbeat_in_pthread-22181d3776e58738.yaml |  5 ++++
 spec/classes/watcher_init_spec.rb             |  2 +-
 3 files changed, 20 insertions(+), 12 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-22181d3776e58738.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index eaf4bde..1ad94c1 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -35,16 +35,6 @@
 #   check the heartbeat.
 #   Defaults to $facts['os_service_default']
 #
-# [*rabbit_heartbeat_in_pthread*]
-#   (Optional) EXPERIMENTAL: Run the health check heartbeat thread
-#   through a native python thread. By default if this
-#   option isn't provided the  health check heartbeat will
-#   inherit the execution model from the parent process. By
-#   example if the parent process have monkey patched the
-#   stdlib by using eventlet/greenlet then the heartbeat
-#   will be run through a green thread.
-#   Defaults to $facts['os_service_default']
-#
 # [*rabbit_ha_queues*]
 #   (optional) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this
 #   option, you must wipe the RabbitMQ database.
@@ -176,6 +166,18 @@
 #   in the watcher config.
 #   Defaults to false.
 #
+# DEPRECATED PARAMETERS
+#
+# [*rabbit_heartbeat_in_pthread*]
+#   (Optional) EXPERIMENTAL: Run the health check heartbeat thread
+#   through a native python thread. By default if this
+#   option isn't provided the  health check heartbeat will
+#   inherit the execution model from the parent process. By
+#   example if the parent process have monkey patched the
+#   stdlib by using eventlet/greenlet then the heartbeat
+#   will be run through a green thread.
+#   Defaults to undef.
+#
 # === Authors
 #
 # Daniel Pawlik  <daniel.pawlik@corp.ovh.com>
@@ -188,7 +190,6 @@ class watcher (
   $rabbit_interval_max                  = $facts['os_service_default'],
   $rabbit_use_ssl                       = $facts['os_service_default'],
   $rabbit_heartbeat_rate                = $facts['os_service_default'],
-  $rabbit_heartbeat_in_pthread          = $facts['os_service_default'],
   $rabbit_ha_queues                     = $facts['os_service_default'],
   $rabbit_quorum_queue                  = $facts['os_service_default'],
   $rabbit_transient_quorum_queue        = $facts['os_service_default'],
@@ -215,6 +216,8 @@ class watcher (
   $notification_topics                  = $facts['os_service_default'],
   $notification_retry                   = $facts['os_service_default'],
   Boolean $purge_config                 = false,
+  # DEPRECATED PARAMETERS
+  $rabbit_heartbeat_in_pthread          = undef,
 ) {
 
   include openstacklib::openstackclient
diff --git a/releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-22181d3776e58738.yaml b/releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-22181d3776e58738.yaml
new file mode 100644
index 0000000..2ffa017
--- /dev/null
+++ b/releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-22181d3776e58738.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``watcher::rabbit_heartbeat_in_pthread`` parameter has been deprecated
+    and will be removed in the future release.
diff --git a/spec/classes/watcher_init_spec.rb b/spec/classes/watcher_init_spec.rb
index e8ef451..2e0ae53 100644
--- a/spec/classes/watcher_init_spec.rb
+++ b/spec/classes/watcher_init_spec.rb
@@ -36,7 +36,7 @@ describe 'watcher' do
           :rabbit_use_ssl                  => '<SERVICE DEFAULT>',
           :heartbeat_timeout_threshold     => '<SERVICE DEFAULT>',
           :heartbeat_rate                  => '<SERVICE DEFAULT>',
-          :heartbeat_in_pthread            => '<SERVICE DEFAULT>',
+          :heartbeat_in_pthread            => nil,
           :kombu_reconnect_delay           => '<SERVICE DEFAULT>',
           :kombu_failover_strategy         => '<SERVICE DEFAULT>',
           :amqp_durable_queues             => '<SERVICE DEFAULT>',