openstack/puppet-cinder
Code Issues Proposed changes

Deprecate idle_timeout option

Browse Source 
The idle_timeout parameter is deprecated, use connection_recycle_time
instead[1].

[1]https://review.opendev.org/#/c/334182/

Change-Id: I71d8829b17007a56d1310e401def7894f33f0e14
Depends-On: https://review.opendev.org/656106/
Closes-Bug: #1826692
This commit is contained in:
ZhongShengping 2019-04-28 15:00:06 +08:00
parent 268fa768d2
commit a933deb802
3 changed files with 70 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
manifests/db.pp
View File

@ -13,7 +13,7 @@
# Url used to connect to database.
# (Optional) Defaults to 'sqlite:////var/lib/cinder/cinder.sqlite'
#
# [*database_idle_timeout*]
# [*database_connection_recycle_time*]
# Timeout when db connections should be reaped.
# (Optional) Defaults to $::os_service_default
#
@ -42,42 +42,55 @@
# (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 cinder::db (
$database_db_max_retries = $::os_service_default,
$database_connection = 'sqlite:////var/lib/cinder/cinder.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_timeout = $::os_service_default,
$database_db_max_retries = $::os_service_default,
$database_connection = 'sqlite:////var/lib/cinder/cinder.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_timeout = $::os_service_default,
# DEPRECATED PARAMETERS
$database_idle_timeout = undef,
) {
include ::cinder::deps
if $database_idle_timeout {
warning('The database_idle_timeout parameter is deprecated. Please use \
database_connection_recycle_time instead.')
}
# NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
# to use cinder::<myparam> if cinder::db::<myparam> isn't specified.
$database_connection_real = pick($::cinder::database_connection,$database_connection)
$database_idle_timeout_real = pick($::cinder::database_idle_timeout,$database_idle_timeout)
$database_min_pool_size_real = pick($::cinder::database_min_pool_size,$database_min_pool_size)
$database_max_pool_size_real = pick($::cinder::database_max_pool_size,$database_max_pool_size)
$database_max_retries_real = pick($::cinder::database_max_retries,$database_max_retries)
$database_retry_interval_real = pick($::cinder::database_retry_interval,$database_retry_interval)
$database_max_overflow_real = pick($::cinder::database_max_overflow,$database_max_overflow)
$database_connection_real = pick($::cinder::database_connection,$database_connection)
$database_connection_recycle_time_real = pick($::cinder::database_idle_timeout, $database_idle_timeout, $database_connection_recycle_time)
$database_min_pool_size_real = pick($::cinder::database_min_pool_size,$database_min_pool_size)
$database_max_pool_size_real = pick($::cinder::database_max_pool_size,$database_max_pool_size)
$database_max_retries_real = pick($::cinder::database_max_retries,$database_max_retries)
$database_retry_interval_real = pick($::cinder::database_retry_interval,$database_retry_interval)
$database_max_overflow_real = pick($::cinder::database_max_overflow,$database_max_overflow)
validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection_real,
['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?'])
oslo::db { 'cinder_config':
db_max_retries => $database_db_max_retries,
connection => $database_connection_real,
idle_timeout => $database_idle_timeout_real,
min_pool_size => $database_min_pool_size_real,
max_pool_size => $database_max_pool_size_real,
max_retries => $database_max_retries_real,
retry_interval => $database_retry_interval_real,
max_overflow => $database_max_overflow_real,
pool_timeout => $database_pool_timeout,
db_max_retries => $database_db_max_retries,
connection => $database_connection_real,
connection_recycle_time => $database_connection_recycle_time_real,
min_pool_size => $database_min_pool_size_real,
max_pool_size => $database_max_pool_size_real,
max_retries => $database_max_retries_real,
retry_interval => $database_retry_interval_real,
max_overflow => $database_max_overflow_real,
pool_timeout => $database_pool_timeout,
}
}

4
releasenotes/notes/deprecate_idle_timeout_parameter-9c3ffa59d2ddb8b3.yaml Normal file
View File

@ -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.

54
spec/classes/cinder_db_spec.rb
View File

@ -6,45 +6,45 @@ describe 'cinder::db' do
it { is_expected.to contain_class('cinder::deps') }
it { is_expected.to contain_oslo__db('cinder_config').with(
:db_max_retries => '<SERVICE DEFAULT>',
:connection => 'sqlite:////var/lib/cinder/cinder.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/cinder/cinder.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>',
)}
end
context 'with specific parameters' do
let :params do
{
:database_db_max_retries => '-1',
:database_connection => 'mysql+pymysql://cinder:cinder@localhost/cinder',
: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 => '21',
:database_pool_timeout => '21',
:database_db_max_retries => '-1',
:database_connection => 'mysql+pymysql://cinder:cinder@localhost/cinder',
: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 => '21',
:database_pool_timeout => '21',
}
end
it { is_expected.to contain_class('cinder::deps') }
it { is_expected.to contain_oslo__db('cinder_config').with(
:db_max_retries => '-1',
:connection => 'mysql+pymysql://cinder:cinder@localhost/cinder',
:idle_timeout => '3601',
:min_pool_size => '2',
:max_pool_size => '11',
:max_retries => '11',
:retry_interval => '11',
:max_overflow => '21',
:pool_timeout => '21',
:db_max_retries => '-1',
:connection => 'mysql+pymysql://cinder:cinder@localhost/cinder',
:connection_recycle_time => '3601',
:min_pool_size => '2',
:max_pool_size => '11',
:max_retries => '11',
:retry_interval => '11',
:max_overflow => '21',
:pool_timeout => '21',
)}
end
end