foreman_maintain 0.9.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55215ac64deedb1ab1aafcef2f6b28392b48952a9f0923be2f95706aaa26d6b4
-  data.tar.gz: 0cadfaad877d10e17658ed3650ba483a8e7b8fdd9e898d383ee3871bf88ba498
+  metadata.gz: 65892e9e2d93db0e9b4793b00743b75474ce7900cb425abe85e006cf7b6190ad
+  data.tar.gz: ee0ddd71d2dbb04805e080c60bff8a4b943122d6dd0e4c96b14401cf731fe7bf
 SHA512:
-  metadata.gz: 1b2dbeddc647b557a0196fcea8e290e29a17e92a8ab38cee7acccbc165318bdd48cc43312232f928a30a2637dc290fd629fd07cfa27cdcb1808eb70b9903b261
-  data.tar.gz: 7dc280857da4485c5312d7b5047a94f1e0084da1c7e798964d2d66d7068daaced1268d34fcda1033e4fd73a6bd8caec8fa6450da7e5fb52f81866abb58bc0e04
+  metadata.gz: df314cd4b969b7e9a71dfc3255ee6bd54ce598a42b26596ec499b866385b0838f8c455a4adc5e74acafbfd7cc733c63f072ada1d2d2af5b5473f8ba329ab77a2
+  data.tar.gz: 41f7380430eb839081e4fa70610b0ef87b733d08acfaa3573a8a4750d2e4880e650a91e415c4a04e4be9c28e828dd4e2c9d9245839a4891c50690247c62697a5

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/foreman_proxy/check_tftp_storage.rb

@@ -44,7 +44,9 @@ module Checks::ForemanProxy
     def self.lookup_token_duration
       data = feature(:foreman_database). \
              query("select s.value, s.default from settings s \
-                    where category = 'Setting::Provisioning' and name = 'token_duration'")
+                    where category IN ('Setting::Provisioning','Setting') \
+                    and name = 'token_duration'")
+
       YAML.load(data[0]['value'] || data[0]['default'])
     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/content directory'
+        label :group_ownership_check_of_pulp_content
+        manual_detection
+      end
+
+      def run
+        group_id = File.stat('/var/lib/pulp/content/').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/check_non_rh_repository.rb

@@ -11,13 +11,18 @@ module Checks::Repositories
 
     def run
       with_spinner('Checking repositories enabled on the system') do
-        assert(!epel_enabled?, 'System is subscribed to non Red Hat repositories')
+        assert(epel_not_enabled?, 'System is subscribed to non Red Hat repositories')
       end
     end
 
-    def epel_enabled?
-      system_repos = execute("yum repolist enabled -d 6 -e 0| grep -E 'Repo-baseurl|Repo-id'")
-      system_repos.to_s.match(/\bepel\b/i)
+    def epel_not_enabled?
+      system_repos = repository_manager.enabled_repos
+      system_repos.each do |repoid, repourl|
+        unless repoid.match(/\bepel\b/i).nil? || repourl.match(/\bepel\b/i).nil?
+          return false
+        end
+      end
+      true
     end
   end
 end

data/definitions/checks/repositories/check_upstream_repository.rb

@@ -14,10 +14,10 @@ class Checks::CheckUpstreamRepository < ForemanMaintain::Check
 
   def run
     with_spinner('Checking for presence of upstream repositories') do
-      enabled_upstream_repos = feature(:system_repos).upstream_repos_ids
-      assert(enabled_upstream_repos.empty?,
-             "System has upstream #{enabled_upstream_repos.join(',')} repositories enabled",
-             :next_steps => Procedures::Repositories::Disable.new(:repos => enabled_upstream_repos))
+      enabled_repo_ids = feature(:upstream_repositories).repoids_and_urls.keys
+      assert(enabled_repo_ids.empty?,
+             "System has upstream #{enabled_repo_ids.join(',')} repositories enabled",
+             :next_steps => Procedures::Repositories::Disable.new(:repos => enabled_repo_ids))
     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/upstream_repositories.rb

@@ -0,0 +1,23 @@
+class Features::UpstreamRepositories < ForemanMaintain::Feature
+  metadata do
+    label :upstream_repositories
+    description 'Feature for operations on upstream repositories'
+  end
+
+  def repoids_and_urls
+    repoids_and_urls = {}
+    repository_manager.enabled_repos.each do |repo, url|
+      repo_urls.each do |regex|
+        repoids_and_urls[repo] = url if url =~ regex
+      end
+    end
+    repoids_and_urls
+  end
+
+  private
+
+  def repo_urls
+    [%r{yum.theforeman.org\/*},
+     %r{yum.puppetlabs.com\/*}]
+  end
+end

data/definitions/procedures/pulp/remove.rb

@@ -86,6 +86,8 @@ module Procedures::Pulp
       drop_migrations
 
       delete_pulp_data(rm_cmds) if rm_cmds.any?
+
+      restart_pulpcore_services
     end
 
     def remove_pulp
@@ -168,5 +170,15 @@ module Procedures::Pulp
         spinner.update('Done deleting pulp2 data directories')
       end
     end
+
+    def restart_pulpcore_services
+      with_spinner('Restarting pulpcore services') do |spinner|
+        pulp_services = feature(:pulpcore).services
+
+        feature(:service).handle_services(spinner, 'stop', :only => pulp_services)
+        feature(:service).handle_services(spinner, 'start', :only => pulp_services)
+        spinner.update('Done restarting pulpcore services')
+      end
+    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,58 @@
+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
+      stop_applicable_services
+      if server_with_puppet? && feature(:foreman_server)
+        execute!('foreman-rake db:migrate VERSION=0 SCOPE=foreman_puppet')
+      end
+      feature(:installer).run(installer_arguments_disabling_puppet.join(' '), :interactive => false)
+      packages_action(:remove, packages_to_remove, :assumeyes => true)
+    end
+
+    private
+
+    def stop_applicable_services
+      services = []
+      services = feature(:foreman_server).services if feature(:foreman_server)
+      services << feature(:dynflow_sidekiq).services if feature(:dynflow_sidekiq)
+      Procedures::Service::Stop.new(:only => services) unless services.empty?
+    end
+
+    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 = repository_manager.enabled_repos.keys
+      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/disable.rb

@@ -1,12 +1,12 @@
 module Procedures::Repositories
   class Disable < ForemanMaintain::Procedure
     metadata do
-      param :repos, 'List of repositories to disable'
+      param :repos, 'Array of repositories to disable'
       description 'Disable repositories'
     end
     def run
       with_spinner('Disabling repositories') do
-        feature(:system_repos).disable_repos(@repos)
+        repository_manager.disable_repos(@repos)
       end
     end
   end

data/definitions/procedures/repositories/enable.rb

@@ -0,0 +1,13 @@
+module Procedures::Repositories
+  class Enable < ForemanMaintain::Procedure
+    metadata do
+      param :repos, 'Array of repositories to enable'
+      description 'Enable repositories'
+    end
+    def run
+      with_spinner('Enabling repositories') do
+        repository_manager.enable_repos(@repos)
+      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,19 +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,
+                             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)
@@ -48,6 +56,7 @@ module ForemanMaintain::Scenarios
       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] ||

data/definitions/scenarios/self_upgrade.rb

@@ -0,0 +1,102 @@
+module ForemanMaintain::Scenarios
+  class SelfUpgradeBase < ForemanMaintain::Scenario
+    def enabled_system_repos_id
+      repository_manager.enabled_repos.keys
+    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

data/definitions/scenarios/upgrade_to_capsule_7_0_z.rb

@@ -0,0 +1,89 @@
+module Scenarios::Capsule_7_0_z
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_scenario
+        confine do
+          feature(:capsule) &&
+            (feature(:capsule).current_minor_version == '7.0' || \
+              ForemanMaintain.upgrade_in_progress == '7.0.z')
+        end
+        instance_eval(&block)
+      end
+    end
+
+    def target_version
+      '7.0.z'
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Capsule 7.0.z'
+      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.z'
+      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.z'
+      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.z'
+      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.z'
+      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