From af6514829c48a4a6c06d06abc66552e4424fdc81 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Wed, 23 Feb 2022 20:49:51 +0900
Subject: [PATCH] db: Deprecate support for use_tpool

... because it was deprecated during Xena cycle[1].

[1] 74c6bf266e0b86ceb4726cad9268f134d423bae8

Change-Id: I2acdf52bf0bc1c68037bb5326707a2eb3e3834a9
---
 manifests/db.pp                                  | 16 ++++++++++------
 .../deprecate-db-use_tpool-d4897027d3fcf788.yaml |  5 +++++
 2 files changed, 15 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-db-use_tpool-d4897027d3fcf788.yaml

diff --git a/manifests/db.pp b/manifests/db.pp
index fda4a7d..d4e6b7b 100644
--- a/manifests/db.pp
+++ b/manifests/db.pp
@@ -102,10 +102,6 @@
 #   before error is raised. Set to -1 to specify an infinite retry count.
 #   Defaults to $::os_service_default
 #
-# [*use_tpool*]
-#   (Optional) Enable the experimental use of thread pooling for all DB API calls (boolean value)
-#   Defaults to $::os_service_default
-#
 # [*mysql_enable_ndb*]
 #   (Optional) If True, transparently enables support for handling MySQL
 #   Cluster (NDB).
@@ -121,6 +117,10 @@
 #   (Optional) Minimum number of SQL connections to keep open in a pool.
 #   Defaults to undef
 #
+# [*use_tpool*]
+#   (Optional) Enable the experimental use of thread pooling for all DB API calls (boolean value)
+#   Defaults to undef
+#
 define oslo::db(
   $config                  = $name,
   $config_group            = 'database',
@@ -144,11 +144,11 @@ define oslo::db(
   $db_inc_retry_interval   = $::os_service_default,
   $db_max_retry_interval   = $::os_service_default,
   $db_max_retries          = $::os_service_default,
-  $use_tpool               = $::os_service_default,
   $mysql_enable_ndb        = $::os_service_default,
   # DEPRCATED PARAMETERS
   $idle_timeout            = undef,
   $min_pool_size           = undef,
+  $use_tpool               = undef,
 ) {
 
   include oslo::params
@@ -202,6 +202,10 @@ define oslo::db(
     warning('The min_pool_size parameter is deprecated, and will be removed in a future release.')
   }
 
+  if $use_tpool == undef {
+    warning('The use_tepool parameter is deprecated and will be removed in a future release.')
+  }
+
   $database_options = {
     "${config_group}/sqlite_synchronous"      => { value => $sqlite_synchronous },
     "${config_group}/backend"                 => { value => $backend },
@@ -221,7 +225,7 @@ define oslo::db(
     "${config_group}/db_inc_retry_interval"   => { value => $db_inc_retry_interval },
     "${config_group}/db_max_retry_interval"   => { value => $db_max_retry_interval },
     "${config_group}/db_max_retries"          => { value => $db_max_retries },
-    "${config_group}/use_tpool"               => { value => $use_tpool },
+    "${config_group}/use_tpool"               => { value => pick($use_tpool, $::os_service_default) },
     "${config_group}/mysql_enable_ndb"        => { value => $mysql_enable_ndb },
   }
 
diff --git a/releasenotes/notes/deprecate-db-use_tpool-d4897027d3fcf788.yaml b/releasenotes/notes/deprecate-db-use_tpool-d4897027d3fcf788.yaml
new file mode 100644
index 0000000..dcf3111
--- /dev/null
+++ b/releasenotes/notes/deprecate-db-use_tpool-d4897027d3fcf788.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``oslo::db::use_tpool`` parameter has been deprecated and will be
+    removed in a future release.