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: I0a98136f6fb4579cbf4d609b3ee495da208a41eb
Closes-Bug: #1697350
This commit is contained in:
ZhongShengping 2017-06-12 13:54:31 +08:00
parent 12aed91f42
commit 0f9cd7bc74
3 changed files with 14 additions and 8 deletions

View File

@ -55,10 +55,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_use_ssl*]
# (optional) Connect over SSL for RabbitMQ.
# Defaults to $::os_service_default
@ -306,6 +302,10 @@
# (optional) Whether the watcher api package will be installed
# Defaults to undef
#
# [*rabbit_max_retries*]
# (Optional) Maximum number of RabbitMQ connection retries. (integer value)
# Defaults to undef
#
# === Authors
#
# Daniel Pawlik <daniel.pawlik@corp.ovh.com>
@ -324,7 +324,6 @@ class watcher (
$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_use_ssl = $::os_service_default,
$rabbit_heartbeat_rate = $::os_service_default,
$rabbit_ha_queues = $::os_service_default,
@ -380,6 +379,7 @@ class watcher (
$notification_topics = $::os_service_default,
# DEPRECATED PARAMETERS
$ensure_package = undef,
$rabbit_max_retries = undef,
) {
include ::openstacklib::openstackclient
@ -398,6 +398,10 @@ the future release. Please use watcher::package_ensure instead.")
$package_ensure_real = $package_ensure
}
if $rabbit_max_retries {
warning('The rabbit_max_retries parameter has been deprecated and will be removed in the future release.')
}
package { 'watcher':
ensure => $package_ensure_real,
name => $::watcher::params::common_package_name,
@ -433,7 +437,6 @@ the future release. Please use watcher::package_ensure instead.")
rabbit_retry_interval => $rabbit_retry_interval,
rabbit_retry_backoff => $rabbit_retry_backoff,
rabbit_interval_max => $rabbit_interval_max,
rabbit_max_retries => $rabbit_max_retries,
rabbit_ha_queues => $rabbit_ha_queues,
rabbit_transient_queues_ttl => $rabbit_transient_queues_ttl,
heartbeat_timeout_threshold => $rabbit_heartbeat_timeout_threshold,

View File

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

View File

@ -34,7 +34,6 @@ describe 'watcher' do
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_retry_interval').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_retry_backoff').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_interval_max').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_max_retries').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_transient_queues_ttl').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/heartbeat_timeout_threshold').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/heartbeat_rate').with_value('<SERVICE DEFAULT>')
@ -77,7 +76,6 @@ describe 'watcher' do
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_retry_interval').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_retry_backoff').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_interval_max').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_max_retries').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/rabbit_transient_queues_ttl').with_value('<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('oslo_messaging_rabbit/kombu_compression').with_value('gzip')
end