Deprecate min_pool_size option

min_pool_size option is not used,see:

https://review.opendev.org/#/c/565090/

Change-Id: I1db44b860fd1f847c90f44583e876b4f8c5b1caa
Closes-Bug: #1868511
This commit is contained in:
ZhongShengping 2020-03-25 14:53:41 +08:00
parent e30eaf73e7
commit 8937cb5f83
4 changed files with 24 additions and 15 deletions

View File

@ -12,10 +12,6 @@
# 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
# #
# [*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*] # [*database_max_pool_size*]
# Maximum number of SQL connections to keep open in a pool. # Maximum number of SQL connections to keep open in a pool.
# (Optional) Defaults to $::os_service_default # (Optional) Defaults to $::os_service_default
@ -42,25 +38,35 @@
# before error is raised. Set to -1 to specify an infinite retry count. # before error is raised. Set to -1 to specify an infinite retry count.
# Defaults to $::os_service_default # 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 ( class manila::db (
$database_connection = 'sqlite:////var/lib/manila/manila.sqlite', $database_connection = 'sqlite:////var/lib/manila/manila.sqlite',
$database_connection_recycle_time = $::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_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,
$database_db_max_retries = $::os_service_default, $database_db_max_retries = $::os_service_default,
# DEPRECATED PARAMETERS
$database_min_pool_size = undef,
) { ) {
include manila::deps 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 # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
# to use manila::<myparam> if manila::db::<myparam> isn't specified. # to use manila::<myparam> if manila::db::<myparam> isn't specified.
$database_connection_real = pick($::manila::sql_connection, $database_connection) $database_connection_real = pick($::manila::sql_connection, $database_connection)
$database_connection_recycle_time_real = pick($::manila::sql_idle_timeout, $database_connection_recycle_time) $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_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_max_retries_real = pick($::manila::database_max_retries, $database_max_retries)
$database_retry_interval_real = pick($::manila::database_retry_interval, $database_retry_interval) $database_retry_interval_real = pick($::manila::database_retry_interval, $database_retry_interval)
@ -72,7 +78,6 @@ class manila::db (
oslo::db { 'manila_config': oslo::db { 'manila_config':
connection => $database_connection_real, connection => $database_connection_real,
connection_recycle_time => $database_connection_recycle_time_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_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,

View File

@ -14,10 +14,6 @@
# (optional) Interval between retries of opening a database connection. # (optional) Interval between retries of opening a database connection.
# (Defaults to undef) # (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*] # [*database_max_pool_size*]
# (optional) Maximum number of SQL connections to keep open in a pool. # (optional) Maximum number of SQL connections to keep open in a pool.
# Defaults to undef. # Defaults to undef.
@ -220,12 +216,17 @@
# will be run through a green thread. # will be run through a green thread.
# Defaults to $::os_service_default # 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 ( class manila (
$sql_connection = undef, $sql_connection = undef,
$sql_idle_timeout = undef, $sql_idle_timeout = undef,
$database_max_retries = undef, $database_max_retries = undef,
$database_retry_interval = undef, $database_retry_interval = undef,
$database_min_pool_size = undef,
$database_max_pool_size = undef, $database_max_pool_size = undef,
$database_max_overflow = undef, $database_max_overflow = undef,
$default_transport_url = $::os_service_default, $default_transport_url = $::os_service_default,
@ -271,6 +272,8 @@ class manila (
$amqp_password = $::os_service_default, $amqp_password = $::os_service_default,
$purge_config = false, $purge_config = false,
$host = $::os_service_default, $host = $::os_service_default,
# DEPRECATED PARAMETERS
$database_min_pool_size = undef,
) { ) {
include manila::deps include manila::deps

View File

@ -0,0 +1,4 @@
---
deprecations:
- database_min_pool_size option is now deprecated for removal, the
parameter has no effect.

View File

@ -9,7 +9,6 @@ describe 'manila::db' do
:db_max_retries => '<SERVICE DEFAULT>', :db_max_retries => '<SERVICE DEFAULT>',
:connection => 'sqlite:////var/lib/manila/manila.sqlite', :connection => 'sqlite:////var/lib/manila/manila.sqlite',
:connection_recycle_time => '<SERVICE DEFAULT>', :connection_recycle_time => '<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>',
@ -23,7 +22,6 @@ describe 'manila::db' do
{ {
:database_connection => 'mysql+pymysql://manila:manila@localhost/manila', :database_connection => 'mysql+pymysql://manila:manila@localhost/manila',
:database_connection_recycle_time => '3601', :database_connection_recycle_time => '3601',
: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',
@ -39,7 +37,6 @@ describe 'manila::db' do
:db_max_retries => '-1', :db_max_retries => '-1',
:connection => 'mysql+pymysql://manila:manila@localhost/manila', :connection => 'mysql+pymysql://manila:manila@localhost/manila',
:connection_recycle_time => '3601', :connection_recycle_time => '3601',
:min_pool_size => '2',
:max_pool_size => '21', :max_pool_size => '21',
:max_retries => '11', :max_retries => '11',
:retry_interval => '11', :retry_interval => '11',