Deprecate idle_timeout option
The idle_timeout parameter is deprecated, use connection_recycle_time instead[1]. [1]https://review.opendev.org/#/c/334182/ Change-Id: I3e6de32bae1896207ff697e6f2fb7cd3e99174e6 Depends-On: https://review.opendev.org/656106/ Closes-Bug: #1826692
This commit is contained in:
ZhongShengping
parent
637b508e99
commit
2e25f8f734
@ -8,7 +8,7 @@
|
||||
# Url used to connect to database.
|
||||
# (Optional) Defaults to "sqlite:////var/lib/barbican/barbican.sqlite".
|
||||
#
|
||||
# [*database_idle_timeout*]
|
||||
# [*database_connection_recycle_time*]
|
||||
# Timeout when db connections should be reaped.
|
||||
# (Optional) Defaults to $::os_service_default
|
||||
#
|
||||
@ -52,40 +52,54 @@
|
||||
# (Optional) If set, use this value for pool_timeout with SQLAlchemy.
|
||||
# Defaults to $::os_service_default
|
||||
#
|
||||
# DEPRECATED PARAMETERS
|
||||
#
|
||||
# [*database_idle_timeout*]
|
||||
# Timeout when db connections should be reaped.
|
||||
# Defaults to undef.
|
||||
#
|
||||
class barbican::db (
|
||||
$database_connection = 'sqlite:////var/lib/barbican/barbican.sqlite',
|
||||
$database_idle_timeout = $::os_service_default,
|
||||
$database_min_pool_size = $::os_service_default,
|
||||
$database_max_pool_size = $::os_service_default,
|
||||
$database_max_retries = $::os_service_default,
|
||||
$database_retry_interval = $::os_service_default,
|
||||
$database_max_overflow = $::os_service_default,
|
||||
$database_pool_size = $::os_service_default,
|
||||
$database_db_max_retries = $::os_service_default,
|
||||
$database_pool_timeout = $::os_service_default,
|
||||
$database_connection = 'sqlite:////var/lib/barbican/barbican.sqlite',
|
||||
$database_connection_recycle_time = $::os_service_default,
|
||||
$database_min_pool_size = $::os_service_default,
|
||||
$database_max_pool_size = $::os_service_default,
|
||||
$database_max_retries = $::os_service_default,
|
||||
$database_retry_interval = $::os_service_default,
|
||||
$database_max_overflow = $::os_service_default,
|
||||
$database_pool_size = $::os_service_default,
|
||||
$database_db_max_retries = $::os_service_default,
|
||||
$database_pool_timeout = $::os_service_default,
|
||||
# DEPRECATED PARAMETERS
|
||||
$database_idle_timeout = undef,
|
||||
) {
|
||||
|
||||
include ::barbican::deps
|
||||
|
||||
if $database_idle_timeout {
|
||||
warning('The database_idle_timeout parameter is deprecated. Please use \
|
||||
database_connection_recycle_time instead.')
|
||||
}
|
||||
$database_connection_recycle_time_real = pick($database_idle_timeout, $database_connection_recycle_time)
|
||||
|
||||
validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection,
|
||||
['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?'])
|
||||
|
||||
oslo::db { 'barbican_config':
|
||||
connection => $database_connection,
|
||||
idle_timeout => $database_idle_timeout,
|
||||
min_pool_size => $database_min_pool_size,
|
||||
max_pool_size => $database_max_pool_size,
|
||||
max_retries => $database_max_retries,
|
||||
retry_interval => $database_retry_interval,
|
||||
max_overflow => $database_max_overflow,
|
||||
db_max_retries => $database_db_max_retries,
|
||||
pool_timeout => $database_pool_timeout,
|
||||
connection => $database_connection,
|
||||
connection_recycle_time => $database_connection_recycle_time_real,
|
||||
min_pool_size => $database_min_pool_size,
|
||||
max_pool_size => $database_max_pool_size,
|
||||
max_retries => $database_max_retries,
|
||||
retry_interval => $database_retry_interval,
|
||||
max_overflow => $database_max_overflow,
|
||||
db_max_retries => $database_db_max_retries,
|
||||
pool_timeout => $database_pool_timeout,
|
||||
}
|
||||
|
||||
# TODO(aschultz): Remove this config once barbican properly leverages oslo
|
||||
barbican_config {
|
||||
'DEFAULT/sql_connection': value => $database_connection, secret => true;
|
||||
'DEFAULT/sql_idle_timeout': value => $database_idle_timeout;
|
||||
'DEFAULT/sql_idle_timeout': value => $database_connection_recycle_time_real;
|
||||
'DEFAULT/sql_pool_size': value => $database_pool_size;
|
||||
'DEFAULT/sql_pool_max_overflow': value => $database_max_overflow;
|
||||
}
|
||||
|
||||
@ -0,0 +1,4 @@
|
||||
---
|
||||
deprecations:
|
||||
- database_idle_timeout is deprecated and will be removed in a future
|
||||
release. Please use database_connection_recycle_time instead.
|
||||
@ -25,15 +25,15 @@ describe 'barbican::db' do
|
||||
it { should contain_class('barbican::deps') }
|
||||
|
||||
it { should contain_oslo__db('barbican_config').with(
|
||||
:db_max_retries => '<SERVICE DEFAULT>',
|
||||
:connection => 'sqlite:////var/lib/barbican/barbican.sqlite',
|
||||
:idle_timeout => '<SERVICE DEFAULT>',
|
||||
:min_pool_size => '<SERVICE DEFAULT>',
|
||||
:max_pool_size => '<SERVICE DEFAULT>',
|
||||
:max_retries => '<SERVICE DEFAULT>',
|
||||
:retry_interval => '<SERVICE DEFAULT>',
|
||||
:max_overflow => '<SERVICE DEFAULT>',
|
||||
:pool_timeout => '<SERVICE DEFAULT>',
|
||||
:db_max_retries => '<SERVICE DEFAULT>',
|
||||
:connection => 'sqlite:////var/lib/barbican/barbican.sqlite',
|
||||
:connection_recycle_time => '<SERVICE DEFAULT>',
|
||||
:min_pool_size => '<SERVICE DEFAULT>',
|
||||
:max_pool_size => '<SERVICE DEFAULT>',
|
||||
:max_retries => '<SERVICE DEFAULT>',
|
||||
:retry_interval => '<SERVICE DEFAULT>',
|
||||
:max_overflow => '<SERVICE DEFAULT>',
|
||||
:pool_timeout => '<SERVICE DEFAULT>',
|
||||
)}
|
||||
|
||||
# TODO(aschultz): remove once oslo is properly used
|
||||
@ -46,31 +46,31 @@ describe 'barbican::db' do
|
||||
context 'with specific parameters' do
|
||||
let :params do
|
||||
{
|
||||
:database_connection => 'mysql+pymysql://barbican:barbican@localhost/barbican',
|
||||
:database_idle_timeout => '3601',
|
||||
:database_min_pool_size => '2',
|
||||
:database_max_pool_size => '11',
|
||||
:database_max_retries => '11',
|
||||
:database_retry_interval => '11',
|
||||
:database_max_overflow => '11',
|
||||
:database_pool_timeout => '11',
|
||||
:database_pool_size => '2',
|
||||
:database_db_max_retries => '-1',
|
||||
:database_connection => 'mysql+pymysql://barbican:barbican@localhost/barbican',
|
||||
:database_connection_recycle_time => '3601',
|
||||
:database_min_pool_size => '2',
|
||||
:database_max_pool_size => '11',
|
||||
:database_max_retries => '11',
|
||||
:database_retry_interval => '11',
|
||||
:database_max_overflow => '11',
|
||||
:database_pool_timeout => '11',
|
||||
:database_pool_size => '2',
|
||||
:database_db_max_retries => '-1',
|
||||
}
|
||||
end
|
||||
|
||||
it { should contain_class('barbican::deps') }
|
||||
|
||||
it { should contain_oslo__db('barbican_config').with(
|
||||
:db_max_retries => '-1',
|
||||
:connection => 'mysql+pymysql://barbican:barbican@localhost/barbican',
|
||||
:idle_timeout => '3601',
|
||||
:min_pool_size => '2',
|
||||
:max_pool_size => '11',
|
||||
:max_retries => '11',
|
||||
:retry_interval => '11',
|
||||
:max_overflow => '11',
|
||||
:pool_timeout => '11',
|
||||
:db_max_retries => '-1',
|
||||
:connection => 'mysql+pymysql://barbican:barbican@localhost/barbican',
|
||||
:connection_recycle_time => '3601',
|
||||
:min_pool_size => '2',
|
||||
:max_pool_size => '11',
|
||||
:max_retries => '11',
|
||||
:retry_interval => '11',
|
||||
:max_overflow => '11',
|
||||
:pool_timeout => '11',
|
||||
)}
|
||||
|
||||
# TODO(aschultz) remove once oslo is properly used
|
||||
|
||||
Loading…
Reference in New Issue
Block a user