foreman_maintain 0.7.10 → 0.7.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c02c6edfe990d37bd485aa0cb9831bab961b03e002314d1c860c676fb21916c2
-  data.tar.gz: 8762d61ebb0ef9d842f4dc32ffaf7344c909bd4c686486f0ffe7a30e8a4ae7a4
+  metadata.gz: f85f48176164ae330cdc34b3358f7a28e9db102b0a4a1a3f56096545914a80d7
+  data.tar.gz: 218abc9daddc63f1ea18f4a652fe7c0ab29471d1ba57025b6fe4bfec1ef517ee
 SHA512:
-  metadata.gz: 2dac90b49cb5e868c3cbcaef102a7b7a472ea141ab228fbbfdb7b1fbc1687509f8842b984b5b90992a42dc2afdc4d07c48aa2b699ed912c1fb7232b49d3d00a8
-  data.tar.gz: 183cc48e2535b8f569954bdc96e5328c0ef8ed595458244091912cbecf757a86507759b3470c2a8fb3ea0fab442bed79e62fc4bdb94f909191d1824c454a82d1
+  metadata.gz: 6298d9c15def6a3e6f3fca79c1a917c583f4af0bc0281559abdc96e82f15820975ad109d9443bbb412da8396a5df7b3b94a6a7a00cd28fce2b3af6cb5d97eaa0
+  data.tar.gz: e572a81b1e74edc22985ef67e8e9d9e84af85161bb78105d32617962a90ddf016447e77a17cd7299254819e9987304709f991a65a2c4b4b59a95081c5c7c2490

data/definitions/checks/disk/available_space_postgresql12.rb

@@ -0,0 +1,45 @@
+module Checks
+  module Disk
+    class AvailableSpacePostgresql12 < ForemanMaintain::Check
+      metadata do
+        label :available_space_for_postgresql12
+        description 'Check to make sure PostgreSQL 12 work directory has enough space for upgrade'
+        confine do
+          (feature(:foreman_database) || feature(:candlepin_database)) && \
+            (file_exists?('/var/lib/pgsql') && \
+            file_exists?('/var/opt/rh/rh-postgresql12'))
+        end
+      end
+
+      def run
+        assert(psql_12_available_space >= psql_9_consumed_space, warning_message, :warn => true)
+      end
+
+      def pgsql_dir(version)
+        if version == 9
+          '/var/lib/pgsql/'
+        elsif version == 12
+          '/var/opt/rh/rh-postgresql12/'
+        end
+      end
+
+      def psql_9_consumed_space
+        io_obj = ForemanMaintain::Utils::Disk::IODevice.new(pgsql_dir(9))
+        io_obj.space_used
+      end
+
+      def psql_12_available_space
+        io_obj = ForemanMaintain::Utils::Disk::IODevice.new(pgsql_dir(12))
+        io_obj.available_space
+      end
+
+      def warning_message
+        sat_version = feature(:satellite).current_version.version[0..2]
+        "Satellite #{sat_version} uses PostgreSQL 12. \nThis changes PostgreSQL "\
+        "work directory to #{pgsql_dir(12)}\n"\
+        "The new work directory requires at least #{psql_9_consumed_space}"\
+        'MiB free space for upgrade!'
+      end
+    end
+  end
+end

data/definitions/features/pulp2.rb

@@ -34,4 +34,10 @@ class Features::Pulp < ForemanMaintain::Feature
       '/etc/default/pulp_workers'
     ]
   end
+
+  def exclude_from_backup
+    # Exclude /var/lib/pulp/katello-export and /var/lib/pulp/cache
+    # since the tar is run from /var/lib/pulp, list subdir paths only
+    ['katello-export', 'cache']
+  end
 end

data/definitions/features/pulpcore.rb

@@ -11,13 +11,21 @@ class Features::Pulpcore < ForemanMaintain::Feature
   end
 
   def services
-    self.class.pulpcore_common_services + [
+    self.class.pulpcore_common_services + configured_workers + [
       system_service('rh-redis5-redis', 5),
-      system_service('pulpcore-worker@*', 20, :all => true, :skip_enablement => true),
       system_service('httpd', 30)
     ]
   end
 
+  def configured_workers
+    names = Dir['/etc/systemd/system/multi-user.target.wants/pulpcore-worker@*.service']
+    names = names.map { |f| File.basename(f) }
+    names.map do |name|
+      system_service(name, 20, :skip_enablement => true,
+                               :instance_parent_unit => 'pulpcore-worker@')
+    end
+  end
+
   def self.pulpcore_migration_services
     pulpcore_common_services + [
       ForemanMaintain::Utils.system_service('pulpcore-worker@1', 20),

data/definitions/features/service.rb

@@ -137,7 +137,7 @@ class Features::Service < ForemanMaintain::Feature
 
   def filter_disabled_services!(action, service_list)
     if %w[start stop restart status].include?(action)
-      service_list.select!(&:enabled?)
+      service_list.select! { |service| !service.respond_to?(:enabled?) || service.enabled? }
     end
     service_list
   end

data/definitions/procedures/backup/pulp.rb

@@ -30,7 +30,7 @@ module Procedures::Backup
       feature(:tar).run(
         :archive => File.join(@backup_dir, 'pulp_data.tar'),
         :command => 'create',
-        :exclude => ['var/lib/pulp/katello-export'],
+        :exclude => feature(:pulp2).exclude_from_backup,
         :listed_incremental => File.join(@backup_dir, '.pulp.snar'),
         :transform => 's,^,var/lib/pulp/,S',
         :volume_size => @tar_volume_size,

data/definitions/procedures/content/prepare.rb

@@ -3,11 +3,13 @@ module Procedures::Content
     metadata do
       description 'Prepare content for Pulp 3'
       for_feature :pulpcore
+      param :quiet, 'Keep the output on a single line', :flag => true, :default => false
     end
 
     def run
       # use interactive to get realtime output
-      puts execute!('foreman-rake katello:pulp3_migration', :interactive => true)
+      env_vars = @quiet ? '' : 'preserve_output=true '
+      puts execute!("#{env_vars}foreman-rake katello:pulp3_migration", :interactive => true)
     end
   end
 end

data/definitions/procedures/pulp/cleanup_old_metadata_files.rb

@@ -0,0 +1,75 @@
+require 'find'
+require 'rexml/document'
+
+module Procedures::Pulp
+  class CleanupOldMetadataFiles < ForemanMaintain::Procedure
+    metadata do
+      description 'Cleanup old and unneeded yum metadata files from /var/lib/pulp/'
+      confine do
+        check_max_version('katello-common', '4.0')
+      end
+      param :remove_files, 'If true, will actually delete files, otherwise will print them out.'
+    end
+
+    PULP_METADATA_DIR = '/var/lib/pulp/published/yum/master/yum_distributor/'.freeze
+    REPOMD_FILE = 'repomd.xml'.freeze
+
+    def run
+      return unless File.directory?(PULP_METADATA_DIR)
+      found = []
+
+      puts 'Warning: This command may cause reduced performance related to content operations.'
+      message = 'Locating repository metadata (this may take a while)'
+      with_spinner(message) do |spinner|
+        Find.find(PULP_METADATA_DIR) do |path|
+          next if File.basename(path) != REPOMD_FILE
+          found << path
+          spinner.update("#{message}: Found #{found.count} repos.")
+        end
+      end
+
+      found.each do |repo_md_path|
+        handle(repo_md_path, @remove_files)
+      end
+    end
+
+    def handle(repo_md_path, remove_files)
+      base_path = File.dirname(repo_md_path)
+      to_remove = list_existing_files(repo_md_path) - list_repomd_files(repo_md_path)
+
+      if to_remove.empty?
+        "Skipping #{base_path}, no files to remove."
+      elsif remove_files
+        puts '================================================================================'
+        puts "Removing #{to_remove.count} files from #{base_path}"
+        to_remove.each { |file| File.delete(File.join(base_path, file)) }
+      else
+        puts '================================================================================'
+        puts "For #{base_path} would remove, but --remove-files was not specified:"
+        to_remove.each { |file| puts "   #{file}" }
+      end
+    end
+
+    def list_repomd_files(repo_md_path)
+      doc = REXML::Document.new(File.new(repo_md_path))
+      filenames = []
+      doc.root.elements.each do |data|
+        locations = data.elements['location']
+        next unless locations
+
+        if locations.attributes
+          filenames << locations.attributes['href']
+        end
+      end
+      base_names(filenames.flatten)
+    end
+
+    def list_existing_files(repo_md_path)
+      base_names(Dir[File.dirname(repo_md_path) + '/*']) - [REPOMD_FILE]
+    end
+
+    def base_names(file_list)
+      file_list.map { |file| File.basename(file) }
+    end
+  end
+end

data/definitions/scenarios/content.rb

@@ -2,11 +2,10 @@ module ForemanMaintain::Scenarios
   module Content
     class ContentBase < ForemanMaintain::Scenario
       def enable_and_start_services
-        add_step(Procedures::Service::Start)
         add_step(Procedures::Service::Enable.
                  new(:only => Features::Pulpcore.pulpcore_migration_services))
         add_step(Procedures::Service::Start.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
+                 new(:include => Features::Pulpcore.pulpcore_migration_services))
       end
 
       def disable_and_stop_services
@@ -27,12 +26,18 @@ module ForemanMaintain::Scenarios
       def compose
         if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
           enable_and_start_services
-          add_step(Procedures::Content::Prepare)
+          add_step(Procedures::Content::Prepare.new(quiet: quiet?))
           disable_and_stop_services
         elsif !feature(:satellite)
-          add_step(Procedures::Content::Prepare)
+          add_step(Procedures::Content::Prepare.new(quiet: quiet?))
         end
       end
+
+      private
+
+      def quiet?
+        !!context.get(:quiet)
+      end
     end
 
     class Switchover < ContentBase
@@ -60,6 +65,7 @@ module ForemanMaintain::Scenarios
 
       def compose
         if !feature(:satellite) || feature(:satellite).at_least_version?('6.9')
+          enable_and_start_services if feature(:satellite)
           add_step(Procedures::Content::PrepareAbort)
         end
       end
@@ -97,6 +103,24 @@ module ForemanMaintain::Scenarios
       end
     end
 
+    class CleanupRepositoryMetadata < ContentBase
+      metadata do
+        label :cleanup_repository_metadata
+        description 'Remove old leftover repository metadata'
+        param :remove_files, 'Actually remove the files? Otherwise a dryrun is performed.'
+
+        manual_detection
+      end
+
+      def compose
+        add_step_with_context(Procedures::Pulp::CleanupOldMetadataFiles)
+      end
+
+      def set_context_mapping
+        context.map(:remove_files, Procedures::Pulp::CleanupOldMetadataFiles => :remove_files)
+      end
+    end
+
     class RemovePulp2 < ContentBase
       metadata do
         label :content_remove_pulp2

data/definitions/scenarios/upgrade_to_satellite_6_8.rb

@@ -28,6 +28,7 @@ module Scenarios::Satellite_6_8
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
       add_step(Checks::Foreman::CheckpointSegments)
+      add_step(Checks::Disk::AvailableSpacePostgresql12)
       add_step(Checks::Repositories::Validate.new(:version => '6.8'))
     end
   end

data/definitions/scenarios/upgrade_to_satellite_6_9.rb

@@ -28,6 +28,7 @@ module Scenarios::Satellite_6_9
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
       add_step(Checks::Foreman::CheckpointSegments)
+      add_step(Checks::Disk::AvailableSpacePostgresql12)
       add_step(Checks::Repositories::Validate.new(:version => '6.9'))
     end
   end

data/lib/foreman_maintain/cli/content_command.rb

@@ -2,8 +2,9 @@ module ForemanMaintain
   module Cli
     class ContentCommand < Base
       subcommand 'prepare', 'Prepare content for Pulp 3' do
+        option ['-q', '--quiet'], :flag, 'Keep the output on a single line'
         def execute
-          run_scenarios_and_exit(Scenarios::Content::Prepare.new)
+          run_scenarios_and_exit(Scenarios::Content::Prepare.new(:quiet => quiet?))
         end
       end
 
@@ -34,6 +35,17 @@ module ForemanMaintain
         end
       end
 
+      subcommand 'cleanup-repository-metadata', 'Cleanup old repository metadata under Pulp 2' do
+        option ['-r', '--remove-files'], :flag, 'Remove the files instead of just listing them.',
+               :attribute_name => :remove_files
+
+        def execute
+          run_scenarios_and_exit(
+            Scenarios::Content::CleanupRepositoryMetadata.new(:remove_files => @remove_files)
+          )
+        end
+      end
+
       subcommand 'remove-pulp2', 'Remove pulp2 and mongodb packages and data' do
         def execute
           run_scenarios_and_exit(Scenarios::Content::RemovePulp2.new)

data/lib/foreman_maintain/utils/command_runner.rb

@@ -59,12 +59,15 @@ module ForemanMaintain
 
       private
 
+      # rubocop:disable Metrics/MethodLength
       def run_interactively
         # use tmp files to capture output and exit status of the command when
         # running interactively
         log_file = Tempfile.open('captured-output')
         exit_file = Tempfile.open('captured-exit-code')
-        Kernel.system("script -qc '#{full_command}; echo $? > #{exit_file.path}' #{log_file.path}")
+        Kernel.system(
+          "bash -c '#{full_command}; echo $? > #{exit_file.path}' | tee -i #{log_file.path}"
+        )
         File.open(log_file.path) { |f| @output = f.read }
         File.open(exit_file.path) do |f|
           exit_status = f.read.strip
@@ -78,6 +81,7 @@ module ForemanMaintain
         log_file.close
         exit_file.close
       end
+      # rubocop:enable Metrics/MethodLength
 
       def run_non_interactively
         IO.popen(full_command, 'r+') do |f|

data/lib/foreman_maintain/utils/disk/io_device.rb

@@ -26,6 +26,10 @@ module ForemanMaintain
           execute!("df #{dir}|awk {'print $5'}|tail -1").to_i
         end
 
+        def space_used
+          convert_kb_to_mb(execute!("du -ks #{dir} | awk {'print $1'}").to_i)
+        end
+
         private
 
         # In fio command, --direct option bypass the cache page

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.7.10'.freeze
+  VERSION = '0.7.14'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.7.14
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -126,6 +126,7 @@ files:
 - definitions/checks/check_tmout.rb
 - definitions/checks/disk/available_space.rb
 - definitions/checks/disk/available_space_candlepin.rb
+- definitions/checks/disk/available_space_postgresql12.rb
 - definitions/checks/disk/performance.rb
 - definitions/checks/env_proxy.rb
 - definitions/checks/foreman/check_checkpoint_segments.rb
@@ -259,6 +260,7 @@ files:
 - definitions/procedures/packages/update_all_confirmation.rb
 - definitions/procedures/passenger_recycler.rb
 - definitions/procedures/prep_6_10_upgrade.rb
+- definitions/procedures/pulp/cleanup_old_metadata_files.rb
 - definitions/procedures/pulp/migrate.rb
 - definitions/procedures/pulp/remove.rb
 - definitions/procedures/pulpcore/migrate.rb