diff --git a/manifests/messaging/rabbit.pp b/manifests/messaging/rabbit.pp index 1003858..ef20293 100644 --- a/manifests/messaging/rabbit.pp +++ b/manifests/messaging/rabbit.pp @@ -105,10 +105,6 @@ # (Optional) Maximum interval of RabbitMQ connection retries. (integer value) # Defaults to $::os_service_default # -# [*rabbit_max_retries*] -# (Optional) Maximum number of RabbitMQ connection retries. (integer value) -# Defaults to $::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. (boolean value) @@ -133,7 +129,12 @@ # we check the heartbeat. (integer value) # Defaults to $::os_service_default # - +# DEPRECATED PARAMETERS +# +# [*rabbit_max_retries*] +# (Optional) Maximum number of RabbitMQ connection retries. (integer value) +# Defaults to undef +# define oslo::messaging::rabbit( $amqp_durable_queues = $::os_service_default, $kombu_ssl_version = $::os_service_default, @@ -156,11 +157,12 @@ define oslo::messaging::rabbit( $rabbit_retry_interval = $::os_service_default, $rabbit_retry_backoff = $::os_service_default, $rabbit_interval_max = $::os_service_default, - $rabbit_max_retries = $::os_service_default, $rabbit_ha_queues = $::os_service_default, $rabbit_transient_queues_ttl = $::os_service_default, $heartbeat_timeout_threshold = $::os_service_default, $heartbeat_rate = $::os_service_default, + # DEPRECATED PARAMETERS + $rabbit_max_retries = undef, ){ if $rabbit_use_ssl != true { @@ -178,6 +180,10 @@ define oslo::messaging::rabbit( } } + 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($kombu_compression) and !($kombu_compression in ['gzip','bz2']) { fail('Unsupported Kombu compression. Possible values are gzip and bz2') } @@ -215,7 +221,6 @@ rabbit_password, rabbit_virtual_host parameters have been deprecated by the \ 'oslo_messaging_rabbit/kombu_reconnect_delay' => { value => $kombu_reconnect_delay }, 'oslo_messaging_rabbit/rabbit_interval_max' => { value => $rabbit_interval_max }, 'oslo_messaging_rabbit/rabbit_login_method' => { value => $rabbit_login_method }, - 'oslo_messaging_rabbit/rabbit_max_retries' => { value => $rabbit_max_retries }, 'oslo_messaging_rabbit/rabbit_password' => { value => $rabbit_password, secret => true }, 'oslo_messaging_rabbit/rabbit_retry_backoff' => { value => $rabbit_retry_backoff }, 'oslo_messaging_rabbit/rabbit_retry_interval' => { value => $rabbit_retry_interval }, diff --git a/releasenotes/notes/deprecate_rabbit_max_retries-813a568923f2335d.yaml b/releasenotes/notes/deprecate_rabbit_max_retries-813a568923f2335d.yaml new file mode 100644 index 0000000..2337f97 --- /dev/null +++ b/releasenotes/notes/deprecate_rabbit_max_retries-813a568923f2335d.yaml @@ -0,0 +1,5 @@ +--- +deprecations: + - | + The configuration option ``rabbit_max_retries`` is now deprecated and + will be removed in the future. diff --git a/spec/defines/oslo_messaging_rabbit_spec.rb b/spec/defines/oslo_messaging_rabbit_spec.rb index 43f118d..67c73e2 100644 --- a/spec/defines/oslo_messaging_rabbit_spec.rb +++ b/spec/defines/oslo_messaging_rabbit_spec.rb @@ -25,7 +25,6 @@ describe 'oslo::messaging::rabbit' do is_expected.to contain_keystone_config('oslo_messaging_rabbit/rabbit_retry_interval').with_value('') is_expected.to contain_keystone_config('oslo_messaging_rabbit/rabbit_retry_backoff').with_value('') is_expected.to contain_keystone_config('oslo_messaging_rabbit/rabbit_interval_max').with_value('') - is_expected.to contain_keystone_config('oslo_messaging_rabbit/rabbit_max_retries').with_value('') is_expected.to contain_keystone_config('oslo_messaging_rabbit/rabbit_ha_queues').with_value('') is_expected.to contain_keystone_config('oslo_messaging_rabbit/rabbit_transient_queues_ttl').with_value('') is_expected.to contain_keystone_config('oslo_messaging_rabbit/heartbeat_timeout_threshold').with_value('')