foreman_maintain 0.8.21 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a580f07f36c4c9ab021f465d02b0430ac81a444765f2793a7940d18182ce25
-  data.tar.gz: ef70e629eec6f635d2515b9eea748567c2d3e559fc762a3005a0ab9a85d7e61b
+  metadata.gz: bc78f39bf65ff7aa89be6ba1dda201de03f6d9a4b637599e5afd3d489ac4495d
+  data.tar.gz: 5554b12a68af2a4710ef7725d39079fbe7452b280b40b9ebfe0bd23cad058f40
 SHA512:
-  metadata.gz: '0797ffb2141b60a5811f62dcdddb2d600221c22df75868674a4628838a445836058b003d67296bc91a2bc4593f06dbe4bcd1223417263fb9335d4bb141dc8c14'
-  data.tar.gz: a40dd53e0d8633bd01301e2b85b2d38cf62d8ca0ab502c9c3747939d5a7b38f3fc90fc6b8f861ec956846660ab6ac0a22e2c257e3c07c3963fec945ee03cadde
+  metadata.gz: d68910821f5bcbdc2267d7fa5201fe348b4f32af27531d15a621567aaef88dc52bfdc17e3fcaf6ec70899514c103d501b785edd2cb6c9100bb50762b7050236e
+  data.tar.gz: bede7c7b5521c991a83ca714fbdc10bee1df94d992daa4d54c142a51717bfae130f2e5ddf4b789f5c34274a0eb766fed0d62b0bd1f09017c14c0a9378402307c

data/definitions/checks/foreman/check_puppet_capsules.rb

@@ -0,0 +1,43 @@
+module Checks
+  class CheckPuppetCapsules < ForemanMaintain::Check
+    metadata do
+      label :puppet_capsules
+      for_feature :foreman_database
+      description 'Check for Puppet capsules from the database'
+      manual_detection
+    end
+
+    def run
+      puppet_proxies = find_puppet_proxies.reject { |proxy| local_proxy?(proxy['url']) }
+      unless puppet_proxies.empty?
+        names = puppet_proxies.map { |proxy| proxy['name'] }
+        print('You have proxies with Puppet feature enabled, '\
+              "please disable Puppet on all proxies first.\n"\
+              "The following proxies have Puppet feature: #{names.join(', ')}.")
+        abort!
+      end
+    end
+
+    def find_puppet_proxies
+      feature(:foreman_database).query(puppet_proxies_query)
+    end
+
+    private
+
+    def local_proxy?(url)
+      URI.parse(url).hostname.casecmp(hostname) == 0
+    end
+
+    def puppet_proxies_query
+      <<-SQL
+        SELECT \"smart_proxies\".*
+          FROM \"smart_proxies\"
+            INNER JOIN \"smart_proxy_features\"
+              ON \"smart_proxies\".\"id\" = \"smart_proxy_features\".\"smart_proxy_id\"
+            INNER JOIN \"features\"
+              ON \"features\".\"id\" = \"smart_proxy_features\".\"feature_id\"
+          WHERE \"features\".\"name\" = 'Puppet'
+      SQL
+    end
+  end
+end

data/definitions/checks/pulpcore/group_ownership_check.rb

@@ -0,0 +1,18 @@
+module Checks
+  module Pulpcore
+    class GroupOwnershipCheck < ForemanMaintain::Check
+      metadata do
+        description 'Check the group owner of /var/lib/pulp directory'
+        label :group_ownership_check_of_pulp_content
+        manual_detection
+      end
+
+      def run
+        group_id = File.stat('/var/lib/pulp/').gid
+        if Etc.getgrgid(group_id).name != 'pulp'
+          fail! "Please run 'foreman-maintain prep-6.10-upgrade' prior to upgrading."
+        end
+      end
+    end
+  end
+end

data/definitions/checks/repositories/validate.rb

@@ -3,8 +3,7 @@ module Checks::Repositories
     metadata do
       description 'Validate availability of repositories'
       preparation_steps do
-        [Checks::Repositories::CheckNonRhRepository.new,
-         Procedures::Packages::Install.new(:packages => [ForemanMaintain::Utils::Facter.package])]
+        Checks::Repositories::CheckNonRhRepository.new
       end
 
       confine do

data/definitions/checks/restore/validate_interfaces.rb

@@ -0,0 +1,24 @@
+require 'foreman_maintain/utils/backup'
+
+module Checks::Restore
+  class ValidateInterfaces < ForemanMaintain::Check
+    metadata do
+      description 'Validate network interfaces match the backup'
+
+      param :backup_dir,
+            'Path to backup directory',
+            :required => true
+      manual_detection
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+      invalid_interfaces = backup.validate_interfaces
+      msg = 'The following features are enabled in the backup, '\
+        "\nbut the system does not have the interfaces used by these features: "
+      msg << invalid_interfaces.map { |k, v| "#{k} (#{v['configured']})" }.join(', ')
+      msg << '.'
+      assert(backup.validate_interfaces.empty?, msg)
+    end
+  end
+end

data/definitions/features/candlepin.rb

@@ -13,8 +13,7 @@ class Features::Candlepin < ForemanMaintain::Feature
 
   def services
     [
-      system_service('tomcat', 20),
-      system_service('tomcat6', 20)
+      system_service('tomcat', 20)
     ]
   end
 end

data/definitions/features/pulpcore.rb

@@ -37,7 +37,8 @@ class Features::Pulpcore < ForemanMaintain::Feature
 
   def config_files
     [
-      '/etc/pulp/settings.py'
+      '/etc/pulp/settings.py',
+      '/etc/pulp/certs/database_fields.symmetric.key'
     ]
   end
 

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/backup/metadata.rb

@@ -9,6 +9,8 @@ module Procedures::Backup
       param :online_backup, 'Select for online backup', :flag => true, :default => false
     end
 
+    PROXY_CONFIG_ENTRIES = %w[dns dns_interface dhcp dhcp_interface].freeze
+
     def run
       with_spinner('Collecting metadata') do |spinner|
         metadata = {}
@@ -18,6 +20,8 @@ module Procedures::Backup
         metadata['rpms'] = rpms(spinner)
         metadata['incremental'] = @incremental_dir || false
         metadata['online'] = @online_backup
+        metadata['hostname'] = hostname
+        metadata['proxy_config'] = proxy_config(spinner)
         save_metadata(metadata, spinner)
       end
     end
@@ -54,5 +58,12 @@ module Procedures::Backup
         feature(:foreman_proxy).features
       end
     end
+
+    def proxy_config(spinner)
+      spinner.update('Collecting proxy configuration')
+      feature(:installer).answers['foreman_proxy'].select do |key, _|
+        PROXY_CONFIG_ENTRIES.include?(key)
+      end
+    end
   end
 end

data/definitions/procedures/installer/upgrade_rake_task.rb

@@ -5,7 +5,9 @@ module Procedures::Installer
     end
 
     def run
-      execute!('foreman-rake upgrade: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)
     end
   end
 end

data/definitions/procedures/pulpcore/migrate.rb

@@ -18,7 +18,7 @@ module Procedures::Pulpcore
         spinner.update('Migrating pulpcore database')
         execute!('sudo PULP_SETTINGS=/etc/pulp/settings.py '\
           'DJANGO_SETTINGS_MODULE=pulpcore.app.settings '\
-          'python3-django-admin migrate --noinput')
+          'pulpcore-manager migrate --noinput')
       end
     end
   end

data/definitions/procedures/puppet/remove_puppet.rb

@@ -0,0 +1,50 @@
+module Procedures::Puppet
+  class RemovePuppet < ForemanMaintain::Procedure
+    metadata do
+      description 'Remove Puppet feature'
+      confine do
+        feature(:puppet_server) &&
+          (check_min_version('foreman', '3.0') || check_min_version('foreman-proxy', '3.0'))
+      end
+      advanced_run false
+    end
+
+    def run
+      services = feature(:foreman_server).services + feature(:dynflow_sidekiq).services
+      Procedures::Service::Stop.new(:only => services)
+      execute!('foreman-rake db:migrate VERSION=0 SCOPE=foreman_puppet') if server_with_puppet?
+      feature(:installer).run(installer_arguments_disabling_puppet.join(' '), :interactive => false)
+      packages_action(:remove, packages_to_remove, :assumeyes => true)
+    end
+
+    private
+
+    def server_with_puppet?
+      find_package(foreman_plugin_name('foreman_puppet'))
+    end
+
+    def installer_arguments_disabling_puppet
+      answers = feature(:installer).answers
+
+      options = []
+      options << '--no-enable-puppet' if answers.key?('puppet')
+      options << '--no-enable-foreman-plugin-puppet' if answers['foreman::plugin::puppet']
+      options << '--no-enable-foreman-cli-puppet' if answers['foreman::cli::puppet']
+      if answers['foreman_proxy']
+        options << '--foreman-proxy-puppet false'
+        options << '--foreman-proxy-puppetca false'
+      end
+      options << '--foreman-proxy-content-puppet false' if answers.key?('foreman_proxy_content')
+      options
+    end
+
+    def packages_to_remove
+      packages = ['puppetserver']
+      if server_with_puppet?
+        packages << foreman_plugin_name('foreman_puppet')
+        packages << hammer_plugin_name('foreman_puppet')
+      end
+      packages
+    end
+  end
+end

data/definitions/procedures/puppet/remove_puppet_data.rb

@@ -0,0 +1,21 @@
+module Procedures::Puppet
+  class RemovePuppetData < ForemanMaintain::Procedure
+    metadata do
+      description 'Remove Puppet data'
+    end
+
+    def run
+      execute!('foreman-rake purge:puppet')
+      execute!('rm -r ' + files_to_purge.join(' '))
+    end
+
+    private
+
+    def files_to_purge
+      %w[
+        /etc/puppetlabs
+        /opt/puppetlabs/server/data
+      ]
+    end
+  end
+end

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/procedures/repositories/setup.rb

@@ -2,10 +2,6 @@ module Procedures::Repositories
   class Setup < ForemanMaintain::Procedure
     metadata do
       description 'Setup repositories'
-      preparation_steps do
-        Procedures::Packages::Install.new(:packages => [ForemanMaintain::Utils::Facter.package])
-      end
-
       confine do
         feature(:instance).downstream || feature(:upstream)
       end

data/definitions/procedures/restore/configs.rb

@@ -56,7 +56,11 @@ module Procedures::Restore
     def reset_qpid_jrnls
       # on restore without pulp data qpid fails to start
       # https://access.redhat.com/solutions/4645231
-      execute('rm -rf /var/lib/qpidd/.qpidd/qls/dat2/__db.00*')
+      ['/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/scenarios/puppet.rb

@@ -0,0 +1,21 @@
+module ForemanMaintain::Scenarios
+  module Puppet
+    class RemovePuppet < ForemanMaintain::Scenario
+      metadata do
+        description 'Remove Puppet feature'
+        tags :puppet_disable
+        label :puppet_disable
+        param :remove_data, 'Purge the Puppet data after disabling plugin'
+        manual_detection
+      end
+
+      def compose
+        if check_min_version('foreman', '3.0') || check_min_version('foreman-proxy', '3.0')
+          add_step(Checks::CheckPuppetCapsules) if server?
+          add_step(Procedures::Puppet::RemovePuppet)
+          add_step(Procedures::Puppet::RemovePuppetData) if context.get(:remove_data)
+        end
+      end
+    end
+  end
+end

data/definitions/scenarios/restore.rb

@@ -6,18 +6,27 @@ module ForemanMaintain::Scenarios
       description 'Restore backup'
       param :backup_dir, 'Path to backup directory'
       param :incremental_backup, 'Is the backup incremental?'
+      param :dry_run, 'Check if backup could be restored, without performing the restore'
       manual_detection
     end
 
     # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
     def compose
       backup = ForemanMaintain::Utils::Backup.new(context.get(:backup_dir))
 
       add_steps(find_checks(:root_user))
       supported_version_check
       add_steps_with_context(Checks::Restore::ValidateBackup,
-                             Procedures::Restore::Confirmation,
                              Checks::Restore::ValidateHostname,
+                             Checks::Restore::ValidateInterfaces)
+
+      if context.get(:dry_run)
+        self.class.metadata[:run_strategy] = :fail_slow
+        return
+      end
+
+      add_steps_with_context(Procedures::Restore::Confirmation,
                              Procedures::Selinux::SetFileSecurity,
                              Procedures::Restore::Configs)
       add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
@@ -42,9 +51,12 @@ module ForemanMaintain::Scenarios
       add_steps_with_context(Procedures::Restore::RegenerateQueues) if backup.online_backup?
       add_steps_with_context(Procedures::Service::Start,
                              Procedures::Service::DaemonReload)
+      add_step(Procedures::Installer::Upgrade.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,Metrics/PerceivedComplexity
 
     def drop_dbs(backup)
       if backup.file_map[:candlepin_dump][:present] ||
@@ -87,6 +99,7 @@ module ForemanMaintain::Scenarios
       context.map(:backup_dir,
                   Checks::Restore::ValidateBackup => :backup_dir,
                   Checks::Restore::ValidateHostname => :backup_dir,
+                  Checks::Restore::ValidateInterfaces => :backup_dir,
                   Procedures::Restore::Configs => :backup_dir,
                   Procedures::Restore::DropDatabases => :backup_dir,
                   Procedures::Restore::PgGlobalObjects => :backup_dir,

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, "\
+  								'updates the foreman-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 repos and,'\
+  		' enables 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/definitions/scenarios/upgrade_to_capsule_7_0.rb

@@ -0,0 +1,89 @@
+module Scenarios::Capsule_7_0
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_scenario
+        confine do
+          feature(:capsule) &&
+            (feature(:capsule).current_minor_version == '6.10' || \
+            ForemanMaintain.upgrade_in_progress == '7.0')
+        end
+        instance_eval(&block)
+      end
+    end
+
+    def target_version
+      '7.0'
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Capsule 7.0'
+      tags :pre_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Repositories::Validate.new(:version => '7.0'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Capsule 7.0'
+      tags :pre_migrations
+    end
+
+    def compose
+      add_steps(find_procedures(:pre_migrations))
+      add_step(Procedures::Service::Stop.new)
+    end
+  end
+
+  class Migrations < Abstract
+    upgrade_metadata do
+      description 'Migration scripts to Capsule 7.0'
+      tags :migrations
+    end
+
+    def set_context_mapping
+      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '7.0'))
+      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true))
+      add_step_with_context(Procedures::Installer::Upgrade)
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures after migrating to Capsule 7.0'
+      tags :post_migrations
+    end
+
+    def compose
+      add_step(Procedures::RefreshFeatures)
+      add_step(Procedures::Service::Start.new)
+      add_steps(find_procedures(:post_migrations))
+    end
+  end
+
+  class PostUpgradeChecks < Abstract
+    upgrade_metadata do
+      description 'Checks after upgrading to Capsule 7.0'
+      tags :post_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:post_upgrade))
+    end
+  end
+end