From 8937cb5f834385f939071b4b26e237000a1bb5e6 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Wed, 25 Mar 2020 14:53:41 +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: I1db44b860fd1f847c90f44583e876b4f8c5b1caa Closes-Bug: #1868511 --- manifests/db.pp | 19 ++++++++++++------- manifests/init.pp | 13 ++++++++----- ...min_pool_size-option-a8a1e54331198674.yaml | 4 ++++ spec/classes/manila_db_spec.rb | 3 --- 4 files changed, 24 insertions(+), 15 deletions(-) create mode 100644 releasenotes/notes/deprecate_database_min_pool_size-option-a8a1e54331198674.yaml diff --git a/manifests/db.pp b/manifests/db.pp index 9739b087..9032be48 100644 --- a/manifests/db.pp +++ b/manifests/db.pp @@ -12,10 +12,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 @@ -42,25 +38,35 @@ # before error is raised. Set to -1 to specify an infinite retry count. # 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 manila::db ( $database_connection = 'sqlite:////var/lib/manila/manila.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, $database_db_max_retries = $::os_service_default, + # DEPRECATED PARAMETERS + $database_min_pool_size = undef, ) { include manila::deps + if $::manila::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.') + } + # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function # to use manila:: if manila::db:: isn't specified. $database_connection_real = pick($::manila::sql_connection, $database_connection) $database_connection_recycle_time_real = pick($::manila::sql_idle_timeout, $database_connection_recycle_time) - $database_min_pool_size_real = pick($::manila::database_min_pool_size, $database_min_pool_size) $database_max_pool_size_real = pick($::manila::database_max_pool_size, $database_max_pool_size) $database_max_retries_real = pick($::manila::database_max_retries, $database_max_retries) $database_retry_interval_real = pick($::manila::database_retry_interval, $database_retry_interval) @@ -72,7 +78,6 @@ class manila::db ( oslo::db { 'manila_config': 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, diff --git a/manifests/init.pp b/manifests/init.pp index 1e3d3246..e2ee273d 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -14,10 +14,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. @@ -220,12 +216,17 @@ # will be run through a green thread. # Defaults to $::os_service_default # +# DEPRECATED PARAMETERS +# +# [*database_min_pool_size*] +# (optional) Minimum number of SQL connections to keep open in a pool. +# Defaults to undef. +# class manila ( $sql_connection = undef, $sql_idle_timeout = undef, $database_max_retries = undef, $database_retry_interval = undef, - $database_min_pool_size = undef, $database_max_pool_size = undef, $database_max_overflow = undef, $default_transport_url = $::os_service_default, @@ -271,6 +272,8 @@ class manila ( $amqp_password = $::os_service_default, $purge_config = false, $host = $::os_service_default, + # DEPRECATED PARAMETERS + $database_min_pool_size = undef, ) { include manila::deps diff --git a/releasenotes/notes/deprecate_database_min_pool_size-option-a8a1e54331198674.yaml b/releasenotes/notes/deprecate_database_min_pool_size-option-a8a1e54331198674.yaml new file mode 100644 index 00000000..03e58c2b --- /dev/null +++ b/releasenotes/notes/deprecate_database_min_pool_size-option-a8a1e54331198674.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/manila_db_spec.rb b/spec/classes/manila_db_spec.rb index 7d08bb6a..bfb17de5 100644 --- a/spec/classes/manila_db_spec.rb +++ b/spec/classes/manila_db_spec.rb @@ -9,7 +9,6 @@ describe 'manila::db' do :db_max_retries => '', :connection => 'sqlite:////var/lib/manila/manila.sqlite', :connection_recycle_time => '', - :min_pool_size => '', :max_pool_size => '', :max_retries => '', :retry_interval => '', @@ -23,7 +22,6 @@ describe 'manila::db' do { :database_connection => 'mysql+pymysql://manila:manila@localhost/manila', :database_connection_recycle_time => '3601', - :database_min_pool_size => '2', :database_max_pool_size => '21', :database_max_retries => '11', :database_max_overflow => '21', @@ -39,7 +37,6 @@ describe 'manila::db' do :db_max_retries => '-1', :connection => 'mysql+pymysql://manila:manila@localhost/manila', :connection_recycle_time => '3601', - :min_pool_size => '2', :max_pool_size => '21', :max_retries => '11', :retry_interval => '11',