foreman_maintain 1.6.12 → 1.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7357cec0fa22b76e7ae0c7d2da85e2cb20f52aeb2ded53e9a2ddf21c56b7a037
-  data.tar.gz: 2116a2048dc315a55bb7fb8789e9961f2a4fc91a4afa5b614dd237eb7825da37
+  metadata.gz: 0e0b033f2189945ae0f5b3a005ee7513d7046f958ffa8bb8693ddc2c95521db1
+  data.tar.gz: 62ca2e1a8404fa3d30309feceafc53d659519f4595ab60cecbde58ad8e69290c
 SHA512:
-  metadata.gz: 5a14594384dd60070ffde442e87423522ebde81e3f9580ac88c74028bb33a232bbe4bf57e7847d70768c82b375c5067509dfefed5ecc7c79023f66a2c904af11
-  data.tar.gz: 07fc2c9e32f3d16171a99839562dd01210190c00de03414859dfb84492401168d2127d84974ac750c7b5aaa47a927bd6ea42cc47237249c908ac56f96749e7d0
+  metadata.gz: a6f47ab3d231627d634fc8ce93d31853de8da33bb84ac02c483077bb71270bb413d90e9f721820237227c2ea6e3bdeb3df2bb610f33c8a9e5cae67e4bd13a73c
+  data.tar.gz: ad2f03840152f21a868b881973267fc48e511c8c48115666b5b5cfc4685c753bb18f27c4a6f476dda624f7ee0c69f57a1702759b7a0c3a5b874034bda04df90b

data/definitions/checks/backup/incremental_parent_type.rb

@@ -5,7 +5,6 @@ module Checks::Backup
       tags :backup
       param :incremental_dir, 'Path to existing backup directory'
       param :online_backup, 'Select for online backup', :flag => true, :default => false
-      param :sql_tar, 'Will backup include PostgreSQL tarball', :flag => true, :default => false
       manual_detection
     end
 
@@ -25,11 +24,9 @@ module Checks::Backup
       assert(existing_type == new_type, msg)
 
       unless @online_backup
-        existing_sql = backup.sql_tar_files_exist? ? 'tarball' : 'dump'
-        new_sql = @sql_tar ? 'tarball' : 'dump'
-        msg = "The existing backup has PostgreSQL as a #{existing_sql}, "\
-          "but the new one will have a #{new_sql}."
-        assert(existing_sql == new_sql, msg)
+        msg = "The existing backup has PostgreSQL as a tarball, "\
+          "but the new one will have a dump."
+        assert(!backup.sql_tar_files_exist?, msg)
       end
     end
   end

data/definitions/checks/restore/validate_postgresql_dump_permissions.rb

@@ -11,7 +11,7 @@ module Checks::Restore
 
     def run
       backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
-      if feature(:instance).postgresql_local? && backup.online_backup?
+      if feature(:instance).postgresql_local?
         errors = []
         [:candlepin_dump, :foreman_dump, :pulpcore_dump].each do |dump|
           next unless backup.file_map[dump][:present]

data/definitions/procedures/backup/online/candlepin_db.rb

@@ -2,7 +2,7 @@ module Procedures::Backup
   module Online
     class CandlepinDB < ForemanMaintain::Procedure
       metadata do
-        description 'Backup Candlepin database online'
+        description 'Backup Candlepin database'
         tags :backup
         label :backup_online_candlepin_db
         for_feature :candlepin_database

data/definitions/procedures/backup/online/foreman_db.rb

@@ -2,7 +2,7 @@ module Procedures::Backup
   module Online
     class ForemanDB < ForemanMaintain::Procedure
       metadata do
-        description 'Backup Foreman database online'
+        description 'Backup Foreman database'
         tags :backup
         label :backup_online_foreman_db
         for_feature :foreman_database

data/definitions/procedures/backup/online/pulpcore_db.rb

@@ -2,7 +2,7 @@ module Procedures::Backup
   module Online
     class PulpcoreDB < ForemanMaintain::Procedure
       metadata do
-        description 'Backup Pulpcore database online'
+        description 'Backup Pulpcore database'
         tags :backup
         label :backup_online_pulpcore_db
         for_feature :pulpcore_database

data/definitions/procedures/backup/online/safety_confirmation.rb

@@ -4,23 +4,20 @@ module Procedures::Backup
       metadata do
         description 'Data consistency warning'
         tags :backup
-        param :include_db_dumps, 'Are database dumps included in backup', :flag => true,
-          :default => false
       end
 
       def run
-        answer = ask_decision(warning_message(@include_db_dumps), actions_msg: 'y(yes), q(quit)')
+        answer = ask_decision(warning_message, actions_msg: 'y(yes), q(quit)')
         abort! unless answer == :yes
       end
 
-      def warning_message(include_db_dumps)
-        substr = include_db_dumps ? 'database dump' : 'online backup'
-        "*** WARNING: The #{substr} is intended for making a copy of the data\n" \
+      def warning_message
+        "*** WARNING: The online backup is intended for making a copy of the data\n" \
           '*** for debugging purposes only.' \
           " The backup routine can not ensure 100% consistency while the\n" \
           "*** backup is taking place as there is a chance there may be data mismatch between\n" \
           '*** the databases while the services are live.' \
-          " If you wish to utilize the #{substr}\n" \
+          " If you wish to utilize the online backup\n" \
           '*** for production use you need to ensure that there are' \
           " no modifications occurring during\n" \
           "*** your backup run.\n\nDo you want to proceed?"

data/definitions/procedures/backup/prepare_directory.rb

@@ -6,7 +6,6 @@ module Procedures::Backup
       param :backup_dir, 'Directory where to backup to', :required => true
       param :preserve_dir, 'Directory where to backup to', :flag => true
       param :incremental_dir, 'Changes since specified backup only'
-      param :online_backup, 'Select for online backup', :flag => true, :default => false
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -17,7 +16,7 @@ module Procedures::Backup
         FileUtils.mkdir_p @backup_dir
         FileUtils.chmod_R 0o770, @backup_dir
 
-        if feature(:instance).postgresql_local? && @online_backup
+        if feature(:instance).postgresql_local?
           begin
             FileUtils.chown_R(nil, 'postgres', @backup_dir)
           rescue Errno::EPERM

data/definitions/scenarios/backup.rb

@@ -8,7 +8,6 @@ module ForemanMaintain::Scenarios
       param :strategy, 'Backup strategy. One of [:online, :offline]',
         :required => true
       param :backup_dir, 'Directory where to backup to', :required => true
-      param :include_db_dumps, 'Include dumps of local dbs as part of offline'
       param :preserve_dir, 'Directory where to backup to'
       param :incremental_dir, 'Changes since specified backup only'
       param :proxy_features, 'List of proxy features to backup (default: all)', :array => true
@@ -19,12 +18,10 @@ module ForemanMaintain::Scenarios
     def compose
       check_valid_strategy
       add_step_with_context(Checks::Backup::IncrementalParentType,
-        :online_backup => strategy == :online,
-        :sql_tar => feature(:instance).postgresql_local?)
+        :online_backup => strategy == :online)
       safety_confirmation
       add_step_with_context(Procedures::Backup::AccessibilityConfirmation) if strategy == :offline
-      add_step_with_context(Procedures::Backup::PrepareDirectory,
-        :online_backup => strategy == :online)
+      add_step_with_context(Procedures::Backup::PrepareDirectory)
       add_step_with_context(Procedures::Backup::Metadata, :online_backup => strategy == :online)
 
       case strategy
@@ -47,10 +44,7 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Pulp => :backup_dir,
         Procedures::Backup::Online::CandlepinDB => :backup_dir,
         Procedures::Backup::Online::ForemanDB => :backup_dir,
-        Procedures::Backup::Online::PulpcoreDB => :backup_dir,
-        Procedures::Backup::Offline::CandlepinDB => :backup_dir,
-        Procedures::Backup::Offline::ForemanDB => :backup_dir,
-        Procedures::Backup::Offline::PulpcoreDB => :backup_dir)
+        Procedures::Backup::Online::PulpcoreDB => :backup_dir)
       context.map(:preserve_dir,
         Procedures::Backup::PrepareDirectory => :preserve_dir)
       context.map(:incremental_dir,
@@ -63,15 +57,13 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Pulp => :skip)
       context.map(:tar_volume_size,
         Procedures::Backup::Pulp => :tar_volume_size)
-      context.map(:include_db_dumps,
-        Procedures::Backup::Online::SafetyConfirmation => :include_db_dumps)
     end
     # rubocop:enable  Metrics/MethodLength
 
     private
 
     def safety_confirmation
-      if strategy == :online || include_db_dumps?
+      if strategy == :online
         add_step_with_context(Procedures::Backup::Online::SafetyConfirmation)
       end
     end
@@ -83,35 +75,30 @@ module ForemanMaintain::Scenarios
     end
 
     def add_offline_backup_steps
-      include_dumps if include_db_dumps?
       add_step_with_context(Procedures::ForemanProxy::Features, :load_only => true)
       add_steps_with_context(
         Procedures::Service::Stop,
         Procedures::Backup::ConfigFiles,
-        Procedures::Backup::Pulp,
-        Procedures::Backup::Offline::CandlepinDB,
-        Procedures::Backup::Offline::ForemanDB,
-        Procedures::Backup::Offline::PulpcoreDB,
-        Procedures::Service::Start
+        Procedures::Backup::Pulp
       )
-    end
 
-    def include_dumps
-      if feature(:instance).database_local?(:candlepin_database)
-        add_step_with_context(Procedures::Backup::Online::CandlepinDB)
-      end
-      if feature(:instance).database_local?(:foreman_database)
-        add_step_with_context(Procedures::Backup::Online::ForemanDB)
-      end
-      if feature(:instance).database_local?(:pulpcore_database)
-        add_step_with_context(Procedures::Backup::Online::PulpcoreDB)
+      if feature(:instance).postgresql_local?
+        add_step(Procedures::Service::Start.new(:only => ['postgresql']))
       end
+
+      add_database_backup_steps
+
+      add_steps_with_context(Procedures::Service::Start)
     end
 
     def add_online_backup_steps
       add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true,
         :online_backup => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
+      add_database_backup_steps
+    end
+
+    def add_database_backup_steps
       add_steps_with_context(
         Procedures::Backup::Online::CandlepinDB,
         Procedures::Backup::Online::ForemanDB,
@@ -122,10 +109,6 @@ module ForemanMaintain::Scenarios
     def strategy
       context.get(:strategy)
     end
-
-    def include_db_dumps?
-      !!context.get(:include_db_dumps)
-    end
   end
 
   class BackupRescueCleanup < ForemanMaintain::Scenario

data/definitions/scenarios/update.rb

@@ -3,6 +3,11 @@ module Scenarios::Update
     def self.update_metadata(&block)
       metadata do
         tags :update_scenario
+
+        confine do
+          feature(:instance).target_version == feature(:instance).current_version.to_s[/^\d+\.\d+/]
+        end
+
         instance_eval(&block)
       end
     end

data/lib/foreman_maintain/cli/backup_command.rb

@@ -119,11 +119,9 @@ module ForemanMaintain
       include BackupCommon
       interactive_option
       common_backup_options
-      option '--include-db-dumps', :flag, 'Also dump full database schema before offline backup'
 
       def execute
-        perform_backup(:offline,
-          :include_db_dumps => include_db_dumps?)
+        perform_backup(:offline)
       end
     end
 

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.6.12'.freeze
+  VERSION = '1.6.14'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.6.12
+  version: 1.6.14
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -235,9 +235,6 @@ files:
 - definitions/procedures/backup/compress_data.rb
 - definitions/procedures/backup/config_files.rb
 - definitions/procedures/backup/metadata.rb
-- definitions/procedures/backup/offline/candlepin_db.rb
-- definitions/procedures/backup/offline/foreman_db.rb
-- definitions/procedures/backup/offline/pulpcore_db.rb
 - definitions/procedures/backup/online/candlepin_db.rb
 - definitions/procedures/backup/online/foreman_db.rb
 - definitions/procedures/backup/online/pulpcore_db.rb

data/definitions/procedures/backup/offline/candlepin_db.rb

@@ -1,53 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class CandlepinDB < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Candlepin DB offline'
-        tags :backup
-        label :backup_offline_candlepin_db
-        for_feature :candlepin_database
-        preparation_steps { Checks::Candlepin::DBUp.new unless feature(:candlepin_database).local? }
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-      end
-
-      def run
-        if feature(:candlepin_database).local?
-          if File.exist?(pg_backup_file)
-            puts 'Already done'
-          else
-            local_backup
-          end
-        else
-          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
-            ' Doing postgres dump instead...'
-          with_spinner('Getting Candlepin DB dump') do
-            feature(:candlepin_database).dump_db(File.join(@backup_dir, 'candlepin.dump'))
-          end
-        end
-      end
-
-      private
-
-      def local_backup
-        with_spinner("Collecting data from #{pg_data_dir}") do
-          feature(:candlepin_database).backup_local(
-            pg_backup_file,
-            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-            :volume_size => @tar_volume_size,
-            :data_dir => pg_data_dir,
-            :restore_dir => feature(:candlepin_database).data_dir
-          )
-        end
-      end
-
-      def pg_backup_file
-        File.join(@backup_dir, 'pgsql_data.tar')
-      end
-
-      def pg_data_dir
-        feature(:candlepin_database).data_dir
-      end
-    end
-  end
-end

data/definitions/procedures/backup/offline/foreman_db.rb

@@ -1,73 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class ForemanDB < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Foreman DB offline'
-        tags :backup
-        label :backup_offline_foreman_db
-        for_feature :foreman_database
-        preparation_steps { Checks::Foreman::DBUp.new unless feature(:foreman_database).local? }
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-      end
-
-      def run
-        if feature(:foreman_database).local?
-          if File.exist?(pg_backup_file)
-            puts 'Already done'
-          else
-            local_backup
-          end
-        else
-          puts "Backup of #{pg_data_dirs.join(',')} is not supported for remote databases." \
-            ' Doing postgres dump instead...'
-          with_spinner('Getting Foreman DB dump') do
-            feature(:foreman_database).dump_db(File.join(@backup_dir, 'foreman.dump'))
-          end
-        end
-      end
-
-      private
-
-      def local_backup
-        with_spinner("Collecting data from #{pg_data_dirs.join(',')}") do
-          pg_data_dirs.each_with_index do |pg_dir, index|
-            do_backup(pg_dir, (index == 0) ? 'create' : 'append')
-          end
-        end
-      end
-
-      def do_backup(pg_dir, cmd)
-        restore_dir = el? ? feature(:foreman_database).data_dir : pg_dir
-        feature(:foreman_database).backup_local(
-          pg_backup_file,
-          :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-          :volume_size => @tar_volume_size,
-          :data_dir => pg_dir,
-          :restore_dir => restore_dir,
-          :command => cmd
-        )
-      end
-
-      def pg_backup_file
-        File.join(@backup_dir, 'pgsql_data.tar')
-      end
-
-      def pg_data_dirs
-        el? ? [pg_data_dir_el] : pg_data_dirs_deb
-      end
-
-      def pg_data_dirs_deb
-        # The Debian based OSes support multiple installations of Postgresql
-        # There could be situations where Foreman db is either of these versions
-        # To be sure we backup the system correctly without missing anything
-        # we backup all of the Postgresql dirs
-        feature(:foreman_database).data_dir
-      end
-
-      def pg_data_dir_el
-        feature(:foreman_database).data_dir
-      end
-    end
-  end
-end

data/definitions/procedures/backup/offline/pulpcore_db.rb

@@ -1,53 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class PulpcoreDB < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Pulpcore DB offline'
-        tags :backup
-        label :backup_offline_pulpcore_db
-        for_feature :pulpcore_database
-        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-      end
-
-      def run
-        if feature(:pulpcore_database).local?
-          if File.exist?(pg_backup_file)
-            puts 'Already done'
-          else
-            local_backup
-          end
-        else
-          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
-            ' Doing postgres dump instead...'
-          with_spinner('Getting Pulpcore DB dump') do
-            feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
-          end
-        end
-      end
-
-      private
-
-      def local_backup
-        with_spinner("Collecting data from #{pg_data_dir}") do
-          feature(:pulpcore_database).backup_local(
-            pg_backup_file,
-            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-            :volume_size => @tar_volume_size,
-            :data_dir => pg_data_dir,
-            :restore_dir => feature(:pulpcore_database).data_dir
-          )
-        end
-      end
-
-      def pg_backup_file
-        File.join(@backup_dir, 'pgsql_data.tar')
-      end
-
-      def pg_data_dir
-        feature(:pulpcore_database).data_dir
-      end
-    end
-  end
-end