From eb72d71b7f2e3d270835a51f232c4ee7d6d3eec4 Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Sun, 6 Dec 2020 11:07:55 +0800
Subject: [PATCH] Allow db sync timeouts to be configurable

As Openstack projects continue to have longer database migration
chains, the Puppet default timeout of 300 seconds for an execution
is becoming too short a duration on some hardware, leading to timeouts.
As projects continue to add more migration scripts without pruning
the base, timeouts will continue to become more frequent unless
this time can be expanded.

Change-Id: Ib07b1a55d5640ff5372b58a412833f81665a33d3
Closes-Bug: #1904962
---
 manifests/db/sync.pp                                      | 8 +++++++-
 .../notes/add_db_sync_timeout-198d9ff15c9f8a32.yaml       | 3 +++
 spec/classes/glare_db_sync_spec.rb                        | 7 +++++--
 3 files changed, 15 insertions(+), 3 deletions(-)
 create mode 100644 releasenotes/notes/add_db_sync_timeout-198d9ff15c9f8a32.yaml

diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp
index c028401..7ba1de8 100644
--- a/manifests/db/sync.pp
+++ b/manifests/db/sync.pp
@@ -8,8 +8,13 @@
 #   to the glare-db-manage command.
 #   Defaults to ''
 #
+# [*db_sync_timeout*]
+#   (Optional) Timeout for the execution of the db_sync
+#   Defaults to 300
+#
 class glare::db::sync(
-  $extra_params  = '',
+  $extra_params    = '',
+  $db_sync_timeout = 300,
 ) {
 
   include glare::deps
@@ -21,6 +26,7 @@ class glare::db::sync(
     refreshonly => true,
     try_sleep   => 5,
     tries       => 10,
+    timeout     => $db_sync_timeout,
     logoutput   => on_failure,
     subscribe   => [
       Anchor['glare::install::end'],
diff --git a/releasenotes/notes/add_db_sync_timeout-198d9ff15c9f8a32.yaml b/releasenotes/notes/add_db_sync_timeout-198d9ff15c9f8a32.yaml
new file mode 100644
index 0000000..233445f
--- /dev/null
+++ b/releasenotes/notes/add_db_sync_timeout-198d9ff15c9f8a32.yaml
@@ -0,0 +1,3 @@
+---
+features:
+  - Adds db_sync_timeout parameter to db sync.
diff --git a/spec/classes/glare_db_sync_spec.rb b/spec/classes/glare_db_sync_spec.rb
index 7e5cd8d..a10732a 100644
--- a/spec/classes/glare_db_sync_spec.rb
+++ b/spec/classes/glare_db_sync_spec.rb
@@ -14,6 +14,7 @@ describe 'glare::db::sync' do
         :refreshonly => 'true',
         :try_sleep   => 5,
         :tries       => 10,
+        :timeout     => 300,
         :logoutput   => 'on_failure',
         :subscribe   => ['Anchor[glare::install::end]',
                          'Anchor[glare::config::end]',
@@ -23,10 +24,11 @@ describe 'glare::db::sync' do
       )
     end
 
-    describe "overriding extra_params" do
+    describe "overriding params" do
       let :params do
         {
-          :extra_params => '--config-file /etc/glare/glare.conf',
+          :extra_params    => '--config-file /etc/glare/glare.conf',
+          :db_sync_timeout => 750,
         }
       end
 
@@ -38,6 +40,7 @@ describe 'glare::db::sync' do
           :refreshonly => 'true',
           :try_sleep   => 5,
           :tries       => 10,
+          :timeout     => 750,
           :logoutput   => 'on_failure',
           :subscribe   => ['Anchor[glare::install::end]',
                            'Anchor[glare::config::end]',