foreman_maintain 1.12.4 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a99136516325dc9d13b83ddca246f197ecc63199d74cd950a582946a503fc2eb
-  data.tar.gz: c59533ff3ae35ffdece203759eef0d16b3bc67fc9bd5146b32a0988c00821770
+  metadata.gz: e99fd5f893ec24f16eaea4c20b8260cd2878bf63149ddf830c29e15f0324cda0
+  data.tar.gz: 5f1e7e90783d76b45231d393e204f2588d5b4daf46723792186aaa14d9c525d9
 SHA512:
-  metadata.gz: d2f883dfe1a9959d2790d856be260073a57a874d3d3e0fadd2c54b4eef1dbaf4979fe20070ffde6699dd2ff86dcb8733426f1eaa4a7213f1c1493a419678bc58
-  data.tar.gz: 00a9ee5352ef84dd5b36451e862eedb070806e2b6233042cc35b72a1cd43c6c483b163246f301f833f4c2f3f6edf8bfbd1379463c9cf0060adef2e3ec6fb7258
+  metadata.gz: d5c950a2a4b110d1425f071a5532010f4b704267e3bde1d082ea1bed209ccf6f82bf5d2682ebbe444679edf85eb03e4b216ed7ba298dd3a6fd73904390ddce77
+  data.tar.gz: cccf743480372ef3b39e54ab995a9be077006dfe991a799021378371b3f58db1a04cac263f70e21bcd75b87e30892d55d390af17bb59cf0c57aee63030ae0543

data/definitions/checks/candlepin/db_index.rb

@@ -0,0 +1,25 @@
+module Checks
+  module Candlepin
+    class DBIndex < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Candlepin DB indexes are OK'
+        label :candlepin_db_index
+        tags :db_index
+        for_feature :candlepin_database
+        confine do
+          feature(:candlepin_database)&.local?
+        end
+      end
+
+      def run
+        status, output = feature(:candlepin_database).amcheck
+
+        if !status.nil?
+          assert(status == 0, "Candlepin DB indexes have issues:\n#{output}")
+        else
+          skip 'amcheck is not available in this setup'
+        end
+      end
+    end
+  end
+end

data/definitions/checks/foreman/db_index.rb

@@ -0,0 +1,25 @@
+module Checks
+  module Foreman
+    class DBIndex < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Foreman DB indexes are OK'
+        label :foreman_db_index
+        tags :db_index
+        for_feature :foreman_database
+        confine do
+          feature(:foreman_database)&.local?
+        end
+      end
+
+      def run
+        status, output = feature(:foreman_database).amcheck
+
+        if !status.nil?
+          assert(status == 0, "Foreman DB indexes have issues:\n#{output}")
+        else
+          skip 'amcheck is not available in this setup'
+        end
+      end
+    end
+  end
+end

data/definitions/checks/pulpcore/db_index.rb

@@ -0,0 +1,25 @@
+module Checks
+  module Pulpcore
+    class DBIndex < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Pulpcore DB indexes are OK'
+        label :pulpcore_db_index
+        tags :db_index
+        for_feature :pulpcore_database
+        confine do
+          feature(:pulpcore_database)&.local?
+        end
+      end
+
+      def run
+        status, output = feature(:pulpcore_database).amcheck
+
+        if !status.nil?
+          assert(status == 0, "Pulpcore DB indexes have issues:\n#{output}")
+        else
+          skip 'amcheck is not available in this setup'
+        end
+      end
+    end
+  end
+end

data/definitions/checks/restore/validate_backup.rb

@@ -41,31 +41,26 @@ module Checks::Restore
 
     def required_katello_files(backup)
       backup_files_message(
-        backup.katello_online_files.join(', '),
-        backup.katello_offline_files.join(', ')
+        backup.katello_online_files.join(', ')
       )
     end
 
     def required_fpc_files(backup)
       backup_files_message(
-        backup.fpc_online_files.join(', '),
-        backup.fpc_offline_files.join(', ')
+        backup.fpc_online_files.join(', ')
       )
     end
 
     def required_foreman_files(backup)
       backup_files_message(
-        backup.foreman_online_files.join(', '),
-        backup.foreman_offline_files.join(', ')
+        backup.foreman_online_files.join(', ')
       )
     end
 
-    def backup_files_message(online_files, offline_files)
+    def backup_files_message(online_files)
       message = ''
-      message += 'An online or remote database backup directory contains: '
+      message += 'A backup directory contains: '
       message += "#{online_files}\n"
-      message += 'An offline backup directory contains: '
-      message += "#{offline_files}\n"
       message
     end
   end

data/definitions/checks/system_registration.rb

@@ -10,9 +10,11 @@ class Checks::SystemRegistration < ForemanMaintain::Check
   end
 
   def run
-    if rhsm_hostname_eql_hostname?
-      warn! 'System is self registered'
-    end
+    assert(!rhsm_hostname_eql_hostname?, 'System is self registered',
+      {
+        :warn => true,
+        :next_steps => [Procedures::KnowledgeBaseArticle.new(:doc => 'self_registered')],
+      })
   end
 
   def rhsm_hostname

data/definitions/procedures/knowledge_base_article.rb

@@ -26,6 +26,7 @@ class Procedures::KnowledgeBaseArticle < ForemanMaintain::Procedure
       'fix_cpdb_validate_failure' => 'https://access.redhat.com/solutions/3362821',
       'fix_db_migrate_failure_on_duplicate_roles' => 'https://access.redhat.com/solutions/3998941',
       'many_fact_values' => 'https://access.redhat.com/solutions/4163891',
+      'self_registered' => 'https://access.redhat.com/solutions/3225941',
     }
   end
 end

data/definitions/procedures/restore/extract_files.rb

@@ -15,10 +15,6 @@ module Procedures::Restore
           spinner.update('Extracting pulp data')
           extract_pulp_data(backup)
         end
-        if backup.file_map[:pgsql_data][:present]
-          spinner.update('Extracting pgsql data')
-          extract_pgsql_data(backup)
-        end
       end
     end
 
@@ -51,19 +47,5 @@ module Procedures::Restore
     def any_database
       feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database)
     end
-
-    def extract_pgsql_data(backup)
-      pgsql_data_tar = base_tar.merge(
-        :archive => backup.file_map[:pgsql_data][:path],
-        :gzip => true
-      )
-      feature(:tar).run(pgsql_data_tar)
-      del_data_dir_param if el?
-    end
-
-    def del_data_dir_param
-      # workaround for https://tickets.puppetlabs.com/browse/MODULES-11160
-      execute("sed -i '/data_directory/d' #{any_database.postgresql_conf}")
-    end
   end
 end

data/definitions/scenarios/backup.rb

@@ -18,8 +18,9 @@ module ForemanMaintain::Scenarios
 
     def compose
       check_valid_strategy
-      add_step_with_context(Checks::Backup::IncrementalParentType,
-        :online_backup => strategy == :online)
+      add_step(Checks::Foreman::DBIndex)
+      add_step(Checks::Candlepin::DBIndex)
+      add_step(Checks::Pulpcore::DBIndex)
       add_step(Checks::ForemanTasks::NotRunning.new(:wait_for_tasks => wait_for_tasks?))
       add_step(Checks::Pulpcore::NoRunningTasks.new(:wait_for_tasks => wait_for_tasks?))
       add_step_with_context(Procedures::Backup::AccessibilityConfirmation) if strategy == :offline
@@ -55,7 +56,6 @@ module ForemanMaintain::Scenarios
       context.map(:preserve_dir,
         Procedures::Backup::PrepareDirectory => :preserve_dir)
       context.map(:incremental_dir,
-        Checks::Backup::IncrementalParentType => :incremental_dir,
         Procedures::Backup::PrepareDirectory => :incremental_dir,
         Procedures::Backup::Metadata => :incremental_dir)
       context.map(:proxy_features,

data/definitions/scenarios/restore.rb

@@ -34,18 +34,13 @@ module ForemanMaintain::Scenarios
         add_steps_with_context(Procedures::Restore::InstallerReset)
       end
       add_step_with_context(Procedures::Service::Stop)
-      add_steps_with_context(Procedures::Restore::ExtractFiles) if backup.tar_backups_exist?
 
       if backup.sql_needs_dump_restore?
         add_steps_with_context(Procedures::Restore::DropDatabases)
         restore_sql_dumps(backup)
       end
 
-      if feature(:instance).postgresql_local? &&
-         !backup.online_backup? &&
-         backup.different_source_os?
-        add_step_with_context(Procedures::Restore::ReindexDatabases)
-      end
+      add_steps_with_context(Procedures::Restore::ExtractFiles) if backup.tar_backups_exist?
 
       add_step(Procedures::Installer::Run.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::UpgradeRakeTask)

data/lib/foreman_maintain/concerns/base_database.rb

@@ -140,6 +140,40 @@ module ForemanMaintain
                 ' Make sure system has psql utility installed.'
       end
 
+      def amcheck
+        # executing the check requires superuser privileges
+        return unless local?
+
+        return unless amcheck_installed?
+
+        psqlcmd = "runuser - postgres -c 'psql --set=ON_ERROR_STOP=on #{configuration['database']}'"
+
+        amcheck_query = <<~SQL
+          SELECT bt_index_check(index => c.oid, heapallindexed => i.indisunique),
+               c.relname,
+               c.relpages
+          FROM pg_index i
+          JOIN pg_opclass op ON i.indclass[0] = op.oid
+          JOIN pg_am am ON op.opcmethod = am.oid
+          JOIN pg_class c ON i.indexrelid = c.oid
+          JOIN pg_namespace n ON c.relnamespace = n.oid
+          WHERE am.amname = 'btree' AND n.nspname = 'public'
+          -- Don't check temp tables, which may be from another session:
+          AND c.relpersistence != 't'
+          -- Function may throw an error when this is omitted:
+          AND c.relkind = 'i' AND i.indisready AND i.indisvalid
+          ORDER BY c.relpages DESC;
+        SQL
+
+        execute_with_status(psqlcmd, :stdin => amcheck_query)
+      end
+
+      def amcheck_installed?
+        sql = "select 'amcheck_installed' from pg_extension where extname='amcheck'"
+        result = query(sql)
+        !result.nil? && !result.empty?
+      end
+
       private
 
       def base_env

data/lib/foreman_maintain/utils/backup.rb

@@ -7,9 +7,8 @@ module ForemanMaintain
     class Backup
       include Concerns::SystemHelpers
 
-      attr_accessor :standard_files, :katello_online_files, :katello_offline_files,
-        :foreman_online_files, :foreman_offline_files, :fpc_offline_files,
-        :fpc_online_files
+      attr_accessor :standard_files, :katello_online_files,
+        :foreman_online_files, :fpc_online_files
 
       ONLINE_BACKUP = 'online'.freeze
       OFFLINE_BACKUP = 'offline'.freeze
@@ -19,16 +18,12 @@ module ForemanMaintain
         @backup_dir = backup_dir
         @standard_files = ['config_files.tar.gz']
         @foreman_online_files = ['foreman.dump']
-        @foreman_offline_files = ['pgsql_data.tar.gz']
         @katello_online_files = @foreman_online_files + ['candlepin.dump', 'pulpcore.dump']
-        @katello_offline_files = ['pgsql_data.tar.gz']
         @fpc_online_files = ['pulpcore.dump']
-        @fpc_offline_files = ['pgsql_data.tar.gz']
       end
 
       def file_map
         @file_map ||= {
-          :pgsql_data => map_file(@backup_dir, 'pgsql_data.tar.gz'),
           :pulp_data => map_file(@backup_dir, 'pulp_data.tar'),
           :foreman_dump => map_file(@backup_dir, 'foreman.dump'),
           :iop_advisor_dump => map_file(@backup_dir, 'iop_advisor.dump'),
@@ -72,15 +67,15 @@ module ForemanMaintain
       end
 
       def valid_fpc_backup?
-        fpc_online_backup? || fpc_standard_backup?
+        fpc_online_backup?
       end
 
       def valid_katello_backup?
-        katello_online_backup? || katello_standard_backup?
+        katello_online_backup?
       end
 
       def valid_foreman_backup?
-        foreman_standard_backup? || foreman_online_backup?
+        foreman_online_backup?
       end
 
       def check_file_existence(existence_map)
@@ -99,41 +94,22 @@ module ForemanMaintain
         true
       end
 
-      def katello_standard_backup?
-        present = [:pgsql_data]
-        absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
-        check_file_existence(:present => present,
-          :absent => absent)
-      end
-
       def katello_online_backup?
         present = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
-        absent = [:pgsql_data]
-        check_file_existence(:present => present,
-          :absent => absent)
-      end
-
-      def fpc_standard_backup?
-        present = [:pgsql_data]
-        absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
+        absent = []
         check_file_existence(:present => present,
           :absent => absent)
       end
 
       def fpc_online_backup?
         present = [:pulpcore_dump]
-        absent = [:pgsql_data, :candlepin_dump, :foreman_dump]
+        absent = [:candlepin_dump, :foreman_dump]
         check_file_existence(:present => present, :absent => absent)
       end
 
-      def foreman_standard_backup?
-        check_file_existence(:present => [:pgsql_data],
-          :absent => [:candlepin_dump, :foreman_dump, :pulpcore_dump])
-      end
-
       def foreman_online_backup?
         check_file_existence(:present => [:foreman_dump],
-          :absent => [:candlepin_dump, :pgsql_data, :pulpcore_dump])
+          :absent => [:candlepin_dump, :pulpcore_dump])
       end
 
       def validate_hostname?
@@ -174,12 +150,7 @@ module ForemanMaintain
       end
 
       def tar_backups_exist?
-        file_map[:pulp_data][:present] ||
-          file_map[:pgsql_data][:present]
-      end
-
-      def sql_tar_files_exist?
-        file_map[:pgsql_data][:present]
+        file_map[:pulp_data][:present]
       end
 
       def sql_dump_files_exist?
@@ -189,7 +160,7 @@ module ForemanMaintain
       end
 
       def sql_needs_dump_restore?
-        !sql_tar_files_exist? && sql_dump_files_exist?
+        sql_dump_files_exist?
       end
 
       def incremental?

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.12.4'.freeze
+  VERSION = '1.13.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.12.4
+  version: 1.13.0
 platform: ruby
 authors:
 - Ivan Nečas
@@ -156,7 +156,7 @@ files:
 - config/foreman_maintain.yml.packaging
 - config/hammer.yml.example
 - definitions/checks/backup/certs_tar_exist.rb
-- definitions/checks/backup/incremental_parent_type.rb
+- definitions/checks/candlepin/db_index.rb
 - definitions/checks/candlepin/db_up.rb
 - definitions/checks/check_hotfix_installed.rb
 - definitions/checks/check_ipv6_disable.rb
@@ -174,6 +174,7 @@ files:
 - definitions/checks/foreman/check_external_db_evr_permissions.rb
 - definitions/checks/foreman/check_puppet_capsules.rb
 - definitions/checks/foreman/check_tuning_requirements.rb
+- definitions/checks/foreman/db_index.rb
 - definitions/checks/foreman/db_up.rb
 - definitions/checks/foreman/facts_names.rb
 - definitions/checks/foreman/validate_external_db_version.rb
@@ -193,6 +194,7 @@ files:
 - definitions/checks/maintenance_mode/check_consistency.rb
 - definitions/checks/non_rh_packages.rb
 - definitions/checks/package_manager/dnf/validate_dnf_config.rb
+- definitions/checks/pulpcore/db_index.rb
 - definitions/checks/pulpcore/db_up.rb
 - definitions/checks/pulpcore/no_running_tasks.rb
 - definitions/checks/puppet/verify_no_empty_cacert_requests.rb
@@ -319,7 +321,6 @@ files:
 - definitions/procedures/restore/iop_vmaas_dump.rb
 - definitions/procedures/restore/iop_vulnerability_dump.rb
 - definitions/procedures/restore/pulpcore_dump.rb
-- definitions/procedures/restore/reindex_databases.rb
 - definitions/procedures/restore/required_packages.rb
 - definitions/procedures/service/base.rb
 - definitions/procedures/service/daemon_reload.rb

data/definitions/checks/backup/incremental_parent_type.rb

@@ -1,33 +0,0 @@
-module Checks::Backup
-  class IncrementalParentType < ForemanMaintain::Check
-    metadata do
-      description 'Check if the incremental backup has the right type'
-      tags :backup
-      param :incremental_dir, 'Path to existing backup directory'
-      param :online_backup, 'Select for online backup', :flag => true, :default => false
-      manual_detection
-    end
-
-    def run
-      return unless @incremental_dir
-
-      backup = ForemanMaintain::Utils::Backup.new(@incremental_dir)
-
-      existing_type = backup.backup_type
-      new_type = if @online_backup
-                   ForemanMaintain::Utils::Backup::ONLINE_BACKUP
-                 else
-                   ForemanMaintain::Utils::Backup::OFFLINE_BACKUP
-                 end
-      msg = "The existing backup is an #{existing_type} backup, "\
-        "but an #{new_type} backup was requested."
-      assert(existing_type == new_type, msg)
-
-      unless @online_backup
-        msg = "The existing backup has PostgreSQL as a tarball, "\
-          "but the new one will have a dump."
-        assert(!backup.sql_tar_files_exist?, msg)
-      end
-    end
-  end
-end

data/definitions/procedures/restore/reindex_databases.rb

@@ -1,28 +0,0 @@
-module Procedures::Restore
-  class ReindexDatabases < ForemanMaintain::Procedure
-    include ForemanMaintain::Concerns::SystemService
-    include ForemanMaintain::Concerns::SystemHelpers
-
-    metadata do
-      description 'REINDEX databases'
-
-      confine do
-        feature(:instance).postgresql_local?
-      end
-    end
-
-    def run
-      with_spinner('Reindexing the databases') do |spinner|
-        feature(:service).handle_services(spinner, 'start', :only => ['postgresql'])
-
-        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
-end