foreman_maintain 1.6.7 → 1.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c513edc079ddea8f18904feeed2d3299c59949183703f7344946c8828abee6b6
-  data.tar.gz: 2fb58c156aaf22a0b1be982768a267926f8f080b063a2169ab6868fa1955b26d
+  metadata.gz: cdd4ef357f342501b15fbaf461be19952c2d09fde6fb7c1f3523711201ef3faa
+  data.tar.gz: cc9b2d323a171c5676276767f11c4a83adc5123fab01f58114d88a80a3ddba13
 SHA512:
-  metadata.gz: bbd8eb809ab9f165b461dd2b29e8af8b5ffdee2d285462d9a9b626e93f922ac20066d166a751524c80edbadb6c465cbb6a5661529591da7188608ff0d48467b3
-  data.tar.gz: 7450630a6ab864eec72be71fd6b948f016d59f8f1e6dcbc11c8110d41bbde62504f16acc40b9bd3ff2e5b902cd316555fb03ebf72c2606b851824fbf8d50fb6f
+  metadata.gz: fffefa90d5f28514280c732cb232003acb543420a9ca9fd5a9cf77749beecb1533a05d71bb6b7c5db1e3e06dcb5909a5fa3e8f85ef3a98ae369f090cef84c052
+  data.tar.gz: cb4997dcbb7eba53f9e4d82445ad327316e3a1ace686e62ffd0b3f4a63ecd418542d73c42d7fe10692fb48054dc902b42faaff2772c744e91c421160210fec13

data/README.md

@@ -17,7 +17,6 @@ Subcommands:
         --tags tags                 Run only those with all specific set of tags
 
     upgrade                       Upgrade related commands
-      list-versions                 List versions this system is upgradable to
       check --target-version TARGET_VERSION   Run pre-upgrade checks for upgrading to specified version
             --disable-self-upgrade            Disable automatic self upgrade (default: false)
       run --target-version TARGET_VERSION     Run the full upgrade
@@ -56,12 +55,11 @@ Subcommands:
 Foreman-maintain implements upgrade tooling that helps the administrator to go
 through the upgrade process.
 
-Foreman-maintain scans the system to know, what versions are available
-for upgrade on the particular system. To see what versions are available
-for upgrade, run:
+The foreman-maintain tool is intended to self upgrade itself to the next major
+version of the project. This is needed before upgrading, run:
 
 ```
-foreman-maintain upgrade list-versions
+foreman-maintain self-upgrade
 ```
 
 To perform just the pre-upgrade checks for the system, run:

data/definitions/checks/check_ipv6_disable.rb

@@ -0,0 +1,23 @@
+class Checks::CheckIpv6Disable < ForemanMaintain::Check
+  metadata do
+    label :check_ipv6_disable
+    description 'Check if ipv6.disable=1 is set at kernel level'
+  end
+
+  def run
+    cmdline_file = File.read('/proc/cmdline')
+
+    assert(!cmdline_file.include?("ipv6.disable=1"), error_message)
+  end
+
+  def error_message
+    base = "\nThe kernel contains ipv6.disable=1 which is known to break installation and upgrade"\
+           ", remove and reboot before continuining."
+
+    if feature(:instance).downstream
+      base += " See https://access.redhat.com/solutions/5045841 for more details."
+    end
+
+    base
+  end
+end

data/definitions/features/capsule.rb

@@ -7,8 +7,7 @@ class Features::Capsule < ForemanMaintain::Feature
 
     confine do
       !package_manager.installed?(['satellite']) &&
-        package_manager.installed?(['satellite-capsule']) ||
-        package_manager.installed?(['capsule-installer'])
+        package_manager.installed?(['satellite-capsule'])
     end
   end
 

data/definitions/features/dynflow_sidekiq.rb

@@ -8,14 +8,9 @@ class Features::DynflowSidekiq < ForemanMaintain::Feature
   end
 
   def config_files
-    # Workaround until foreman-installer can deploy scaled workers
-    service_symlinks = configured_instances.map do |service|
-      "/etc/systemd/system/multi-user.target.wants/#{service}.service"
-    end
     [
       '/etc/foreman/dynflow',
-      service_symlinks,
-    ].flatten
+    ]
   end
 
   def services

data/definitions/features/foreman_install.rb

@@ -9,4 +9,16 @@ class Features::ForemanInstall < ForemanMaintain::Feature
       !feature(:instance).downstream && feature(:foreman_server)
     end
   end
+
+  def target_version
+    '3.11'
+  end
+
+  def current_version
+    @current_version ||= package_version(package_name)
+  end
+
+  def package_name
+    'foreman'
+  end
 end

data/definitions/features/foreman_server.rb

@@ -26,7 +26,6 @@ module ForemanMaintain
         [
           '/etc/httpd',
           '/var/www/html/pub/katello-*',
-          '/etc/squid',
           '/etc/foreman',
           '/etc/selinux/targeted/contexts/files/file_contexts.subs',
           '/etc/sysconfig/foreman',

data/definitions/features/foreman_tasks.rb

@@ -125,14 +125,6 @@ class Features::ForemanTasks < ForemanMaintain::Feature
     puts "\nTimeout: #{e.message}. Try again."
   end
 
-  def services
-    feature(:dynflow_sidekiq) ? [] : [system_service(service_name, 30)]
-  end
-
-  def service_name
-    'dynflowd'
-  end
-
   private
 
   def check_task_count(state, spinner)

data/definitions/features/instance.rb

@@ -91,6 +91,24 @@ class Features::Instance < ForemanMaintain::Feature
     feature(:foreman_install) || feature(:katello_install)
   end
 
+  def current_version
+    version = if feature(:instance).downstream
+                feature(:instance).downstream.current_version
+              else
+                feature(:foreman_install).current_version
+              end
+
+    version.to_s[/^\d+\.\d+\.\d+/]
+  end
+
+  def target_version
+    if feature(:instance).downstream
+      Features::Satellite.new.target_version
+    else
+      Features::ForemanInstall.new.target_version
+    end
+  end
+
   private
 
   # rubocop:disable Metrics/AbcSize
@@ -162,7 +180,6 @@ class Features::Instance < ForemanMaintain::Feature
       'pulp3' => %w[pulpcore pulpcore_database],
       'pulp3_content' => %w[pulpcore pulpcore_database],
       'foreman_tasks' => %w[foreman_tasks],
-      'katello_agent' => %w[katello],
       'katello_events' => %w[katello],
     }
   end

data/definitions/features/katello.rb

@@ -17,14 +17,6 @@ class Features::Katello < ForemanMaintain::Feature
     @current_version ||= package_version('katello')
   end
 
-  def services
-    [
-      system_service('qpidd', 10),
-      system_service('qdrouterd', 10),
-    ]
-  end
-
-  # rubocop:disable  Metrics/MethodLength
   def config_files
     configs = [
       '/etc/pki/katello',
@@ -35,11 +27,6 @@ class Features::Katello < ForemanMaintain::Feature
       '/etc/sysconfig/tomcat*',
       '/etc/tomcat*',
       '/var/lib/candlepin',
-      '/usr/share/foreman/bundler.d/katello.rb',
-      '/etc/qpid',
-      '/etc/qpid-dispatch',
-      '/var/lib/qpidd',
-      '/etc/qpid-dispatch',
     ]
 
     if installer_scenario_answers['certs']
@@ -53,11 +40,9 @@ class Features::Katello < ForemanMaintain::Feature
 
     configs
   end
-  # rubocop:enable  Metrics/MethodLength
 
   def config_files_exclude_for_online
     [
-      '/var/lib/qpidd',
       '/var/lib/candlepin/activemq-artemis',
     ]
   end

data/definitions/features/satellite.rb

@@ -10,6 +10,10 @@ class Features::Satellite < ForemanMaintain::Feature
     end
   end
 
+  def target_version
+    '6.16'
+  end
+
   def current_version
     @current_version ||= package_version(package_name) || version_from_source
   end

data/definitions/procedures/hammer_setup.rb

@@ -2,6 +2,9 @@ class Procedures::HammerSetup < ForemanMaintain::Procedure
   metadata do
     description 'Setup hammer'
     for_feature :hammer
+    preparation_steps do
+      Checks::ServicesUp.new
+    end
   end
 
   def run

data/definitions/procedures/installer/upgrade_rake_task.rb

@@ -2,12 +2,13 @@ module Procedures::Installer
   class UpgradeRakeTask < ForemanMaintain::Procedure
     metadata do
       description 'Execute upgrade:run rake task'
+      confine do
+        feature(:satellite)
+      end
     end
 
     def run
-      # only run this in the Satellite scenario, as in others
-      # the installer runs this rake task for us already
-      execute!('foreman-rake upgrade:run') if feature(:satellite)
+      execute!('foreman-rake upgrade:run')
     end
   end
 end

data/definitions/procedures/packages/update.rb

@@ -8,6 +8,7 @@ module Procedures::Packages
         :flag => true, :default => false
       param :download_only, 'Download and cache packages only', :flag => true, :default => false
       param :clean_cache, 'If true will cause a DNF cache clean', :flag => true, :default => true
+      param :enabled_repos, 'List of repositories to enable', :array => true
     end
 
     def run
@@ -16,6 +17,7 @@ module Procedures::Packages
       opts = {
         :assumeyes => assumeyes_val,
         :download_only => @download_only,
+        :enabled_repos => @enabled_repos,
       }
       packages_action(:update, @packages, opts)
     rescue ForemanMaintain::Error::ExecutionError => e

data/definitions/procedures/pulpcore/container_handle_image_metadata.rb

@@ -0,0 +1,26 @@
+module Procedures::Pulpcore
+  class ContainerHandleImageMetadata < ForemanMaintain::Procedure
+    include ForemanMaintain::Concerns::SystemService
+    include ForemanMaintain::Concerns::PulpCommon
+
+    metadata do
+      description 'Initialize and expose container image metadata in the pulpcore db'
+      for_feature :pulpcore
+    end
+
+    def run
+      with_spinner('Initialize and expose container image metadata in the pulpcore db') do |spinner|
+        necessary_services = feature(:pulpcore_database).services
+
+        feature(:service).handle_services(spinner, 'start', :only => necessary_services)
+
+        spinner.update('Adding image metadata to pulp. You can continue using the ' \
+               'system normally while the task runs in the background.')
+        execute!(pulpcore_manager('container-handle-image-data'))
+        spinner.update('Adding image metadata to katello. You can continue using the ' \
+               'system normally while the task runs in the background.')
+        execute!('foreman-rake katello:import_container_manifest_labels')
+      end
+    end
+  end
+end

data/definitions/procedures/restore/configs.rb

@@ -14,18 +14,10 @@ module Procedures::Restore
         spinner.update('Restoring configs')
         clean_conflicting_data
         restore_configs(backup)
-        reset_qpid_jrnls
       end
     end
 
     def restore_configs(backup)
-      exclude = ForemanMaintain.available_features.each_with_object([]) do |feat, cfgs|
-        if backup.online_backup?
-          feat.config_files_exclude_for_online.each { |f| cfgs << f.gsub(%r{^/}, '') }
-        end
-        feat.config_files_to_exclude.each { |f| cfgs << f.gsub(%r{^/}, '') }
-      end
-
       tar_options = {
         :overwrite => true,
         :listed_incremental => '/dev/null',
@@ -33,7 +25,6 @@ module Procedures::Restore
         :directory => '/',
         :archive => backup.file_map[:config_files][:path],
         :gzip => true,
-        :exclude => exclude,
       }
 
       feature(:tar).run(tar_options)
@@ -45,15 +36,5 @@ module Procedures::Restore
       # tar is unable to --overwrite dir with symlink
       execute('rm -rf /usr/share/foreman-proxy/.ssh')
     end
-
-    def reset_qpid_jrnls
-      # on restore without pulp data qpid fails to start
-      # https://access.redhat.com/solutions/4645231
-      ['/var/lib/qpidd/.qpidd/', '/var/lib/qpidd/'].each do |qpidd_path|
-        if Dir.exist?("#{qpidd_path}/qls/dat2/")
-          execute("rm -rf #{qpidd_path}/qls/dat2/__db.00*")
-        end
-      end
-    end
   end
 end

data/definitions/procedures/restore/drop_databases.rb

@@ -19,9 +19,7 @@ module Procedures::Restore
         feature(:service).handle_services(spinner, 'start', :only => ['postgresql'])
         drop_foreman(backup, spinner)
         drop_candlepin(backup, spinner)
-        if feature(:pulpcore)
-          drop_pulpcore(backup, spinner)
-        end
+        drop_pulpcore(backup, spinner)
       end
     end
 

data/definitions/procedures/restore/reindex_databases.rb

@@ -1,6 +1,7 @@
 module Procedures::Restore
   class ReindexDatabases < ForemanMaintain::Procedure
     include ForemanMaintain::Concerns::SystemService
+    include ForemanMaintain::Concerns::SystemHelpers
 
     metadata do
       description 'REINDEX databases'
@@ -16,6 +17,11 @@ module Procedures::Restore
 
         spinner.update('Reindexing the databases')
         execute!('runuser - postgres -c "reindexdb -a"')
+        if check_min_version('python3.11-pulp-ansible', '0.20.0')
+          execute!('runuser -c '\
+                   '\'echo "ALTER COLLATION pulp_ansible_semver REFRESH VERSION;"'\
+                   '| psql pulpcore\' postgres')
+        end
       end
     end
   end

data/definitions/procedures/restore/required_packages.rb

@@ -12,7 +12,6 @@ module Procedures::Restore
       backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
       required_packages = []
       required_packages << 'puppetserver' if backup.with_puppetserver?
-      required_packages << 'qpid-cpp-server' if backup.with_qpidd?
       if required_packages.any?
         with_spinner('Installing required packages') do
           ForemanMaintain.package_manager.install(required_packages, assumeyes: true)

data/definitions/scenarios/backup.rb

@@ -19,9 +19,9 @@ module ForemanMaintain::Scenarios
     def compose
       check_valid_strategy
       safety_confirmation
-      accessibility_confirmation
-      prepare_directory
-      add_step_with_context(Procedures::Backup::Metadata, :online_backup => online_backup?)
+      add_step_with_context(Procedures::Backup::AccessibilityConfirmation) if strategy == :offline
+      add_step_with_context(Procedures::Backup::PrepareDirectory)
+      add_step_with_context(Procedures::Backup::Metadata, :online_backup => strategy == :online)
 
       case strategy
       when :online
@@ -29,6 +29,7 @@ module ForemanMaintain::Scenarios
       when :offline
         add_offline_backup_steps
       end
+
       add_step_with_context(Procedures::Backup::CompressData)
     end
 
@@ -64,18 +65,8 @@ module ForemanMaintain::Scenarios
 
     private
 
-    def prepare_directory
-      add_step_with_context(Procedures::Backup::PrepareDirectory)
-    end
-
-    def accessibility_confirmation
-      if strategy == :offline
-        add_step_with_context(Procedures::Backup::AccessibilityConfirmation)
-      end
-    end
-
     def safety_confirmation
-      if online_backup? || include_db_dumps?
+      if strategy == :online || include_db_dumps?
         add_step_with_context(Procedures::Backup::Online::SafetyConfirmation)
       end
     end
@@ -132,10 +123,6 @@ module ForemanMaintain::Scenarios
     def include_db_dumps?
       !!context.get(:include_db_dumps)
     end
-
-    def online_backup?
-      strategy == :online
-    end
   end
 
   class BackupRescueCleanup < ForemanMaintain::Scenario
@@ -149,8 +136,10 @@ module ForemanMaintain::Scenarios
     end
 
     def compose
-      add_step_with_context(Procedures::Service::Start) if strategy != :online
-      add_steps_with_context(find_procedures(:maintenance_mode_off)) if strategy != :online
+      if strategy == :offline
+        add_step_with_context(Procedures::Service::Start)
+        add_steps_with_context(find_procedures(:maintenance_mode_off))
+      end
       add_step_with_context(Procedures::Backup::Clean)
     end
 

data/definitions/scenarios/foreman_upgrade.rb

@@ -134,7 +134,8 @@ module Scenarios::ForemanUpgrade
         Checks::ServerPing,
         Checks::ServicesUp,
         Checks::SystemRegistration,
-        Procedures::Packages::CheckForReboot
+        Procedures::Packages::CheckForReboot,
+        Procedures::Pulpcore::ContainerHandleImageMetadata
       )
     end
   end

data/definitions/scenarios/restore.rb

@@ -11,7 +11,6 @@ module ForemanMaintain::Scenarios
     end
 
     # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     def compose
       backup = ForemanMaintain::Utils::Backup.new(context.get(:backup_dir))
 
@@ -27,7 +26,6 @@ module ForemanMaintain::Scenarios
       end
 
       add_steps_with_context(Procedures::Restore::Confirmation,
-        Procedures::Selinux::SetFileSecurity,
         Procedures::Restore::RequiredPackages,
         Procedures::Restore::Configs)
       add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
@@ -36,13 +34,10 @@ module ForemanMaintain::Scenarios
       end
       add_step_with_context(Procedures::Service::Stop)
       add_steps_with_context(Procedures::Restore::ExtractFiles) if backup.tar_backups_exist?
-      drop_dbs(backup)
-      if backup.sql_dump_files_exist? && feature(:instance).postgresql_local?
-        add_step(Procedures::Service::Start.new(:only => ['postgresql']))
-      end
-      restore_sql_dumps(backup)
-      if backup.sql_dump_files_exist? && feature(:instance).postgresql_local?
-        add_step(Procedures::Service::Stop.new(:only => ['postgresql']))
+
+      if backup.sql_needs_dump_restore?
+        add_steps_with_context(Procedures::Restore::DropDatabases)
+        restore_sql_dumps(backup)
       end
 
       if feature(:instance).postgresql_local? &&
@@ -51,38 +46,28 @@ module ForemanMaintain::Scenarios
         add_step_with_context(Procedures::Restore::ReindexDatabases)
       end
 
-      add_steps_with_context(
-        Procedures::Pulpcore::Migrate,
-        Procedures::Restore::CandlepinResetMigrations
-      )
-
-      add_steps_with_context(Procedures::Service::Start,
-        Procedures::Service::DaemonReload)
       add_step(Procedures::Installer::Run.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::UpgradeRakeTask)
       add_step_with_context(Procedures::Crond::Start) if feature(:cron)
     end
     # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
-
-    def drop_dbs(backup)
-      if backup.file_map[:candlepin_dump][:present] ||
-         backup.file_map[:foreman_dump][:present] ||
-         (feature(:pulpcore) && backup.file_map[:pulpcore_dump][:present])
-        add_steps_with_context(Procedures::Restore::DropDatabases)
-      end
-    end
 
     def restore_sql_dumps(backup)
+      if feature(:instance).postgresql_local?
+        add_step(Procedures::Service::Start.new(:only => ['postgresql']))
+      end
       if backup.file_map[:candlepin_dump][:present]
         add_steps_with_context(Procedures::Restore::CandlepinDump)
       end
       if backup.file_map[:foreman_dump][:present]
         add_steps_with_context(Procedures::Restore::ForemanDump)
       end
-      if feature(:pulpcore) && backup.file_map[:pulpcore_dump][:present]
+      if backup.file_map[:pulpcore_dump][:present]
         add_steps_with_context(Procedures::Restore::PulpcoreDump)
       end
+      if feature(:instance).postgresql_local?
+        add_step(Procedures::Service::Stop.new(:only => ['postgresql']))
+      end
     end
 
     def set_context_mapping
@@ -98,9 +83,6 @@ module ForemanMaintain::Scenarios
         Procedures::Restore::ForemanDump => :backup_dir,
         Procedures::Restore::PulpcoreDump => :backup_dir,
         Procedures::Restore::ExtractFiles => :backup_dir)
-
-      context.map(:incremental_backup,
-        Procedures::Selinux::SetFileSecurity => :incremental_backup)
     end
   end
 

data/definitions/scenarios/{upgrade_to_satellite_6_16.rb → satellite_upgrade.rb}

@@ -1,11 +1,10 @@
-module Scenarios::Satellite_6_16
+module Scenarios::Satellite
   class Abstract < ForemanMaintain::Scenario
     def self.upgrade_metadata(&block)
       metadata do
         tags :upgrade_scenario
         confine do
-          feature(:satellite) &&
-            (feature(:satellite).current_minor_version == '6.15' || \
+          (feature(:downstream).current_minor_version == '6.15' || \
             ForemanMaintain.upgrade_in_progress == '6.16')
         end
         instance_eval(&block)
@@ -19,7 +18,7 @@ module Scenarios::Satellite_6_16
 
   class PreUpgradeCheck < Abstract
     upgrade_metadata do
-      description 'Checks before upgrading to Satellite 6.16'
+      description 'Checks before upgrading'
       tags :pre_upgrade_checks
       run_strategy :fail_slow
     end
@@ -27,15 +26,16 @@ module Scenarios::Satellite_6_16
     def compose
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::CheckIpv6Disable)
       add_step(Checks::Disk::AvailableSpacePostgresql13)
-      add_step(Checks::Repositories::Validate.new(:version => '6.16'))
+      add_step(Checks::Repositories::Validate.new(:version => target_version))
       add_step(Checks::CheckOrganizationContentAccessMode)
     end
   end
 
   class PreMigrations < Abstract
     upgrade_metadata do
-      description 'Procedures before migrating to Satellite 6.16'
+      description 'Procedures before migrating'
       tags :pre_migrations
     end
 
@@ -46,7 +46,7 @@ module Scenarios::Satellite_6_16
 
   class Migrations < Abstract
     upgrade_metadata do
-      description 'Migration scripts to Satellite 6.16'
+      description 'Migration scripts'
       tags :migrations
       run_strategy :fail_fast
     end
@@ -56,7 +56,7 @@ module Scenarios::Satellite_6_16
     end
 
     def compose
-      add_step(Procedures::Repositories::Setup.new(:version => '6.16'))
+      add_step(Procedures::Repositories::Setup.new(:version => target_version))
       if el8?
         modules_to_switch = ['postgresql:13']
         add_step(Procedures::Packages::SwitchModules.new(:module_names => modules_to_switch))
@@ -76,7 +76,7 @@ module Scenarios::Satellite_6_16
 
   class PostMigrations < Abstract
     upgrade_metadata do
-      description 'Procedures after migrating to Satellite 6.16'
+      description 'Procedures after migrating'
       tags :post_migrations
     end
 
@@ -89,7 +89,7 @@ module Scenarios::Satellite_6_16
 
   class PostUpgradeChecks < Abstract
     upgrade_metadata do
-      description 'Checks after upgrading to Satellite 6.16'
+      description 'Checks after upgrading'
       tags :post_upgrade_checks
       run_strategy :fail_slow
     end
@@ -98,6 +98,7 @@ module Scenarios::Satellite_6_16
       add_steps(find_checks(:default))
       add_steps(find_checks(:post_upgrade))
       add_step(Procedures::Packages::CheckForReboot)
+      add_step(Procedures::Pulpcore::ContainerHandleImageMetadata)
     end
   end
 end