Deprecate min_pool_size option

min_pool_size option is not used,see:

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

Change-Id: I401cc6abb1bd5f82f27ab76492f689d9b20bcacc
Closes-Bug: #1868511
This commit is contained in:
ZhongShengping 2020-03-25 14:53:40 +08:00
parent 63bdd77fe5
commit 7fb0d9b767
4 changed files with 24 additions and 15 deletions

View File

@ -17,10 +17,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 @@
# (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_min_pool_size*]
# Minimum number of SQL connections to keep open in a pool.
# (Optional) Defaults to undef
#
class cinder::db ( class cinder::db (
$database_db_max_retries = $::os_service_default, $database_db_max_retries = $::os_service_default,
$database_connection = 'sqlite:////var/lib/cinder/cinder.sqlite', $database_connection = 'sqlite:////var/lib/cinder/cinder.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,
# DEPRECATED PARAMETERS
$database_min_pool_size = undef,
) { ) {
include cinder::deps include cinder::deps
if $::cinder::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 cinder::<myparam> if cinder::db::<myparam> isn't specified. # to use cinder::<myparam> if cinder::db::<myparam> isn't specified.
$database_connection_real = pick($::cinder::database_connection,$database_connection) $database_connection_real = pick($::cinder::database_connection,$database_connection)
$database_connection_recycle_time_real = pick($::cinder::database_idle_timeout, $database_connection_recycle_time) $database_connection_recycle_time_real = pick($::cinder::database_idle_timeout, $database_connection_recycle_time)
$database_min_pool_size_real = pick($::cinder::database_min_pool_size,$database_min_pool_size)
$database_max_pool_size_real = pick($::cinder::database_max_pool_size,$database_max_pool_size) $database_max_pool_size_real = pick($::cinder::database_max_pool_size,$database_max_pool_size)
$database_max_retries_real = pick($::cinder::database_max_retries,$database_max_retries) $database_max_retries_real = pick($::cinder::database_max_retries,$database_max_retries)
$database_retry_interval_real = pick($::cinder::database_retry_interval,$database_retry_interval) $database_retry_interval_real = pick($::cinder::database_retry_interval,$database_retry_interval)
@ -73,7 +79,6 @@ class cinder::db (
db_max_retries => $database_db_max_retries, db_max_retries => $database_db_max_retries,
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

@ -176,10 +176,6 @@
# Timeout when db connections should be reaped. # Timeout when db connections should be reaped.
# (Optional) Defaults to undef. # (Optional) Defaults to undef.
# #
# [*database_min_pool_size*]
# Minimum number of SQL connections to keep open in a pool.
# (Optional) Defaults to undef.
#
# [*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 undef. # (Optional) Defaults to undef.
@ -249,10 +245,15 @@
# (optional) Backend override of host value. # (optional) Backend override of host value.
# 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 cinder ( class cinder (
$database_connection = undef, $database_connection = undef,
$database_idle_timeout = undef, $database_idle_timeout = undef,
$database_min_pool_size = undef,
$database_max_pool_size = undef, $database_max_pool_size = undef,
$database_max_retries = undef, $database_max_retries = undef,
$database_retry_interval = undef, $database_retry_interval = undef,
@ -303,6 +304,8 @@ class cinder (
$enable_new_services = $::os_service_default, $enable_new_services = $::os_service_default,
$purge_config = false, $purge_config = false,
$backend_host = $::os_service_default, $backend_host = $::os_service_default,
# DEPRECATED PARAMETERS
$database_min_pool_size = undef,
) inherits cinder::params { ) inherits cinder::params {
include cinder::deps include cinder::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 'cinder::db' do
:db_max_retries => '<SERVICE DEFAULT>', :db_max_retries => '<SERVICE DEFAULT>',
:connection => 'sqlite:////var/lib/cinder/cinder.sqlite', :connection => 'sqlite:////var/lib/cinder/cinder.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>',
@ -24,7 +23,6 @@ describe 'cinder::db' do
:database_db_max_retries => '-1', :database_db_max_retries => '-1',
:database_connection => 'mysql+pymysql://cinder:cinder@localhost/cinder', :database_connection => 'mysql+pymysql://cinder:cinder@localhost/cinder',
:database_connection_recycle_time => '3601', :database_connection_recycle_time => '3601',
:database_min_pool_size => '2',
:database_max_pool_size => '11', :database_max_pool_size => '11',
:database_max_retries => '11', :database_max_retries => '11',
:database_retry_interval => '11', :database_retry_interval => '11',
@ -39,7 +37,6 @@ describe 'cinder::db' do
:db_max_retries => '-1', :db_max_retries => '-1',
:connection => 'mysql+pymysql://cinder:cinder@localhost/cinder', :connection => 'mysql+pymysql://cinder:cinder@localhost/cinder',
:connection_recycle_time => '3601', :connection_recycle_time => '3601',
:min_pool_size => '2',
:max_pool_size => '11', :max_pool_size => '11',
:max_retries => '11', :max_retries => '11',
:retry_interval => '11', :retry_interval => '11',