From f34e250fb501cfa248abbf8a9efebbf32a103e42 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Mon, 20 Mar 2023 18:50:46 +0900
Subject: [PATCH] Deprecate unused [coordination] heartbeat_interval

This option has never been used by actual logic. This deprecates
the ineffective option so that we can remove it in a future release.

Change-Id: I350e45fc9aef28db8790614ade7a5ad3071e574b
---
 mistral/config.py                                            | 2 ++
 ...ate-coordination-heartbeat_interval-c01502549feee32c.yaml | 5 +++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/notes/deprecate-coordination-heartbeat_interval-c01502549feee32c.yaml

diff --git a/mistral/config.py b/mistral/config.py
index ba4344539..44aa25a83 100644
--- a/mistral/config.py
+++ b/mistral/config.py
@@ -579,6 +579,8 @@ coordination_opts = [
     cfg.FloatOpt(
         'heartbeat_interval',
         default=5.0,
+        deprecated_for_removal=True,
+        deprecated_reason='This option has been unused and has had no effect',
         help=_('Number of seconds between heartbeats for coordination.')
     )
 ]
diff --git a/releasenotes/notes/deprecate-coordination-heartbeat_interval-c01502549feee32c.yaml b/releasenotes/notes/deprecate-coordination-heartbeat_interval-c01502549feee32c.yaml
new file mode 100644
index 000000000..16b5ab2a1
--- /dev/null
+++ b/releasenotes/notes/deprecate-coordination-heartbeat_interval-c01502549feee32c.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``[coordination] heartbeat_interval`` option has been deprecated.
+    This option has been unused by any logic and has had no effect.