Deprecate parameters for the Spares Pool feature

The Spares Pool feature of Octavia was deprecated in Octavia during V
cycle and will be removed in X cycle[1].

[1] 29a2ec7187ff5607a7fb3700a53c6524c4153396

Change-Id: I45551178adc7dbea35ffe3acde0c31f3ec3c33c9
This commit is contained in:
Takashi Kajinami 2020-12-29 12:43:58 +09:00
parent 4bafdba2a3
commit 46cffbd1e9
2 changed files with 44 additions and 22 deletions

View File

@ -14,14 +14,6 @@
# (optional) ensure state for package.
# Defaults to 'present'
#
# [*spare_check_interval*]
# (optional) spare check interval in seconds.
# Defaults to $::os_service_default
#
# [*spare_amphora_pool_size*]
# (optional) Number of spare amphora.
# Defaults to $::os_service_default
#
# [*cleanup_interval*]
# (optional) DB cleanup interval in seconds.
# Defaults to $::os_service_default
@ -48,16 +40,18 @@
#
# DEPRECATED PARAMETERS
#
# [*spare_amphorae_pool_size*]
# (optional) Number of spare amphorae.
# Defaults to $::os_service_default
# [*spare_check_interval*]
# (optional) spare check interval in seconds.
# Defaults to undef
#
# [*spare_amphora_pool_size*]
# (optional) Number of spare amphora.
# Defaults to undef
#
class octavia::housekeeping (
$manage_service = true,
$enabled = true,
$package_ensure = 'present',
$spare_check_interval = $::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,
@ -65,17 +59,12 @@ class octavia::housekeeping (
$cert_expiry_buffer = $::os_service_default,
$cert_rotate_threads = $::os_service_default,
# DEPRECATED PARAMETERS
$spare_amphorae_pool_size = undef
$spare_check_interval = undef,
$spare_amphora_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,
@ -100,8 +89,6 @@ class octavia::housekeeping (
}
octavia_config {
'house_keeping/spare_check_interval' : value => $spare_check_interval;
'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;
@ -109,4 +96,26 @@ class octavia::housekeeping (
'house_keeping/cert_expiry_buffer' : value => $cert_expiry_buffer;
'house_keeping/cert_rotate_threads' : value => $cert_rotate_threads;
}
if $spare_check_interval != undef {
warning('The spare_check_interval is deprecated and will be removed in a future release')
octavia_config {
'house_keeping/spare_check_interval': value => $spare_check_interval;
}
} else {
octavia_config {
'house_keeping/spare_check_interval': value => $::os_service_default;
}
}
if $spare_amphora_pool_size != undef {
warning('The spare_amphora_pool_size is deprecated and will be removed in a future release')
octavia_config {
'house_keeping/spare_amphora_pool_size' : value => $spare_amphora_pool_size;
}
} else {
octavia_config {
'house_keeping/spare_amphora_pool_size' : value => $::os_service_default;
}
}
}

View File

@ -0,0 +1,13 @@
---
deprecations:
- |
The following parameters in the ``octavia::housekeeping`` class have been
deprecated and will be removed in a future release.
- ``spare_check_interval``
- ``spare_amphora_pool_size``
upgrade:
- |
The ``octavia::housekeeping::spare_amphorae_pool_size`` parameter has been
removed.