Deprecate support for [coordination] heartbeat_interval

This option hasn't been unused by Mistral and was formally deprecated
during this cycle.

Depends-on: https://review.opendev.org/877936
Change-Id: If6aa337cdd0f932b0cf0aaee14aa04bd36701076

manifests/coordination.pp

@@ -8,23 +8,30 @@
 #   (Optional) Coordination backend URL.
 #   Defaults to $facts['os_service_default']
 #
+# DEPRECATED PARAMETERS
+#
 # [*heartbeat_interval*]
 #   (Optional) Number of seconds between heartbeats for coordination.
-#   Defaults to $facts['os_service_default']
+#   Defaults to undef
 #
 class mistral::coordination (
   $backend_url        = $facts['os_service_default'],
-  $heartbeat_interval = $facts['os_service_default'],
+  # DEPRECATED PARAMETERS
+  $heartbeat_interval = undef,
 ) {
 
   include mistral::deps
 
+  if $heartbeat_interval != undef {
+    warning('The heartbeat_interval parameter has been deprecated and has no effect.')
+  }
+
   oslo::coordination{ 'mistral_config':
     backend_url => $backend_url
   }
 
   mistral_config {
-    'coordination/heartbeat_interval': value => $heartbeat_interval;
+    'coordination/heartbeat_interval': ensure => absent;
   }
 
   # all coordination settings should be applied and all packages should be

releasenotes/notes/deprecate-coordination-heartbeat_interval-37a35124e18bd918.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    The ``mistral::coordination::heartbeat_interval`` parameter has been
+    deprecated and has no effect now.

spec/classes/mistral_coordination_spec.rb

@@ -7,15 +7,13 @@ describe 'mistral::coordination' do
         is_expected.to contain_oslo__coordination('mistral_config').with(
           :backend_url => '<SERVICE DEFAULT>'
         )
-        is_expected.to contain_mistral_config('coordination/heartbeat_interval').with_value('<SERVICE DEFAULT>')
       }
     end
 
     context 'with specified parameters' do
       let :params do
         {
-          :backend_url        => 'etcd3+http://127.0.0.1:2379',
-          :heartbeat_interval => 5.0,
+          :backend_url => 'etcd3+http://127.0.0.1:2379',
         }
       end
 
@@ -23,7 +21,6 @@ describe 'mistral::coordination' do
         is_expected.to contain_oslo__coordination('mistral_config').with(
           :backend_url => 'etcd3+http://127.0.0.1:2379'
         )
-        is_expected.to contain_mistral_config('coordination/heartbeat_interval').with_value(5.0)
       }
     end
   end