From 1b1e2eb80943ffab29b7efc46f5907096806926c Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Wed, 23 Feb 2022 20:45:36 +0900
Subject: [PATCH] Deprecate use_tpool parameter

The [DEFAULT] use_tpool parameter has been deprecated in favor of
the new [database] use_tpool parameter. Also, even the new parameter
has been deprecated by during Xena release[2].

[2] 74c6bf266e0b86ceb4726cad9268f134d423bae8

Change-Id: I93fabb8d131e51c18f4a5220f2f0f47ad318bb58
---
 manifests/api.pp                              | 26 ++++++++++++-------
 ...recate-api-use_tpool-06fa6b31799ddfa9.yaml |  5 ++++
 2 files changed, 21 insertions(+), 10 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-api-use_tpool-06fa6b31799ddfa9.yaml

diff --git a/manifests/api.pp b/manifests/api.pp
index 330060b..493024e 100644
--- a/manifests/api.pp
+++ b/manifests/api.pp
@@ -175,13 +175,6 @@
 #   A flavor to use as a default instance type
 #   Default: $::os_service_default
 #
-# === DB
-#
-# [*use_tpool*]
-#   Enable the experimental use of thread pooling for
-#   all DB API calls
-#   Default: $::os_service_default
-#
 # === Exception
 #
 # [*fatal_exception_format_errors*]
@@ -220,6 +213,13 @@
 #   Should the service be enabled and started (true) of disabled and stopped (false).
 #   Default: true
 #
+# DEPRECATED PARAMETERS
+#
+# [*use_tpool*]
+#   Enable the experimental use of thread pooling for
+#   all DB API calls
+#   Default: $::os_service_default
+#
 class ec2api::api (
   # API
   $keystone_ec2_tokens_url            = $::os_service_default,
@@ -265,8 +265,6 @@ class ec2api::api (
   # Instance
   $ec2_private_dns_show_ip            = $::os_service_default,
   $default_flavor                     = $::os_service_default,
-  # DB
-  $use_tpool                          = $::os_service_default,
   # Exception
   $fatal_exception_format_errors      = $::os_service_default,
   # Paths
@@ -278,6 +276,8 @@ class ec2api::api (
   $manage_service                     = true,
   $service_name                       = $::ec2api::params::api_service_name,
   $enabled                            = true,
+  # DEPRECATED PARAMETERS
+  $use_tpool                          = undef,
 ) inherits ec2api::params {
 
   include ec2api::deps
@@ -321,7 +321,6 @@ class ec2api::api (
     'DEFAULT/full_vpc_support':                   value => $full_vpc_support;
     'DEFAULT/ec2_private_dns_show_ip':            value => $ec2_private_dns_show_ip;
     'DEFAULT/default_flavor':                     value => $default_flavor;
-    'DEFAULT/use_tpool':                          value => $use_tpool;
     'DEFAULT/fatal_exception_format_errors':      value => $fatal_exception_format_errors;
     'DEFAULT/tempdir':                            value => $tempdir;
     'DEFAULT/pybasedir':                          value => $pybasedir;
@@ -329,6 +328,13 @@ class ec2api::api (
     'DEFAULT/state_path':                         value => $state_path;
   }
 
+  if $use_tpool != undef {
+    warning('The use_tpool parameter is deprecated and will be removed in a future release.')
+  }
+  ec2api_config {
+    'DEFAULT/use_tpool': value => pick($use_tpool, $::os_service_default);
+  }
+
 
   if $manage_service {
     if $enabled {
diff --git a/releasenotes/notes/deprecate-api-use_tpool-06fa6b31799ddfa9.yaml b/releasenotes/notes/deprecate-api-use_tpool-06fa6b31799ddfa9.yaml
new file mode 100644
index 0000000..f79cf0a
--- /dev/null
+++ b/releasenotes/notes/deprecate-api-use_tpool-06fa6b31799ddfa9.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    The ``ec2api::api::use_tpool`` parameter has been deprecated and will be
+    removed in a future release.