From a5010d2c4704a50c5c793a2d231c3f2fd400013d Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Sun, 28 Apr 2019 15:00:14 +0800 Subject: [PATCH] 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: I3fc4376ba89ceb0ec26e67cde3746dae00c31b64 Depends-On: https://review.opendev.org/656106/ Closes-Bug: #1826692 --- manifests/db.pp | 52 +++++++++++------- ...le_timeout_parameter-930ece6871e4ce09.yaml | 4 ++ spec/classes/vitrage_db_spec.rb | 54 +++++++++---------- 3 files changed, 64 insertions(+), 46 deletions(-) create mode 100644 releasenotes/notes/deprecate_idle_timeout_parameter-930ece6871e4ce09.yaml diff --git a/manifests/db.pp b/manifests/db.pp index 47d0a90..81ad887 100644 --- a/manifests/db.pp +++ b/manifests/db.pp @@ -18,7 +18,7 @@ # before error is raised. Set to -1 to specify an infinite retry count. # Defaults to $::os_service_default # -# [*database_idle_timeout*] +# [*database_connection_recycle_time*] # (Optional) Timeout before idle SQL connections are reaped. # Defaults to $::os_service_default. # @@ -42,33 +42,47 @@ # (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 vitrage::db ( - $database_connection = 'mysql+pymysql://vitrage:secrete@localhost:3306/vitrage', - $database_idle_timeout = $::os_service_default, - $database_min_pool_size = $::os_service_default, - $database_max_pool_size = $::os_service_default, - $database_db_max_retries = $::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_connection = 'mysql+pymysql://vitrage:secrete@localhost:3306/vitrage', + $database_connection_recycle_time = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_db_max_retries = $::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 ::vitrage::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 { 'vitrage_config': - connection => $database_connection, - idle_timeout => $database_idle_timeout, - min_pool_size => $database_min_pool_size, - max_pool_size => $database_max_pool_size, - db_max_retries => $database_db_max_retries, - max_retries => $database_max_retries, - retry_interval => $database_retry_interval, - max_overflow => $database_max_overflow, - 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, + db_max_retries => $database_db_max_retries, + max_retries => $database_max_retries, + retry_interval => $database_retry_interval, + max_overflow => $database_max_overflow, + pool_timeout => $database_pool_timeout, } } diff --git a/releasenotes/notes/deprecate_idle_timeout_parameter-930ece6871e4ce09.yaml b/releasenotes/notes/deprecate_idle_timeout_parameter-930ece6871e4ce09.yaml new file mode 100644 index 0000000..09e76c4 --- /dev/null +++ b/releasenotes/notes/deprecate_idle_timeout_parameter-930ece6871e4ce09.yaml @@ -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. diff --git a/spec/classes/vitrage_db_spec.rb b/spec/classes/vitrage_db_spec.rb index 01a2a3a..476cadc 100644 --- a/spec/classes/vitrage_db_spec.rb +++ b/spec/classes/vitrage_db_spec.rb @@ -6,45 +6,45 @@ describe 'vitrage::db' do it { should contain_class('vitrage::deps') } it { is_expected.to contain_oslo__db('vitrage_config').with( - :db_max_retries => '', - :connection => 'mysql+pymysql://vitrage:secrete@localhost:3306/vitrage', - :idle_timeout => '', - :min_pool_size => '', - :max_pool_size => '', - :max_retries => '', - :retry_interval => '', - :max_overflow => '', - :pool_timeout => '', + :db_max_retries => '', + :connection => 'mysql+pymysql://vitrage:secrete@localhost:3306/vitrage', + :connection_recycle_time => '', + :min_pool_size => '', + :max_pool_size => '', + :max_retries => '', + :retry_interval => '', + :max_overflow => '', + :pool_timeout => '', )} end context 'with specific parameters' do let :params do { - :database_connection => 'mysql+pymysql://vitrage:vitrage@localhost/vitrage', - :database_idle_timeout => '3601', - :database_min_pool_size => '2', - :database_db_max_retries => '-1', - :database_max_retries => '11', - :database_retry_interval => '11', - :database_max_pool_size => '11', - :database_max_overflow => '21', - :database_pool_timeout => '21', + :database_connection => 'mysql+pymysql://vitrage:vitrage@localhost/vitrage', + :database_connection_recycle_time => '3601', + :database_min_pool_size => '2', + :database_db_max_retries => '-1', + :database_max_retries => '11', + :database_retry_interval => '11', + :database_max_pool_size => '11', + :database_max_overflow => '21', + :database_pool_timeout => '21', } end it { should contain_class('vitrage::deps') } it { is_expected.to contain_oslo__db('vitrage_config').with( - :db_max_retries => '-1', - :connection => 'mysql+pymysql://vitrage:vitrage@localhost/vitrage', - :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://vitrage:vitrage@localhost/vitrage', + :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