foreman_maintain 0.6.2 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b80a6708b24b9107d23a2e88357ecd8dbaba11d3015eda0c07f2ffc34f47cc4
-  data.tar.gz: f0e5890c595b48d44f22eba1b1ac5872137669100d97465090cc12fccd7aa480
+  metadata.gz: 90eacd73fa55b32a916a21202f5505f5b23aeacb8669815807c467a1a3a59099
+  data.tar.gz: 6c5fdb1c2ced614672d721ea3eedf4fa87240be901371fb16deecfeccdb84896
 SHA512:
-  metadata.gz: 8859ccb05729eb6588465e71504918744163899025eba90c2819bd19d0e979e0e15fe199df62def03d23e1445685104f385ced535dc0ee892077affc1a54c2ba
-  data.tar.gz: 16db194cc592c4dc2c0a9212ea569e361cbac8782da5bd9500a5d0c351dc55715667a941ea8ca8f4297e5886ebda1fcf2a06a7d9d4e18b992f2431434fe47b21
+  metadata.gz: 18d9c5e18cc69d58d874201ec26366f7fb3444cb62162d61944344aa4783ecfffda9b6e232e58303df6da9cf51ea4f0e28bb7262e3b77bc0f91bc09ebaaf5412
+  data.tar.gz: 629d81c5ee075d1ce030594d5ac2bec6111c286ff4a54b7adf85c2105e146a73711e67ce2bf7279930294c225e404d9cfb4b50737e99d3648e6d5d00a5ac383b

data/README.md

@@ -48,6 +48,10 @@ Subcommands:
       stop                          Stop maintenance-mode
       status                        Get maintenance-mode status
       is-enabled                    Get maintenance-mode status code
+
+    content                       Content related commands
+      prepare                       Prepare content for Pulp 3 
+      switchover                    Switch support for certain content from Pulp 2 to Pulp 3
 ```
 
 ### Upgrades

data/definitions/checks/check_hotfix_installed.rb

@@ -4,7 +4,8 @@ class Checks::CheckHotfixInstalled < ForemanMaintain::Check
     description 'Check to verify if any hotfix installed on system'
     tags :pre_upgrade
     preparation_steps do
-      Procedures::Packages::Install.new(:packages => %w[yum-utils])
+      [Checks::Repositories::CheckNonRhRepository.new,
+       Procedures::Packages::Install.new(:packages => %w[yum-utils])]
     end
 
     confine do

data/definitions/checks/disk/performance.rb

@@ -3,9 +3,14 @@ module Checks
     class Performance < ForemanMaintain::Check
       metadata do
         label :disk_performance
-        description 'Check for recommended disk speed of pulp, mongodb, pgsql dir.'
-        tags :pre_upgrade
-        preparation_steps { Procedures::Packages::Install.new(:packages => %w[fio]) }
+        preparation_steps do
+          if feature(:instance).downstream
+            [Checks::Repositories::CheckNonRhRepository.new,
+             Procedures::Packages::Install.new(:packages => %w[fio])]
+          else
+            [Procedures::Packages::Install.new(:packages => %w[fio])]
+          end
+        end
 
         confine do
           feature(:instance).pulp
@@ -14,9 +19,6 @@ module Checks
 
       EXPECTED_IO = 60
       DEFAULT_UNIT = 'MB/sec'.freeze
-      DEFAULT_DIRS = [
-        '/var/lib/pulp', '/var/lib/mongodb', '/var/lib/pgsql'
-      ].select { |file_path| File.directory?(file_path) }.freeze
 
       attr_reader :stats
 
@@ -37,16 +39,29 @@ module Checks
         end
       end
 
+      def default_dirs
+        @default_dirs ||= %i[pulp2 pulpcore_database mongo foreman_database].inject({}) do |dirs, f|
+          if feature(f) && File.directory?(feature(f).data_dir)
+            dirs[feature(f).label_dashed] = feature(f).data_dir
+          end
+          dirs
+        end
+      end
+
+      def description
+        "Check recommended disk speed for #{default_dirs.keys.join(', ')} directories."
+      end
+
       def check_only_single_device?
-        DEFAULT_DIRS.map do |dir|
+        default_dirs.values do |dir|
           ForemanMaintain::Utils::Disk::Device.new(dir).name
         end.uniq.length <= 1
       end
 
       def dirs_to_check
-        return DEFAULT_DIRS.first(1) if check_only_single_device?
+        return default_dirs.values.first(1) if check_only_single_device?
 
-        DEFAULT_DIRS
+        default_dirs.values
       end
 
       private

data/definitions/checks/env_proxy.rb

@@ -0,0 +1,13 @@
+class Checks::EnvProxy < ForemanMaintain::Check
+  metadata do
+    label :env_proxy
+    tags :env_proxy
+    description 'Check to make sure no HTTP(S) proxy set in ENV'
+  end
+
+  def run
+    variables = %w[http_proxy https_proxy HTTP_PROXY HTTPS_PROXY]
+    has_proxy_set = true if variables.map { |variable| ENV[variable] }.compact.any?
+    assert(has_proxy_set, 'Global HTTP(S) proxy in environment (env) is set. Please unset first!')
+  end
+end

data/definitions/checks/foreman/check_corrupted_roles.rb

@@ -14,14 +14,22 @@ module Checks
       def run
         items = find_filter_permissions
         assert(items.empty?,
-               'There are user roles with inconsistent filters',
+               error_message(items),
                :next_steps => Procedures::Foreman::FixCorruptedRoles.new)
       end
 
+      def error_message(items)
+        roles = items.map { |item| item['role_name'] }.uniq
+        'There are filters having permissions with multiple resource types. ' \
+        'Roles with such filters are:' \
+        "\n#{roles.join("\n")}"
+      end
+
       def find_filter_permissions
         feature(:foreman_database).query(self.class.inconsistent_filter_perms)
       end
 
+      # rubocop:disable Metrics/MethodLength
       def self.inconsistent_filter_perms
         subquery = <<-SQL
           SELECT filters.id AS filter_id,
@@ -32,14 +40,17 @@ module Checks
                  filterings.id AS filtering_id,
                  permissions.id AS permission_id,
                  permissions.name AS permission_name,
-                 permissions.resource_type
+                 permissions.resource_type,
+                 roles.name AS role_name
           FROM filters INNER JOIN filterings ON filters.id = filterings.filter_id
                        INNER JOIN permissions ON permissions.id = filterings.permission_id
+                       INNER JOIN roles ON filters.role_id = roles.id
         SQL
 
         <<-SQL
           SELECT DISTINCT first.filter_id,
                           first.role_id,
+                          first.role_name,
                           first.filtering_id,
                           first.permission_id,
                           first.permission_name,
@@ -54,6 +65,7 @@ module Checks
                 OR (first.resource_type != second.resource_type))
         SQL
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/definitions/checks/foreman/validate_external_db_version.rb

@@ -0,0 +1,28 @@
+module Checks
+  module Foreman
+    class ValidateExternalDbVersion < ForemanMaintain::Check
+      metadata do
+        description 'Make sure server is running on required database version'
+        tags :pre_upgrade
+        label :validate_external_db_version
+        confine do
+          feature(:foreman_database) && !feature(:foreman_database).local? &&
+            !check_min_version('foreman', '2.0')
+        end
+      end
+
+      def run
+        current_db_version = feature(:foreman_database).db_version
+        fail!(db_upgrade_message(current_db_version)) if current_db_version.major < 12
+      end
+
+      def db_upgrade_message(db_version)
+        product_name = feature(:instance).product_name
+
+        "\n\n*** ERROR: Server is running on PostgreSQL #{db_version} database.\n"\
+        "*** Newer version of #{product_name} supports only PostgreSQL version 12.\n"\
+        "*** Before proceeding further, you must upgrade database to PostgreSQL 12.\n"
+      end
+    end
+  end
+end

data/definitions/checks/foreman_proxy/check_tftp_storage.rb

@@ -0,0 +1,52 @@
+module Checks::ForemanProxy
+  class CheckTftpStorage < ForemanMaintain::Check
+    metadata do
+      label :check_tftp_storage
+      description 'Clean old Kernel and initramfs files from tftp-boot'
+      tags :default
+      confine do
+        feature(:satellite) && feature(:foreman_proxy) &&
+          feature(:foreman_proxy).features.include?('tftp') && non_zero_token_duration?
+      end
+    end
+
+    def run
+      if Dir.exist?(tftp_boot_directory)
+        files = old_files_from_tftp_boot
+        assert(files.empty?,
+               'There are old initrd and vmlinuz files present in tftp',
+               :next_steps => Procedures::Files::Remove.new(:files => files))
+      else
+        skip "TFTP #{tftp_boot_directory} directory doesn't exist."
+      end
+    end
+
+    def old_files_from_tftp_boot
+      Dir.entries(tftp_boot_directory).map do |file|
+        unless File.directory?(file)
+          file_path =  tftp_boot_directory + file
+          file_path if File.mtime(file_path) + (token_duration * 60) < Time.now
+        end
+      end.compact
+    end
+
+    def self.non_zero_token_duration?
+      lookup_token_duration != 0
+    end
+
+    def tftp_boot_directory
+      @tftp_boot_directory ||= "#{feature(:foreman_proxy).tftp_root_directory}/boot/"
+    end
+
+    def token_duration
+      @token_duration ||= self.class.lookup_token_duration
+    end
+
+    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'")
+      YAML.load(data[0]['value'] || data[0]['default'])
+    end
+  end
+end

data/definitions/checks/original_assets.rb

@@ -2,6 +2,7 @@ class Checks::OriginalAssets < ForemanMaintain::Check
   metadata do
     description 'Check if only installed assets are present on the system'
     tags :post_upgrade
+    for_feature :foreman_server
   end
 
   ASSETS_DIR = '/var/lib/foreman/public/assets'.freeze

data/definitions/checks/repositories/check_non_rh_repository.rb

@@ -0,0 +1,23 @@
+module Checks::Repositories
+  class CheckNonRhRepository < ForemanMaintain::Check
+    metadata do
+      label :check_non_redhat_repository
+      description 'Check whether system has any non Red Hat repositories (e.g.: EPEL) enabled'
+      tags :pre_upgrade
+      confine do
+        feature(:instance).downstream
+      end
+    end
+
+    def run
+      with_spinner('Checking repositories enabled on the system') do
+        assert(!epel_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)
+    end
+  end
+end

data/definitions/checks/repositories/check_upstream_repository.rb

@@ -4,7 +4,8 @@ class Checks::CheckUpstreamRepository < ForemanMaintain::Check
     description 'Check if any upstream repositories are enabled on system'
     tags :pre_upgrade
     preparation_steps do
-      Procedures::Packages::Install.new(:packages => %w[yum-utils])
+      [Checks::Repositories::CheckNonRhRepository.new,
+       Procedures::Packages::Install.new(:packages => %w[yum-utils])]
     end
     confine do
       feature(:instance).downstream

data/definitions/checks/repositories/validate.rb

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

data/definitions/features/apache.rb

@@ -0,0 +1,19 @@
+class Features::Apache < ForemanMaintain::Feature
+  metadata do
+    label :apache
+
+    confine do
+      find_package('httpd')
+    end
+  end
+
+  def services
+    [
+      system_service('httpd', 30)
+    ]
+  end
+
+  def config_files
+    ['/etc/httpd']
+  end
+end

data/definitions/features/capsule.rb

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

data/definitions/features/dynflow_sidekiq.rb

@@ -13,7 +13,7 @@ class Features::DynflowSidekiq < ForemanMaintain::Feature
 
   def config_files
     # Workaround until foreman-installer can deploy scaled workers
-    service_symlinks = configured_services.map do |service|
+    service_symlinks = configured_instances.map do |service|
       "/etc/systemd/system/multi-user.target.wants/#{service}.service"
     end
     [

data/definitions/features/foreman_proxy.rb

@@ -12,6 +12,9 @@ class Features::ForemanProxy < ForemanMaintain::Feature
   FOREMAN_PROXY_DHCP_YML_PATHS = ['/etc/foreman-proxy/settings.d/dhcp.yml',
                                   '/usr/local/etc/foreman-proxy/settings.d/dhcp.yml'].freeze
 
+  FOREMAN_PROXY_TFTP_YML_PATHS = ['/etc/foreman-proxy/settings.d/tftp.yml',
+                                  '/usr/local/etc/foreman-proxy/settings.d/tftp.yml'].freeze
+
   def valid_dhcp_configs?
     dhcp_req_pass? && !syntax_error_exists?
   end
@@ -66,7 +69,7 @@ class Features::ForemanProxy < ForemanMaintain::Feature
 
     configs.push('/var/lib/tftpboot') if backup_features.include?('tftp')
     configs += ['/var/named/', '/etc/named*'] if backup_features.include?('dns')
-    if backup_features.include?('dhcp')
+    if backup_features.include?('dhcp') && dhcp_isc_provider?
       configs += ['/var/lib/dhcpd', File.dirname(dhcpd_config_file)]
     end
     configs.push('/usr/share/xml/scap') if backup_features.include?('openscap')
@@ -113,6 +116,10 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     @dhcpd_config_file ||= lookup_dhcpd_config_file
   end
 
+  def tftp_root_directory
+    @tftp_root_directory ||= lookup_tftp_root_directory
+  end
+
   private
 
   def backup_features(for_features)
@@ -209,11 +216,22 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     dhcpd_config_file
   end
 
-  def lookup_using_dhcp_yml
-    dhcp_yml_path = lookup_into(FOREMAN_PROXY_DHCP_YML_PATHS)
-    raise "Couldn't find dhcp.yml file under foreman-proxy" unless dhcp_yml_path
+  def dhcp_yml_path
+    dhcp_path = lookup_into(FOREMAN_PROXY_DHCP_YML_PATHS)
+    raise "Couldn't find dhcp.yml file under foreman-proxy" unless dhcp_path
+
+    dhcp_path
+  end
+
+  def configs_from_dhcp_yml
+    @configs_from_dhcp_yml ||= yaml_load(dhcp_yml_path)
+  end
+
+  def dhcp_isc_provider?
+    configs_from_dhcp_yml[:use_provider] == 'dhcp_isc'
+  end
 
-    configs_from_dhcp_yml = yaml_load(dhcp_yml_path)
+  def lookup_using_dhcp_yml
     if configs_from_dhcp_yml.key?(:dhcp_config)
       return configs_from_dhcp_yml[:dhcp_config]
     elsif configs_from_dhcp_yml.key?(:use_provider)
@@ -226,6 +244,13 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     end
   end
 
+  def lookup_tftp_root_directory
+    tftp_yml_path = lookup_into(FOREMAN_PROXY_TFTP_YML_PATHS)
+    raise "Couldn't find tftp.yml file under foreman-proxy" unless tftp_yml_path
+
+    yaml_load(tftp_yml_path)[:tftproot]
+  end
+
   def yaml_load(path)
     YAML.load_file(path) || {}
   end

data/definitions/features/foreman_server.rb

@@ -9,9 +9,11 @@ module ForemanMaintain
       end
 
       def services
-        [
-          system_service('httpd', 30)
-        ]
+        if execute?('systemctl is-enabled foreman')
+          [system_service('foreman', 30, :socket => 'foreman')]
+        else
+          [system_service('httpd', 30)]
+        end
       end
 
       def plugins
@@ -26,7 +28,7 @@ module ForemanMaintain
       def config_files
         [
           '/etc/httpd',
-          '/var/www/html/pub',
+          '/var/www/html/pub/katello-*',
           '/etc/squid',
           '/etc/foreman',
           '/etc/selinux/targeted/contexts/files/file_contexts.subs',
@@ -41,6 +43,10 @@ module ForemanMaintain
           '/var/lib/foreman/public'
         ]
       end
+
+      def services_running?
+        services.all?(&:running?)
+      end
     end
   end
 end

data/definitions/features/installer.rb

@@ -92,8 +92,15 @@ class Features::Installer < ForemanMaintain::Feature
   end
 
   def upgrade(exec_options = {})
-    arguments = '--upgrade' if can_upgrade?
-    run(arguments, exec_options)
+    run(installer_arguments, exec_options)
+  end
+
+  def installer_arguments
+    installer_args = ' --disable-system-checks'
+    unless check_min_version('foreman', '2.1') || check_min_version('foreman-proxy', '2.1')
+      installer_args += ' --upgrade' if can_upgrade?
+    end
+    installer_args
   end
 
   def initial_admin_username