openstack/puppet-keystone
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: I3aae547f050b556b4213ef62f5f8b17a3154d8ec
Depends-On: https://review.opendev.org/656106/
Closes-Bug: #1826692
This commit is contained in:
ZhongShengping
2019-04-28 15:00:10 +08:00
parent 4cdcf63e5b
commit 49f89f39bd
4 changed files with 66 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
manifests/db.pp
View File

@@ -13,7 +13,7 @@
# Url used to connect to database. # Url used to connect to database.
# (Optional) Defaults to 'sqlite:////var/lib/keystone/keystone.sqlite'. # (Optional) Defaults to 'sqlite:////var/lib/keystone/keystone.sqlite'.
# #
# [*database_idle_timeout*] # [*database_connection_recycle_time*]
# Timeout when db connections should be reaped. # Timeout when db connections should be reaped.
# (Optional) Defaults to $::os_service_default # (Optional) Defaults to $::os_service_default
# #
@@ -42,24 +42,38 @@
# (Optional) If set, use this value for pool_timeout with SQLAlchemy. # (Optional) If set, use this value for pool_timeout with SQLAlchemy.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# DEPRECATED PARAMETERS
#
# [*database_idle_timeout*]
# Timeout when db connections should be reaped.
# Defaults to undef.
#
class keystone::db ( class keystone::db (
$database_db_max_retries = $::os_service_default, $database_db_max_retries = $::os_service_default,
$database_connection = 'sqlite:////var/lib/keystone/keystone.sqlite', $database_connection = 'sqlite:////var/lib/keystone/keystone.sqlite',
$database_idle_timeout = $::os_service_default, $database_connection_recycle_time = $::os_service_default,
$database_min_pool_size = $::os_service_default, $database_min_pool_size = $::os_service_default,
$database_max_pool_size = $::os_service_default, $database_max_pool_size = $::os_service_default,
$database_max_retries = $::os_service_default, $database_max_retries = $::os_service_default,
$database_retry_interval = $::os_service_default, $database_retry_interval = $::os_service_default,
$database_max_overflow = $::os_service_default, $database_max_overflow = $::os_service_default,
$database_pool_timeout = $::os_service_default, $database_pool_timeout = $::os_service_default,
# DEPRECATED PARAMETERS
$database_idle_timeout = undef,
) { ) {
include ::keystone::deps include ::keystone::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 # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
# to use keystone::<myparam> if keystone::db::<myparam> isn't specified. # to use keystone::<myparam> if keystone::db::<myparam> isn't specified.
$database_connection_real = pick($::keystone::database_connection, $database_connection) $database_connection_real = pick($::keystone::database_connection, $database_connection)
$database_idle_timeout_real = pick($::keystone::database_idle_timeout, $database_idle_timeout) $database_connection_recycle_time_real = pick($::keystone::database_idle_timeout, $database_idle_timeout,
$database_connection_recycle_time)
$database_min_pool_size_real = pick($::keystone::database_min_pool_size, $database_min_pool_size) $database_min_pool_size_real = pick($::keystone::database_min_pool_size, $database_min_pool_size)
$database_max_pool_size_real = pick($::keystone::database_max_pool_size, $database_max_pool_size) $database_max_pool_size_real = pick($::keystone::database_max_pool_size, $database_max_pool_size)
$database_max_retries_real = pick($::keystone::database_max_retries, $database_max_retries) $database_max_retries_real = pick($::keystone::database_max_retries, $database_max_retries)
@@ -70,15 +84,15 @@ class keystone::db (
['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?']) ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?'])
oslo::db { 'keystone_config': oslo::db { 'keystone_config':
db_max_retries => $database_db_max_retries, db_max_retries => $database_db_max_retries,
connection => $database_connection_real, connection => $database_connection_real,
idle_timeout => $database_idle_timeout_real, connection_recycle_time => $database_connection_recycle_time_real,
min_pool_size => $database_min_pool_size_real, min_pool_size => $database_min_pool_size_real,
max_pool_size => $database_max_pool_size_real, max_pool_size => $database_max_pool_size_real,
max_retries => $database_max_retries_real, max_retries => $database_max_retries_real,
retry_interval => $database_retry_interval_real, retry_interval => $database_retry_interval_real,
max_overflow => $database_max_overflow_real, max_overflow => $database_max_overflow_real,
pool_timeout => $database_pool_timeout, pool_timeout => $database_pool_timeout,
} }
} }

4
releasenotes/notes/deprecate_idle_timeout_parameter-bf3a271c03bb12df.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/keystone_db_spec.rb
View File

@@ -6,45 +6,45 @@ describe 'keystone::db' do
it { should contain_class('keystone::deps') } it { should contain_class('keystone::deps') }
it { should contain_oslo__db('keystone_config').with( it { should contain_oslo__db('keystone_config').with(
:db_max_retries => '<SERVICE DEFAULT>', :db_max_retries => '<SERVICE DEFAULT>',
:connection => 'sqlite:////var/lib/keystone/keystone.sqlite', :connection => 'sqlite:////var/lib/keystone/keystone.sqlite',
:idle_timeout => '<SERVICE DEFAULT>', :connection_recycle_time => '<SERVICE DEFAULT>',
:min_pool_size => '<SERVICE DEFAULT>', :min_pool_size => '<SERVICE DEFAULT>',
:max_pool_size => '<SERVICE DEFAULT>', :max_pool_size => '<SERVICE DEFAULT>',
:max_retries => '<SERVICE DEFAULT>', :max_retries => '<SERVICE DEFAULT>',
:retry_interval => '<SERVICE DEFAULT>', :retry_interval => '<SERVICE DEFAULT>',
:max_overflow => '<SERVICE DEFAULT>', :max_overflow => '<SERVICE DEFAULT>',
:pool_timeout => '<SERVICE DEFAULT>', :pool_timeout => '<SERVICE DEFAULT>',
)} )}
end end
context 'with specific parameters' do context 'with specific parameters' do
let :params do let :params do
{ {
:database_db_max_retries => '-1', :database_db_max_retries => '-1',
:database_connection => 'mysql+pymysql://keystone:keystone@localhost/keystone', :database_connection => 'mysql+pymysql://keystone:keystone@localhost/keystone',
:database_idle_timeout => '3601', :database_connection_recycle_time => '3601',
:database_min_pool_size => '2', :database_min_pool_size => '2',
:database_max_pool_size => '21', :database_max_pool_size => '21',
:database_max_retries => '11', :database_max_retries => '11',
:database_max_overflow => '21', :database_max_overflow => '21',
:database_pool_timeout => '21', :database_pool_timeout => '21',
:database_retry_interval => '11', :database_retry_interval => '11',
} }
end end
it { should contain_class('keystone::deps') } it { should contain_class('keystone::deps') }
it { should contain_oslo__db('keystone_config').with( it { should contain_oslo__db('keystone_config').with(
:db_max_retries => '-1', :db_max_retries => '-1',
:connection => 'mysql+pymysql://keystone:keystone@localhost/keystone', :connection => 'mysql+pymysql://keystone:keystone@localhost/keystone',
:idle_timeout => '3601', :connection_recycle_time => '3601',
:min_pool_size => '2', :min_pool_size => '2',
:max_pool_size => '21', :max_pool_size => '21',
:max_retries => '11', :max_retries => '11',
:retry_interval => '11', :retry_interval => '11',
:max_overflow => '21', :max_overflow => '21',
:pool_timeout => '21', :pool_timeout => '21',
)} )}
end end
end end

2
spec/classes/keystone_init_spec.rb
View File

@@ -169,7 +169,7 @@ describe 'keystone' do
end end
it 'should contain correct mysql config' do it 'should contain correct mysql config' do
is_expected.to contain_keystone_config('database/idle_timeout').with_value(param_hash['database_idle_timeout']) is_expected.to contain_keystone_config('database/connection_recycle_time').with_value(param_hash['database_idle_timeout'])
is_expected.to contain_keystone_config('database/connection').with_value(param_hash['database_connection']).with_secret(true) is_expected.to contain_keystone_config('database/connection').with_value(param_hash['database_connection']).with_secret(true)
end end