Deprecate rabbit_max_retries option

Option "rabbit_max_retries" from group "oslo_messaging_rabbit" is
deprecated for removal. Its value may be silently ignored in the future.

Change-Id: Ic8c80fc12922c059f21e2411e9ef6a09b027bb65
Closes-Bug: #1697350

manifests/init.pp

@@ -148,10 +148,6 @@
 #   (Optional) Backoff between reconnection attempts for rabbit.
 #   Defaults to $::os_service_default.
 #
-# [*rabbit_max_retries*]
-#   (Optional) Number of times to retry (0 == no limit).
-#   Defaults to $::os_service_default.
-#
 # [*zeromq_bind_address*]
 #   (Optional) Bind address; wildcard, ethernet, or ip address.
 #   Defaults to $::os_service_default.
@@ -337,6 +333,10 @@
 #   undefined, tokens will instead be cached in-process.
 #   Defaults to undef.
 #
+# [*rabbit_max_retries*]
+#   (Optional) Number of times to retry (0 == no limit).
+#   Defaults to undef.
+#
 class sahara(
   $package_ensure              = 'present',
   $debug                       = undef,
@@ -371,7 +371,6 @@ class sahara(
   $rabbit_login_method         = $::os_service_default,
   $rabbit_retry_interval       = $::os_service_default,
   $rabbit_retry_backoff        = $::os_service_default,
-  $rabbit_max_retries          = $::os_service_default,
   $zeromq_bind_address         = $::os_service_default,
   $zeromq_contexts             = $::os_service_default,
   $zeromq_topic_backlog        = $::os_service_default,
@@ -416,6 +415,7 @@ class sahara(
   $auth_uri                    = undef,
   $identity_uri                = undef,
   $memcached_servers           = undef,
+  $rabbit_max_retries          = undef,
 ) {
 
   include ::sahara::deps
@@ -424,6 +424,10 @@ class sahara(
   include ::sahara::db
   include ::sahara::policy
 
+  if $rabbit_max_retries {
+    warning('The rabbit_max_retries parameter has been deprecated and will be removed in the future release.')
+  }
+
   if !is_service_default($rabbit_host) or
     !is_service_default($rabbit_hosts) or
     !is_service_default($rabbit_password) or
@@ -493,7 +497,6 @@ deprecated. Please use sahara::keystone::authtoken::* parameters instead.")
       rabbit_login_method     => $rabbit_login_method,
       rabbit_retry_interval   => $rabbit_retry_interval,
       rabbit_retry_backoff    => $rabbit_retry_backoff,
-      rabbit_max_retries      => $rabbit_max_retries,
     }
   }
 

releasenotes/notes/deprecate_rabbit_max_retries-172913e235f23547.yaml

@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The configuration option ``rabbit_max_retries`` is now deprecated and
+    will be removed in the future.