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

... because the option has been deprecated.

Note that the deprecation warning may be added in puppet-oslo so is not
implemented in individual module.

Depends-on: https://review.opendev.org/925778
Change-Id: I074eb3c8bfbb539b6cd7e95407c580479c890bd8
---
 manifests/init.pp                             | 25 +++++++++++--------
 ...heartbeat_in_pthread-d118398b69b1eb36.yaml |  5 ++++
 2 files changed, 19 insertions(+), 11 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-d118398b69b1eb36.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index 87bbdc0..f66c697 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -27,16 +27,6 @@
 #   every 30 seconds.
 #   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_quorum_queue*]
 #   (Optional) Use quorum queues in RabbitMQ.
 #   Defaults to $facts['os_service_default']
@@ -196,12 +186,23 @@
 #   (Optional) A hash of the metrics.yaml configuration.
 #   Defaults to undef
 #
+# 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
+#
 class cloudkitty(
   $package_ensure                     = 'present',
   $rabbit_use_ssl                     = $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'],
   $rabbit_ha_queues                   = $facts['os_service_default'],
   $rabbit_quorum_queue                = $facts['os_service_default'],
   $rabbit_transient_quorum_queue      = $facts['os_service_default'],
@@ -237,6 +238,8 @@ class cloudkitty(
   $storage_version                    = $facts['os_service_default'],
   $fetcher_backend                    = $facts['os_service_default'],
   Optional[Hash] $metrics_config      = undef,
+  # DEPRECATED PARAMETERS
+  $rabbit_heartbeat_in_pthread        = undef,
 ) {
 
   include cloudkitty::params
diff --git a/releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-d118398b69b1eb36.yaml b/releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-d118398b69b1eb36.yaml
new file mode 100644
index 0000000..3952398
--- /dev/null
+++ b/releasenotes/notes/deprecate-rabbit_heartbeat_in_pthread-d118398b69b1eb36.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``cloudkitty::rabbit_heartbeat_in_pthread`` parameter has been
+    deprecated and will be removed in the future release.