Deprecate min_pool_size option

min_pool_size option is not used，see:

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

Change-Id: I961b21b4951c3ea2779e0765f6e36ae12f3b5b47
Closes-Bug: #1868511

diff --git a/manifests/db.pp b/manifests/db.pp
index 54d55f0d609ec53da422870a564172470629572c..508b9fb00955c3e5024db5736b9ee2fb389304b6 100644 (file)
--- a/manifests/db.pp
+++ b/manifests/db.pp
@@ -19,10 +19,6 @@
 #   (Optional) Timeout when db connections should be reaped.
 #   Defaults to $::os_service_default.
 #
-# [*database_min_pool_size*]
-#   (Optional) Minimum number of SQL connections to keep open in a pool.
-#   Defaults to $::os_service_default.
-#
 # [*database_max_pool_size*]
 #   (Optional) Maximum number of SQL connections to keep open in a pool.
 #   Defaults to $::os_service_default.
@@ -48,26 +44,36 @@
 #   (Optional) If set, use this value for pool_timeout with SQLAlchemy.
 #   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 ceilometer::db (
   $database_db_max_retries          = $::os_service_default,
   $database_connection              = 'mysql+pymysql://ceilometer:ceilometer@localhost/ceilometer',
   $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,
   $sync_db                          = true,
+  # DEPRECATED PARAMETERS
+  $database_min_pool_size           = undef,
 ) {
 
   include ceilometer::deps
 
+  if $database_min_pool_size {
+    warning('The database_min_pool_size parameter is deprecated, and will be removed in a future release.')
+  }
+
   oslo::db { 'ceilometer_config':
     db_max_retries          => $database_db_max_retries,
     connection              => $database_connection,
     connection_recycle_time => $database_connection_recycle_time,
-    min_pool_size           => $database_min_pool_size,
     max_retries             => $database_max_retries,
     retry_interval          => $database_retry_interval,
     max_pool_size           => $database_max_pool_size,

diff --git a/releasenotes/notes/deprecate_database_min_pool_size-option-b2f44ce1a11658b0.yaml b/releasenotes/notes/deprecate_database_min_pool_size-option-b2f44ce1a11658b0.yaml
new file mode 100644 (file)
index 0000000..03e58c2
--- /dev/null
+++ b/releasenotes/notes/deprecate_database_min_pool_size-option-b2f44ce1a11658b0.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/ceilometer_db_spec.rb b/spec/classes/ceilometer_db_spec.rb
index dd593119cbd99285bd6dc725e57407792dc18d7a..bf4aa15ed1c24fac60ea08b2dd2ec6e41feb7159 100644 (file)
--- a/spec/classes/ceilometer_db_spec.rb
+++ b/spec/classes/ceilometer_db_spec.rb
@@ -9,7 +9,6 @@ describe 'ceilometer::db' do
         :db_max_retries          => '<SERVICE DEFAULT>',
         :connection              => 'mysql+pymysql://ceilometer:ceilometer@localhost/ceilometer',
         :connection_recycle_time => '<SERVICE DEFAULT>',
-        :min_pool_size           => '<SERVICE DEFAULT>',
         :max_pool_size           => '<SERVICE DEFAULT>',
         :max_retries             => '<SERVICE DEFAULT>',
         :retry_interval          => '<SERVICE DEFAULT>',
@@ -26,7 +25,6 @@ describe 'ceilometer::db' do
           :database_db_max_retries          => '-1',
           :database_connection              => 'mongodb://localhost:1234/ceilometer',
           :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 'ceilometer::db' do
         :db_max_retries          => '-1',
         :connection              => 'mongodb://localhost:1234/ceilometer',
         :connection_recycle_time => '3601',
-        :min_pool_size           => '2',
         :max_pool_size           => '11',
         :max_retries             => '11',
         :retry_interval          => '11',