foreman_maintain 0.8.22 → 0.8.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 197a1b9603612e47c37ae3a24fec9362d70eb50447144ea599b612571565ea3b
-  data.tar.gz: d100893294ab1e960e3e7f93cdca402ffbfc5f64c0f51d19f7aa074ee0b18b1a
+  metadata.gz: 99acc882c19945554772facce2ff0e3089de68ebcd0f7dab47ef4847ac849ea6
+  data.tar.gz: 972b0f7a083e94a313bad7d702fbe599e3d5f68d235f464a3307c83c011f052e
 SHA512:
-  metadata.gz: 72d0e0a9f785ea86cb69e7ef2b12c26d7e9ae3777347ec29780395bd32539e08e8c8344242a3c6974518a5ed4df03585b6817b0e08d9491aa8d0f87076ceb8aa
-  data.tar.gz: d7bcef48c7493525577c010f40079d33b3bcd834d370bbba2e298592562eff57acc79e8c0bb6eb80925bd15a28d13c39e827195fc1cd1a8a08a4f28c7d02a6df
+  metadata.gz: 82314efa29ff8fabade9eecaf0e5dc6d9502287056b4d13a84109b11bbd5f351a4706de88c07840301e877db05cda9a69a4d7fc17ec7a806deed7a64cf34e5a9
+  data.tar.gz: d011a14d5660a90ecc00598bec5a42c9741f6c1fad3091316e1232cd9ea0fe635c026319d2cb5df2adb5f1f5d5cc02d2e71e5d047ce6bca79b0097e2184c28ce

data/definitions/features/system_repos.rb

@@ -21,6 +21,10 @@ class Features::SystemRepos < ForemanMaintain::Feature
     Hash[*repos.delete!(' ').split("\n")]
   end
 
+  def enabled_repos_ids
+    trim_repoids(enabled_repos_hash.keys)
+  end
+
   def upstream_repos_ids
     trim_repoids(upstream_repos.keys)
   end
@@ -29,6 +33,10 @@ class Features::SystemRepos < ForemanMaintain::Feature
     execute!("yum-config-manager --disable #{repo_ids.join(',')}")
   end
 
+  def enable_repos(repo_ids)
+    execute!("yum-config-manager --enable #{repo_ids.join(',')}")
+  end
+
   private
 
   def trim_repoids(repos)

data/definitions/procedures/repositories/backup_enabled_repos.rb

@@ -0,0 +1,16 @@
+module Procedures::Repositories
+  class BackupEnabledRepos < ForemanMaintain::Procedure
+    metadata do
+      label :backup_enabled_repos
+      description 'Stores enabled repositories in yaml file'
+    end
+
+    def run
+      enabled_repos_ids = feature(:system_repos).enabled_repos_ids
+      unless enabled_repos_ids.empty?
+        backup_dir = File.expand_path(ForemanMaintain.config.backup_dir)
+        File.write(File.join(backup_dir, 'enabled_repos.yml'), enabled_repos_ids.to_yaml)
+      end
+    end
+  end
+end

data/definitions/procedures/repositories/enable.rb

@@ -0,0 +1,13 @@
+module Procedures::Repositories
+  class Enable < ForemanMaintain::Procedure
+    metadata do
+      param :repos, 'List of repositories to enable'
+      description 'Enable repositories'
+    end
+    def run
+      with_spinner('Enabling repositories') do
+        feature(:system_repos).enable_repos(@repos)
+      end
+    end
+  end
+end

data/definitions/scenarios/self_upgrade.rb

@@ -0,0 +1,102 @@
+module ForemanMaintain::Scenarios
+  class SelfUpgradeBase < ForemanMaintain::Scenario
+    def enabled_system_repos_id
+      feature(:system_repos).enabled_repos_ids
+    end
+
+    def enable_repos(repo_ids = stored_enabled_repos_ids)
+      add_step(Procedures::Repositories::Enable.new(repos: repo_ids))
+    end
+
+    def disable_repos(repo_ids = stored_enabled_repos_ids)
+      add_step(Procedures::Repositories::Disable.new(repos: repo_ids))
+    end
+
+    def target_version
+      @target_version ||= context.get(:target_version)
+    end
+
+    def current_version
+      feature(:instance).downstream.current_minor_version
+    end
+
+    def maintenance_repo_id(version)
+      if (repo = ENV['maintenance_repo'])
+        return repo unless repo.empty?
+      end
+
+      maintenance_repo(version)
+    end
+
+    def maintenance_repo(version)
+      if el7?
+        "rhel-#{el_major_version}-server-satellite-maintenance-#{version}-rpms"
+      else
+        "satellite-maintenance-#{version}-for-rhel-#{el_major_version}-x86_64-rpms"
+      end
+    end
+
+    def maintenance_repo_version
+      return '6' if current_version == '6.10'
+
+      current_version
+    end
+
+    def stored_enabled_repos_ids
+      @stored_enabled_repos_ids ||= begin
+        path = File.expand_path('enabled_repos.yml', ForemanMaintain.config.backup_dir)
+        @stored_enabled_repos_ids = File.file?(path) ? YAML.load(File.read(path)) : []
+      end
+    end
+
+    def all_maintenance_repos
+      repo_regex = if el7?
+                     /rhel-\d-server-satellite-maintenance-\d.\d-rpms/
+                   else
+                     /satellite-maintenance-\d.\d-for-rhel-\d-x86_64-rpms/
+                   end
+      stored_enabled_repos_ids.select { |id| !id.match(repo_regex).nil? }
+    end
+
+    def repos_ids_to_reenable
+      repos_ids_to_reenable = stored_enabled_repos_ids - all_maintenance_repos
+      repos_ids_to_reenable << maintenance_repo(maintenance_repo_version)
+    end
+  end
+
+  class SelfUpgrade < SelfUpgradeBase
+    metadata do
+      label :self_upgrade_foreman_maintain
+      description "Enables the specified version's maintenance repository and,"\
+  								"\nupdates the satellite-maintain packages"
+      manual_detection
+    end
+
+    def compose
+      if check_min_version('foreman', '2.5') || check_min_version('foreman-proxy', '2.5')
+        pkgs_to_update = %w[satellite-maintain rubygem-foreman_maintain]
+        add_step(Procedures::Repositories::BackupEnabledRepos.new)
+        disable_repos
+        add_step(Procedures::Repositories::Enable.new(repos: [maintenance_repo_id(target_version)]))
+        add_step(Procedures::Packages::Update.new(packages: pkgs_to_update, assumeyes: true))
+        enable_repos(repos_ids_to_reenable)
+      end
+    end
+  end
+
+  class SelfUpgradeRescue < SelfUpgradeBase
+    metadata do
+      label :rescue_self_upgrade
+      description 'Disables all version specific maintenance repositories and,'\
+  		 "\nenables the repositories which were configured prior to self upgrade"
+      manual_detection
+      run_strategy :fail_slow
+    end
+
+    def compose
+      if check_min_version('foreman', '2.5') || check_min_version('foreman-proxy', '2.5')
+        enable_repos(repos_ids_to_reenable)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/self_upgrade_command.rb

@@ -0,0 +1,39 @@
+module ForemanMaintain
+  module Cli
+    class SelfUpgradeCommand < Base
+      option ['--target-version'], 'TARGET_VERSION',\
+             'Major version of the Satellite or Capsule'\
+           	', e.g 7.0', :required => true
+      def execute
+        allow_major_version_upgrade_only
+        run_scenario(upgrade_scenario, upgrade_rescue_scenario)
+      end
+
+      def upgrade_scenario
+        Scenarios::SelfUpgrade.new(target_version: target_version)
+      end
+
+      def upgrade_rescue_scenario
+        Scenarios::SelfUpgradeRescue.new(target_version: target_version)
+      end
+
+      def current_downstream_version
+        ForemanMaintain.detector.feature(:instance).downstream.current_version
+      end
+
+      def allow_major_version_upgrade_only
+        begin
+          next_version = Gem::Version.new(target_version)
+        rescue ArgumentError => err
+          raise Error::UsageError, "Invalid version! #{err}"
+        end
+        if current_downstream_version >= next_version
+          message = "The target-version #{target_version} should be "\
+                    "greater than existing version #{current_downstream_version},"\
+                    "\nand self-upgrade should be used for major version upgrades only!"
+          raise Error::UsageError, message
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli.rb

@@ -11,6 +11,7 @@ require 'foreman_maintain/cli/restore_command'
 require 'foreman_maintain/cli/maintenance_mode_command'
 require 'foreman_maintain/cli/packages_command'
 require 'foreman_maintain/cli/content_command'
+require 'foreman_maintain/cli/self_upgrade_command'
 
 module ForemanMaintain
   module Cli
@@ -25,6 +26,7 @@ module ForemanMaintain
       subcommand 'packages', 'Lock/Unlock package protection, install, update', PackagesCommand
       subcommand 'advanced', 'Advanced tools for server maintenance', AdvancedCommand
       subcommand 'content', 'Content related commands', ContentCommand
+      subcommand 'self-upgrade', 'Perform major version self upgrade', SelfUpgradeCommand
       subcommand 'maintenance-mode', 'Control maintenance-mode for application',
                  MaintenanceModeCommand
       if ForemanMaintain.detector.feature(:satellite) &&

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.8.22'.freeze
+  VERSION = '0.8.23'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.8.22
+  version: 0.8.23
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -274,7 +274,9 @@ files:
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
 - definitions/procedures/refresh_features.rb
 - definitions/procedures/remote_execution/remove_existing_settingsd.rb
+- definitions/procedures/repositories/backup_enabled_repos.rb
 - definitions/procedures/repositories/disable.rb
+- definitions/procedures/repositories/enable.rb
 - definitions/procedures/repositories/setup.rb
 - definitions/procedures/restore/candlepin_dump.rb
 - definitions/procedures/restore/configs.rb
@@ -307,6 +309,7 @@ files:
 - definitions/scenarios/packages.rb
 - definitions/scenarios/prep_6_10_upgrade.rb
 - definitions/scenarios/restore.rb
+- definitions/scenarios/self_upgrade.rb
 - definitions/scenarios/services.rb
 - definitions/scenarios/upgrade_to_capsule_6_10.rb
 - definitions/scenarios/upgrade_to_capsule_6_10_z.rb
@@ -354,6 +357,7 @@ files:
 - lib/foreman_maintain/cli/maintenance_mode_command.rb
 - lib/foreman_maintain/cli/packages_command.rb
 - lib/foreman_maintain/cli/restore_command.rb
+- lib/foreman_maintain/cli/self_upgrade_command.rb
 - lib/foreman_maintain/cli/service_command.rb
 - lib/foreman_maintain/cli/transform_clamp_options.rb
 - lib/foreman_maintain/cli/upgrade_command.rb