foreman_maintain 1.5.1 → 1.6.0

data/definitions/scenarios/upgrade_to_katello_nightly.rb

@@ -47,20 +47,22 @@ module Scenarios::Katello_Nightly
     end
 
     def set_context_mapping
-      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
+      context.map(:assumeyes, Procedures::Installer::Run => :assumeyes)
     end
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => 'nightly'))
-      modules_to_enable = ["katello:#{el_short_name}", "pulpcore:#{el_short_name}"]
-      add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      if el8?
+        modules_to_enable = ["katello:#{el_short_name}", "pulpcore:#{el_short_name}"]
+        add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      end
       add_step(Procedures::Packages::Update.new(
         :assumeyes => true,
         :dnf_options => ['--downloadonly']
       ))
       add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true, :clean_cache => false))
-      add_step_with_context(Procedures::Installer::Upgrade)
+      add_step_with_context(Procedures::Installer::Run)
     end
   end
 

data/definitions/scenarios/upgrade_to_satellite_6_16.rb

@@ -27,6 +27,7 @@ module Scenarios::Satellite_6_16
     def compose
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Disk::AvailableSpacePostgresql13)
       add_step(Checks::Repositories::Validate.new(:version => '6.16'))
     end
   end
@@ -39,8 +40,10 @@ module Scenarios::Satellite_6_16
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.16'))
-      modules_to_enable = ["satellite:#{el_short_name}"]
-      add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      if el8?
+        modules_to_enable = ["satellite:#{el_short_name}"]
+        add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      end
       add_step(Procedures::Packages::Update.new(
         :assumeyes => true,
         :dnf_options => ['--downloadonly']
@@ -57,13 +60,13 @@ module Scenarios::Satellite_6_16
     end
 
     def set_context_mapping
-      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
+      context.map(:assumeyes, Procedures::Installer::Run => :assumeyes)
     end
 
     def compose
       add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true, :clean_cache => false))
-      add_step_with_context(Procedures::Installer::Upgrade)
+      add_step_with_context(Procedures::Installer::Run)
       add_step(Procedures::Installer::UpgradeRakeTask)
     end
   end

data/definitions/scenarios/upgrade_to_satellite_6_16_z.rb

@@ -39,8 +39,10 @@ module Scenarios::Satellite_6_16_z
 
     def compose
       add_step(Procedures::Repositories::Setup.new(:version => '6.16'))
-      modules_to_enable = ["satellite:#{el_short_name}"]
-      add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      if el8?
+        modules_to_enable = ["satellite:#{el_short_name}"]
+        add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      end
       add_step(Procedures::Packages::Update.new(
         :assumeyes => true,
         :dnf_options => ['--downloadonly']
@@ -56,13 +58,13 @@ module Scenarios::Satellite_6_16_z
     end
 
     def set_context_mapping
-      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
+      context.map(:assumeyes, Procedures::Installer::Run => :assumeyes)
     end
 
     def compose
       add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true, :clean_cache => false))
-      add_step_with_context(Procedures::Installer::Upgrade)
+      add_step_with_context(Procedures::Installer::Run)
       add_step(Procedures::Installer::UpgradeRakeTask)
     end
   end

data/lib/foreman_maintain/cli/backup_command.rb

@@ -127,36 +127,9 @@ module ForemanMaintain
       end
     end
 
-    class SnapshotBackupCommand < Base
-      include BackupCommon
-      interactive_option
-      common_backup_options
-      option '--include-db-dumps', :flag, 'Also dump full database schema before snapshot backup'
-      option ['-d', '--snapshot-mount-dir'], 'SNAPSHOT_MOUNT_DIR',
-        "Override default directory ('/var/snap/') where the snapshots will be mounted",
-        :default => '/var/snap/' do |dir|
-        unless File.directory?(dir)
-          raise ArgumentError, "Snapshot mount directory does not exist: #{dir}"
-        end
-        dir
-      end
-      option ['-b', '--snapshot-block-size'], 'SNAPSHOT_BLOCK_SIZE',
-        'Override default block size (2G)', :default => '2G'
-
-      def execute
-        perform_backup(:snapshot,
-          :snapshot_mount_dir => snapshot_mount_dir,
-          :snapshot_block_size => snapshot_block_size,
-          :include_db_dumps => include_db_dumps?)
-      end
-    end
-
-    # rubocop:disable Metrics/LineLength
     class BackupCommand < Base
       subcommand 'online', 'Keep services online during backup', OnlineBackupCommand
       subcommand 'offline', 'Shut down services to preserve consistent backup', OfflineBackupCommand
-      subcommand 'snapshot', 'Use snapshots of the databases to create backup (DEPRECATED)', SnapshotBackupCommand
     end
-    # rubocop:enable Metrics/LineLength
   end
 end

data/lib/foreman_maintain/cli.rb

@@ -13,6 +13,8 @@ require 'foreman_maintain/cli/packages_command'
 require 'foreman_maintain/cli/plugin_command'
 require 'foreman_maintain/cli/self_upgrade_command'
 
+Clamp.allow_options_after_parameters = true
+
 module ForemanMaintain
   module Cli
     class MainCommand < Base

data/lib/foreman_maintain/concerns/base_database.rb

@@ -115,10 +115,6 @@ module ForemanMaintain
         @backup_dir ||= File.expand_path(ForemanMaintain.config.db_backup_dir)
       end
 
-      def find_base_directory(directory)
-        find_dir_containing_file(directory, 'postgresql.conf')
-      end
-
       def dropdb(config = configuration)
         if local?
           execute!("runuser - postgres -c 'dropdb #{config['database']}'")

data/lib/foreman_maintain/concerns/downstream.rb

@@ -56,10 +56,6 @@ module ForemanMaintain
         rh_repos
       end
 
-      def use_beta_repos?
-        ENV['FOREMAN_MAINTAIN_USE_BETA'] == '1'
-      end
-
       def product_specific_repos(full_version)
         repos = ["#{package_name}-#{full_version}-for-rhel-#{el_major_version}-x86_64-rpms"]
         repos.concat(common_repos(full_version))

data/lib/foreman_maintain/concerns/os_facts.rb

@@ -54,6 +54,10 @@ module ForemanMaintain
         File.exist?('/etc/redhat-release')
       end
 
+      def el8?
+        el_major_version == 8
+      end
+
       def debian?
         os_id == 'debian'
       end

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -163,18 +163,6 @@ module ForemanMaintain
         Dir.entries(dir).size <= 2
       end
 
-      def get_lv_info(dir)
-        execute("findmnt -n --target #{dir} -o SOURCE,FSTYPE").split
-      end
-
-      def create_lv_snapshot(name, block_size, path)
-        execute!("lvcreate -n#{name} -L#{block_size} -s #{path}")
-      end
-
-      def get_lv_path(lv_name)
-        execute("lvs --noheadings -o lv_path -S lv_name=#{lv_name}").strip
-      end
-
       def find_dir_containing_file(directory, target)
         result = nil
         Find.find(directory) do |path|

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.5.1'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/lib/foreman_maintain.rb

@@ -193,7 +193,7 @@ module ForemanMaintain
     end
 
     def enable_maintenance_module
-      return unless el?
+      return unless el8?
 
       maintenance_module = 'satellite-maintenance:el8'
       package_manager = ForemanMaintain.package_manager

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -163,7 +163,7 @@ files:
 - definitions/checks/check_tmout.rb
 - definitions/checks/disk/available_space.rb
 - definitions/checks/disk/available_space_candlepin.rb
-- definitions/checks/disk/available_space_postgresql12.rb
+- definitions/checks/disk/available_space_postgresql13.rb
 - definitions/checks/disk/performance.rb
 - definitions/checks/env_proxy.rb
 - definitions/checks/foreman/check_corrupted_roles.rb
@@ -242,20 +242,10 @@ files:
 - definitions/procedures/backup/online/safety_confirmation.rb
 - definitions/procedures/backup/prepare_directory.rb
 - definitions/procedures/backup/pulp.rb
-- definitions/procedures/backup/snapshot/clean_mount.rb
-- definitions/procedures/backup/snapshot/logical_volume_confirmation.rb
-- definitions/procedures/backup/snapshot/mount_base.rb
-- definitions/procedures/backup/snapshot/mount_candlepin_db.rb
-- definitions/procedures/backup/snapshot/mount_foreman_db.rb
-- definitions/procedures/backup/snapshot/mount_pulp.rb
-- definitions/procedures/backup/snapshot/mount_pulpcore_db.rb
-- definitions/procedures/backup/snapshot/prepare_mount.rb
-- definitions/procedures/backup/snapshot/snapshot_deprecation_message.rb
 - definitions/procedures/crond/start.rb
 - definitions/procedures/crond/stop.rb
 - definitions/procedures/files/remove.rb
 - definitions/procedures/foreman/fix_corrupted_roles.rb
-- definitions/procedures/foreman/remove_duplicate_obsolete_roles.rb
 - definitions/procedures/foreman/remove_duplicate_permissions.rb
 - definitions/procedures/foreman_maintain_features.rb
 - definitions/procedures/foreman_openscap/invalid_report_associations.rb
@@ -266,8 +256,6 @@ files:
 - definitions/procedures/foreman_tasks/ui_investigate.rb
 - definitions/procedures/hammer_setup.rb
 - definitions/procedures/installer/run.rb
-- definitions/procedures/installer/run_for_6_11.rb
-- definitions/procedures/installer/upgrade.rb
 - definitions/procedures/installer/upgrade_rake_task.rb
 - definitions/procedures/knowledge_base_article.rb
 - definitions/procedures/maintenance_mode/disable_maintenance_mode.rb

data/definitions/checks/disk/available_space_postgresql12.rb

@@ -1,46 +0,0 @@
-module Checks
-  module Disk
-    class AvailableSpacePostgresql12 < ForemanMaintain::Check
-      metadata do
-        label :available_space_for_postgresql12
-        description 'Check to make sure PostgreSQL 12 work directory has enough space for upgrade'
-        confine do
-          (feature(:foreman_database) || feature(:candlepin_database)) && \
-            (file_exists?('/var/lib/pgsql') && \
-            file_exists?('/var/opt/rh/rh-postgresql12'))
-        end
-      end
-
-      def run
-        assert(psql_12_available_space >= psql_9_consumed_space, warning_message, :warn => true)
-      end
-
-      def pgsql_dir(version)
-        case version
-        when 9
-          '/var/lib/pgsql/'
-        when 12
-          '/var/opt/rh/rh-postgresql12/'
-        end
-      end
-
-      def psql_9_consumed_space
-        io_obj = ForemanMaintain::Utils::Disk::IODevice.new(pgsql_dir(9))
-        io_obj.space_used
-      end
-
-      def psql_12_available_space
-        io_obj = ForemanMaintain::Utils::Disk::IODevice.new(pgsql_dir(12))
-        io_obj.available_space
-      end
-
-      def warning_message
-        sat_version = feature(:satellite).current_version.version[0..2]
-        "Satellite #{sat_version} uses PostgreSQL 12. \nThis changes PostgreSQL "\
-        "work directory to #{pgsql_dir(12)}\n"\
-        "The new work directory requires at least #{psql_9_consumed_space}"\
-        'MiB free space for upgrade!'
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/clean_mount.rb

@@ -1,24 +0,0 @@
-module Procedures::Backup
-  module Snapshot
-    class CleanMount < ForemanMaintain::Procedure
-      metadata do
-        description 'Remove the snapshot mount points'
-        tags :backup
-        param :mount_dir, 'Snapshot mount directory', :required => true
-      end
-
-      def run
-        %w[pulp pgsql].each do |database|
-          mount_point = File.join(@mount_dir, database)
-
-          if File.exist?(mount_point) && !execute("mount|grep #{mount_point}").empty?
-            execute("umount #{mount_point}")
-          end
-
-          snapshot_location = get_lv_path("#{database}-snap")
-          execute("lvremove #{snapshot_location} -f") unless snapshot_location.empty?
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/logical_volume_confirmation.rb

@@ -1,56 +0,0 @@
-module Procedures::Backup
-  module Snapshot
-    class LogicalVolumeConfirmation < ForemanMaintain::Procedure
-      metadata do
-        description 'Check if backup is on different logical volume then the source'
-        tags :backup
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :skip_pulp, 'Skip Pulp content during backup'
-      end
-
-      def run
-        backup_lv = get_lv_info(@backup_dir)
-        shared_lv = dbs.inject([]) do |list, (db_label, db_name)|
-          db_lv = get_lv_info(feature(db_label).data_dir)
-          list << db_name if db_lv == backup_lv
-          list
-        end
-
-        pulp_data_lv = get_lv_info(current_pulp_feature.pulp_data_dir)
-        shared_lv << 'Pulp' if pulp_data_lv == backup_lv && !@skip_pulp
-
-        confirm(shared_lv) if shared_lv.any?
-      end
-
-      def current_pulp_feature
-        feature(:pulpcore_database)
-      end
-
-      def dbs
-        dbs = {}
-        dbs[:candlepin_database] = 'Candlepin' if db_local?(:candlepin_database)
-        dbs[:foreman_database] = 'Foreman' if db_local?(:foreman_database)
-        dbs[:pulpcore_database] = 'Pulpcore' if db_local?(:pulpcore_database)
-        dbs
-      end
-
-      private
-
-      def db_local?(db)
-        feature(:instance).database_local?(db)
-      end
-
-      def confirm(shared_lv)
-        answer = ask_decision('*** WARNING: The chosen backup location is mounted on the same' \
-          " logical volume as the location of #{shared_lv.join(', ')}.\n" \
-          '*** It is highly suggested to backup to a different logical volume than' \
-          " the #{shared_lv.join(', ')} database.\n" \
-          '*** If you would like to continue, the snapshot size will be required to be at least' \
-          " the size of the actual #{shared_lv.join(', ')} database.\n" \
-          "*** You can skip this confirmation with the '-y' flag.\n\n" \
-          'Do you want to proceed?', actions_msg: 'y(yes), q(quit)')
-        abort! unless answer == :yes
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/mount_base.rb

@@ -1,27 +0,0 @@
-module Procedures::Backup
-  module Snapshot
-    class MountBase < ForemanMaintain::Procedure
-      metadata do
-        advanced_run false
-      end
-
-      def self.common_params(context)
-        context.instance_eval do
-          param :mount_dir, 'Snapshot mount directory', :required => true
-          param :block_size, 'Snapshot block size', :default => '2G'
-        end
-      end
-
-      def mount_snapshot(database, lv_type)
-        FileUtils.mkdir_p(mount_location(database))
-        options = (lv_type == 'xfs') ? '-onouuid,ro' : '-oro'
-        lv_name = "#{database}-snap"
-        execute!("mount #{get_lv_path(lv_name)} #{mount_location(database)} #{options}")
-      end
-
-      def mount_location(database)
-        File.join(@mount_dir, database)
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/mount_candlepin_db.rb

@@ -1,48 +0,0 @@
-require 'procedures/backup/snapshot/mount_base'
-module Procedures::Backup
-  module Snapshot
-    class MountCandlepinDB < MountBase
-      metadata do
-        description 'Create and mount snapshot of Candlepin DB'
-        tags :backup
-        label :backup_snapshot_mount_candlepin_db
-        for_feature :candlepin_database
-        preparation_steps { Checks::Candlepin::DBUp.new unless feature(:candlepin_database).local? }
-        MountBase.common_params(self)
-        param :backup_dir, 'Directory where to backup to'
-      end
-
-      def run
-        if feature(:candlepin_database).local?
-          snapshot
-        else
-          dump_candlepin
-        end
-      end
-
-      private
-
-      def dump_candlepin
-        puts 'LV snapshots are 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
-
-      def snapshot
-        mount_point = mount_location('pgsql')
-        FileUtils.mkdir_p(mount_point) unless File.directory?(mount_point)
-        if directory_empty?(mount_point)
-          with_spinner('Creating snapshot of Postgres') do |spinner|
-            lv_info = get_lv_info(feature(:candlepin_database).data_dir)
-            create_lv_snapshot('pgsql-snap', @block_size, lv_info[0])
-            spinner.update("Mounting snapshot of Postgres on #{mount_point}")
-            mount_snapshot('pgsql', lv_info[1])
-          end
-        else
-          puts 'Snapshot of Postgres is already mounted'
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/mount_foreman_db.rb

@@ -1,48 +0,0 @@
-require 'procedures/backup/snapshot/mount_base'
-module Procedures::Backup
-  module Snapshot
-    class MountForemanDB < MountBase
-      metadata do
-        description 'Create and mount snapshot of Foreman DB'
-        tags :backup
-        label :backup_snapshot_mount_foreman_db
-        for_feature :foreman_database
-        preparation_steps { Checks::Foreman::DBUp.new unless feature(:foreman_database).local? }
-        MountBase.common_params(self)
-        param :backup_dir, 'Directory where to backup to'
-      end
-
-      def run
-        if feature(:foreman_database).local?
-          snapshot
-        else
-          dump_foreman
-        end
-      end
-
-      private
-
-      def dump_foreman
-        puts 'LV snapshots are 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
-
-      def snapshot
-        mount_point = mount_location('pgsql')
-        FileUtils.mkdir_p(mount_point) unless File.directory?(mount_point)
-        if directory_empty?(mount_point)
-          with_spinner('Creating snapshot of Postgres') do |spinner|
-            lv_info = get_lv_info(feature(:foreman_database).data_dir)
-            create_lv_snapshot('pgsql-snap', @block_size, lv_info[0])
-            spinner.update("Mounting snapshot of Postgres on #{mount_point}")
-            mount_snapshot('pgsql', lv_info[1])
-          end
-        else
-          puts 'Snapshot of Postgres is already mounted'
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/mount_pulp.rb

@@ -1,32 +0,0 @@
-require 'procedures/backup/snapshot/mount_base'
-module Procedures::Backup
-  module Snapshot
-    class MountPulp < MountBase
-      metadata do
-        description 'Create and mount snapshot of Pulp data'
-        tags :backup
-        MountBase.common_params(self)
-        param :skip, 'Skip Pulp content during backup'
-        confine do
-          feature(:pulpcore_database)
-        end
-      end
-
-      def run
-        skip if @skip
-        with_spinner('Creating snapshot of Pulp') do |spinner|
-          current_pulp_feature.with_marked_directory(current_pulp_feature.pulp_data_dir) do
-            lv_info = get_lv_info(current_pulp_feature.pulp_data_dir)
-            create_lv_snapshot('pulp-snap', @block_size, lv_info[0])
-            spinner.update("Mounting snapshot of Pulp on #{mount_location('pulp')}")
-            mount_snapshot('pulp', lv_info[1])
-          end
-        end
-      end
-
-      def current_pulp_feature
-        feature(:pulpcore_database)
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/mount_pulpcore_db.rb

@@ -1,48 +0,0 @@
-require 'procedures/backup/snapshot/mount_base'
-module Procedures::Backup
-  module Snapshot
-    class MountPulpcoreDB < MountBase
-      metadata do
-        description 'Create and mount snapshot of Pulpcore DB'
-        tags :backup
-        label :backup_snapshot_mount_pulpcore_db
-        for_feature :pulpcore_database
-        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
-        MountBase.common_params(self)
-        param :backup_dir, 'Directory where to backup to'
-      end
-
-      def run
-        if feature(:pulpcore_database).local?
-          snapshot
-        else
-          dump_pulpcore
-        end
-      end
-
-      private
-
-      def dump_pulpcore
-        puts 'LV snapshots are 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
-
-      def snapshot
-        mount_point = mount_location('pgsql')
-        FileUtils.mkdir_p(mount_point) unless File.directory?(mount_point)
-        if directory_empty?(mount_point)
-          with_spinner('Creating snapshot of Postgres') do |spinner|
-            lv_info = get_lv_info(feature(:pulpcore_database).data_dir)
-            create_lv_snapshot('pgsql-snap', @block_size, lv_info[0])
-            spinner.update("Mounting snapshot of Postgres on #{mount_point}")
-            mount_snapshot('pgsql', lv_info[1])
-          end
-        else
-          puts 'Snapshot of Postgres is already mounted'
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/prepare_mount.rb

@@ -1,16 +0,0 @@
-module Procedures::Backup
-  module Snapshot
-    class PrepareMount < ForemanMaintain::Procedure
-      metadata do
-        description 'Prepare mount point for the snapshot'
-        tags :backup
-        param :mount_dir, 'Snapshot mount directory', :required => true
-      end
-
-      def run
-        logger.debug("Creating snap dir: #{@mount_dir}")
-        FileUtils.mkdir_p @mount_dir
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/snapshot_deprecation_message.rb

@@ -1,14 +0,0 @@
-module Procedures::Backup
-  module Snapshot
-    class SnapshotDeprecationMessage < ForemanMaintain::Procedure
-      metadata do
-        description 'Snapshot backups are deprecated'
-        tags :backup
-      end
-
-      def run
-        set_warn('Snapshot backups are deprecated and will be removed in a future version.')
-      end
-    end
-  end
-end