Deprecate spare_amphorae_pool_size

In octavia::housekeeping class the spare pool size variable
is misspelled and has no effect.  A new parameter has been
added with the correct spelling. The configuration option
in octavia conf is now correctly configured.

Change-Id: I1d72117dfa13c546e3b27ba67fb9e735d0f3b2f3
(cherry picked from commit 6a8720da4f)
This commit is contained in:
Matthew J. Black 2019-06-28 14:25:07 -04:00 committed by Carlos Goncalves
parent 381f1a34da
commit e871346bf0
3 changed files with 25 additions and 7 deletions

View File

@ -18,8 +18,8 @@
# (optional) spare check interval in seconds.
# Defaults to $::os_service_default
#
# [*spare_amphorae_pool_size*]
# (optional) Number of spare amphorae.
# [*spare_amphora_pool_size*]
# (optional) Number of spare amphora.
# Defaults to $::os_service_default
#
# [*cleanup_interval*]
@ -46,22 +46,36 @@
# (optional) Number of threads performing amphora certificate rotation.
# Defaults to $::os_service_default
#
# DEPRECATED PARAMETERS
#
# [*spare_amphorae_pool_size*]
# (optional) Number of spare amphorae.
# Defaults to $::os_service_default
#
class octavia::housekeeping (
$manage_service = true,
$enabled = true,
$package_ensure = 'present',
$spare_check_interval = $::os_service_default,
$spare_amphorae_pool_size = $::os_service_default,
$spare_amphora_pool_size = $::os_service_default,
$cleanup_interval = $::os_service_default,
$amphora_expiry_age = $::os_service_default,
$load_balancer_expiry_age = $::os_service_default,
$cert_interval = $::os_service_default,
$cert_expiry_buffer = $::os_service_default,
$cert_rotate_threads = $::os_service_default,
# DEPRECATED PARAMETERS
$spare_amphorae_pool_size = undef
) inherits octavia::params {
include ::octavia::deps
if $spare_amphorae_pool_size {
warning('spare_amphorae_pool_size is deprecated and will be removed in the future. Please use spare_amphora_pool_size.')
}
$spare_amphora_pool_size_real = pick($spare_amphorae_pool_size, $spare_amphora_pool_size)
package { 'octavia-housekeeping':
ensure => $package_ensure,
name => $::octavia::params::housekeeping_package_name,
@ -87,7 +101,7 @@ class octavia::housekeeping (
octavia_config {
'house_keeping/spare_check_interval' : value => $spare_check_interval;
'house_keeping/spare_amphorae_pool_size' : value => $spare_amphorae_pool_size;
'house_keeping/spare_amphora_pool_size' : value => $spare_amphora_pool_size_real;
'house_keeping/cleanup_interval' : value => $cleanup_interval;
'house_keeping/amphora_expiry_age' : value => $amphora_expiry_age;
'house_keeping/load_balancer_expiry_age' : value => $load_balancer_expiry_age;

View File

@ -0,0 +1,4 @@
---
deprecations:
- octavia::housekeeping::spare_amphorae_pool_size is deprecated and will be removed in the future release.
Please use octavia::housekeeping::spare_amphora_pool_size instead.

View File

@ -20,7 +20,7 @@ describe 'octavia::housekeeping' do
end
context 'check parameters with defaults' do
['spare_check_interval', 'spare_amphorae_pool_size', 'cleanup_interval',
['spare_check_interval', 'spare_amphora_pool_size', 'cleanup_interval',
'amphora_expiry_age', 'load_balancer_expiry_age', 'cert_interval',
'cert_expiry_buffer', 'cert_rotate_threads'].each do |param_with_default|
it { is_expected.to contain_octavia_config("house_keeping/#{param_with_default}").with_value('<SERVICE DEFAULT>') }
@ -29,7 +29,7 @@ describe 'octavia::housekeeping' do
let :default_parameters do
{ :spare_check_interval => 60,
:spare_amphorae_pool_size => 20,
:spare_amphora_pool_size => 20,
:cleanup_interval => 26,
:amphora_expiry_age => 200000,
:load_balancer_expiry_age => 23131,
@ -43,7 +43,7 @@ describe 'octavia::housekeeping' do
before :each do
params.merge!(default_parameters)
end
['spare_check_interval', 'spare_amphorae_pool_size', 'cleanup_interval',
['spare_check_interval', 'spare_amphora_pool_size', 'cleanup_interval',
'amphora_expiry_age', 'load_balancer_expiry_age', 'cert_interval',
'cert_expiry_buffer', 'cert_rotate_threads'].each do |param_with_default|
it { is_expected.to contain_octavia_config("house_keeping/#{param_with_default}").with_value(default_parameters[param_with_default.to_sym]) }