From ea60281eeea5c1d9a4dca907fe23e7880eff29f2 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Wed, 25 Mar 2020 14:53:40 +0800 Subject: [PATCH] Deprecate min_pool_size option MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit min_pool_size option is not used，see: https://review.opendev.org/#/c/565090/ Change-Id: Iadbaa88680a15687c1e4af8a28db74a0794531ea Closes-Bug: #1868511 --- manifests/db.pp | 19 ++++++++++++------- manifests/init.pp | 13 ++++++++----- ...min_pool_size-option-a91aad0abfd945f1.yaml | 4 ++++ spec/classes/aodh_db_spec.rb | 3 --- 4 files changed, 24 insertions(+), 15 deletions(-) create mode 100644 releasenotes/notes/deprecate_database_min_pool_size-option-a91aad0abfd945f1.yaml diff --git a/manifests/db.pp b/manifests/db.pp index 83926c6f..be7ce612 100644 --- a/manifests/db.pp +++ b/manifests/db.pp @@ -21,10 +21,6 @@ # Timeout when db connections should be reaped. # (Optional) Defaults to $::os_service_default. # -# [*database_min_pool_size*] -# Minimum number of SQL connections to keep open in a pool. -# (Optional) Defaults to $::os_service_default. -# # [*database_max_pool_size*] # Maximum number of SQL connections to keep open in a pool. # (Optional) Defaults to $::os_service_default. @@ -46,24 +42,34 @@ # (Optional) If set, use this value for pool_timeout with SQLAlchemy. # Defaults to $::os_service_default # +# DEPRECATED PARAMETERS +# +# [*database_min_pool_size*] +# Minimum number of SQL connections to keep open in a pool. +# (Optional) Defaults to undef. +# class aodh::db ( $database_db_max_retries = $::os_service_default, $database_connection = 'sqlite:////var/lib/aodh/aodh.sqlite', $slave_connection = $::os_service_default, $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_min_pool_size = undef, ) { include aodh::deps + if $::aodh::database_min_pool_size or $database_min_pool_size { + warning('The database_min_pool_size parameter is deprecated, and will be removed in a future release.') + } + $database_connection_real = pick($::aodh::database_connection, $database_connection) $slave_connection_real = pick($::aodh::slave_connection, $slave_connection) - $database_min_pool_size_real = pick($::aodh::database_min_pool_size, $database_min_pool_size) $database_max_pool_size_real = pick($::aodh::database_max_pool_size, $database_max_pool_size) $database_max_retries_real = pick($::aodh::database_max_retries, $database_max_retries) $database_retry_interval_real = pick($::aodh::database_retry_interval, $database_retry_interval) @@ -75,7 +81,6 @@ class aodh::db ( connection => $database_connection_real, slave_connection => $slave_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, diff --git a/manifests/init.pp b/manifests/init.pp index 21865313..f2e76cba 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -204,10 +204,6 @@ # (optional) Interval between retries of opening a database connection. # Defaults to undef. # -# [*database_min_pool_size*] -# (optional) Minimum number of SQL connections to keep open in a pool. -# Defaults to undef. -# # [*database_max_pool_size*] # (optional) Maximum number of SQL connections to keep open in a pool. # Defaults to undef. @@ -221,6 +217,12 @@ # in the aodh config. # Defaults to false. # +# DEPRECATED PARAMETERS +# +# [*database_min_pool_size*] +# (optional) Minimum number of SQL connections to keep open in a pool. +# Defaults to undef. +# class aodh ( $package_ensure = 'present', $alarm_history_time_to_live = $::os_service_default, @@ -263,12 +265,13 @@ class aodh ( $database_connection = undef, $slave_connection = undef, $database_idle_timeout = undef, - $database_min_pool_size = undef, $database_max_pool_size = undef, $database_max_retries = undef, $database_retry_interval = undef, $database_max_overflow = undef, $purge_config = false, + # DEPRECATED PARAMETERS + $database_min_pool_size = undef, ) inherits aodh::params { include aodh::deps diff --git a/releasenotes/notes/deprecate_database_min_pool_size-option-a91aad0abfd945f1.yaml b/releasenotes/notes/deprecate_database_min_pool_size-option-a91aad0abfd945f1.yaml new file mode 100644 index 00000000..03e58c2b --- /dev/null +++ b/releasenotes/notes/deprecate_database_min_pool_size-option-a91aad0abfd945f1.yaml @@ -0,0 +1,4 @@ +--- +deprecations: + - database_min_pool_size option is now deprecated for removal, the + parameter has no effect. diff --git a/spec/classes/aodh_db_spec.rb b/spec/classes/aodh_db_spec.rb index ce364290..ba09c84f 100644 --- a/spec/classes/aodh_db_spec.rb +++ b/spec/classes/aodh_db_spec.rb @@ -9,7 +9,6 @@ describe 'aodh::db' do :db_max_retries => '', :connection => 'sqlite:////var/lib/aodh/aodh.sqlite', :connection_recycle_time => '', - :min_pool_size => '', :max_pool_size => '', :max_retries => '', :retry_interval => '', @@ -25,7 +24,6 @@ describe 'aodh::db' do :database_connection => 'mysql+pymysql://aodh:aodh@localhost/aodh', :slave_connection => 'mysql+pymysql://aodh:aodh@localhost2/aodh', :database_connection_recycle_time => '3601', - :database_min_pool_size => '2', :database_max_pool_size => '11', :database_max_retries => '11', :database_retry_interval => '11', @@ -41,7 +39,6 @@ describe 'aodh::db' do :connection => 'mysql+pymysql://aodh:aodh@localhost/aodh', :slave_connection => 'mysql+pymysql://aodh:aodh@localhost2/aodh', :connection_recycle_time => '3601', - :min_pool_size => '2', :max_pool_size => '11', :max_retries => '11', :retry_interval => '11',