Deprecate idle_timeout option

The idle_timeout parameter is deprecated, use connection_recycle_time
instead[1].

[1]https://review.opendev.org/#/c/334182/

Change-Id: Iad22c20436222db89d292c960688c97bc5265d4c
Depends-On: https://review.opendev.org/656106/
Closes-Bug: #1826692

manifests/db.pp

@@ -8,7 +8,7 @@
 #   (Optional) Url used to connect to database.
 #   Defaults to 'sqlite:////var/lib/glare/glare.sqlite'.
 #
-# [*database_idle_timeout*]
+# [*database_connection_recycle_time*]
 #   (Optional) Timeout when db connections should be reaped.
 #   Defaults to $::os_service_default
 #
@@ -42,9 +42,15 @@
 #   (Optional) If set, use this value for pool_timeout with SQLAlchemy.
 #   Defaults to $::os_service_default
 #
+# DEPRECATED PARAMETERS
+#
+# [*database_idle_timeout*]
+#   Timeout when db connections should be reaped.
+#   Defaults to undef.
+#
 class glare::db (
   $database_connection              = 'sqlite:////var/lib/glare/glare.sqlite',
-  $database_idle_timeout   = $::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_db_max_retries          = $::os_service_default,
@@ -52,6 +58,8 @@ class glare::db (
   $database_retry_interval          = $::os_service_default,
   $database_max_overflow            = $::os_service_default,
   $database_pool_timeout            = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $database_idle_timeout            = undef,
 ) {
 
   include ::glare::deps
@@ -59,9 +67,15 @@ class glare::db (
   validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection,
     ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?'])
 
+  if $database_idle_timeout {
+    warning('The database_idle_timeout parameter is deprecated. Please use \
+database_connection_recycle_time instead.')
+  }
+  $database_connection_recycle_time_real = pick($database_idle_timeout, $database_connection_recycle_time)
+
   oslo::db { 'glare_config':
     connection              => $database_connection,
-    idle_timeout   => $database_idle_timeout,
+    connection_recycle_time => $database_connection_recycle_time_real,
     min_pool_size           => $database_min_pool_size,
     db_max_retries          => $database_db_max_retries,
     max_retries             => $database_max_retries,

releasenotes/notes/deprecate_idle_timeout_parameter-bb16d5b5b4300b0f.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - database_idle_timeout is deprecated and will be removed in a future
+    release. Please use database_connection_recycle_time instead.

spec/classes/glare_db_spec.rb

@@ -8,7 +8,7 @@ describe 'glare::db' do
       it { should contain_oslo__db('glare_config').with(
         :db_max_retries          => '<SERVICE DEFAULT>',
         :connection              => 'sqlite:////var/lib/glare/glare.sqlite',
-        :idle_timeout   => '<SERVICE DEFAULT>',
+        :connection_recycle_time => '<SERVICE DEFAULT>',
         :min_pool_size           => '<SERVICE DEFAULT>',
         :max_pool_size           => '<SERVICE DEFAULT>',
         :max_retries             => '<SERVICE DEFAULT>',
@@ -22,7 +22,7 @@ describe 'glare::db' do
       let :params do
         {
           :database_connection              => 'mysql+pymysql://glare:glare@localhost/glare',
-          :database_idle_timeout   => '3601',
+          :database_connection_recycle_time => '3601',
           :database_min_pool_size           => '2',
           :database_db_max_retries          => '-1',
           :database_max_retries             => '11',
@@ -38,7 +38,7 @@ describe 'glare::db' do
       it { should contain_oslo__db('glare_config').with(
         :db_max_retries          => '-1',
         :connection              => 'mysql+pymysql://glare:glare@localhost/glare',
-        :idle_timeout   => '3601',
+        :connection_recycle_time => '3601',
         :min_pool_size           => '2',
         :max_pool_size           => '11',
         :max_retries             => '11',