foreman_maintain 0.8.9 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 627ca822992f4ebce185a35f038a9b4b9f0c9749912a37ee57857f16f62ea3e1
-  data.tar.gz: 64db438426e80728d1af4fa78ceae5686b14662e67bdec2f7dc7306c757d342c
+  metadata.gz: 89971a91002aac54e075713715691d77d7b715b58533f51e3289694cda83aa20
+  data.tar.gz: 2f0a7a2df838bf960b3ab131600d5845eec38151ef63c0bf3e510da4d207d971
 SHA512:
-  metadata.gz: 873b36bc6253d38f1ff14b1088dc07a2f074be14c22c97ddf6f770339be344cea9573d5ce054234d382bccd470ec490bac97a5768a9c09eb741db406c3a008ec
-  data.tar.gz: d8e883448c1cae33233dcbe2ec68a0788ab01ed614fba3cf312172caff3986f81826059d5a5c95f1a95dab1deb0eecfaf006d77affaf43ebe794e8317639db72
+  metadata.gz: 5234f5d84ff2de5c3857493ab3c52a2f3c7bc03b96f68ba1122d1531ce086937072b7b4d20251ce7716dc81638d64bb95e74331031718c6899b247c3fc7ea561
+  data.tar.gz: 8ff4f8dfc0e233ef91639e6fbd02d7e74bda85dee490a1e1b7a47aa68d2eade50e5e4f581ca851f6f148b25344959650c78dd2103e1d32be044ba7c170ce4ff5

data/definitions/checks/puppet/warn_about_puppet_removal.rb

@@ -0,0 +1,35 @@
+module Checks::Puppet
+  class WarnAboutPuppetRemoval < ForemanMaintain::Check
+    metadata do
+      description 'Warn about Puppet content removal prior to 6.10 upgrade'
+      label :warn_before_puppet_removal
+      confine do
+        feature(:instance).downstream &&
+          feature(:instance).downstream.current_minor_version == '6.9'
+      end
+    end
+
+    def run
+      message = "Puppet repositories found!\n"\
+                "Upgrading to 6.10 will delete the Puppet repositories\n"\
+                "if any of the following conditions are met,\n"\
+                "1. Any Puppet repositories in Library lifecycle environment.\n"\
+                "2. Unpublished content view's Puppet repositories.\n\n"\
+                "Note: Any Puppet content that is in use by hosts will not be deleted.\n"\
+                "After the upgrade, hosts will continue to use the Puppet modules,\n"\
+                'but future Puppet content management '\
+                "must be handled outside of the Satellite!\n\n"\
+                'Do you want to proceed?'
+      if puppet_repos_available?
+        answer = ask_decision(message, actions_msg: 'y(yes), n(no)')
+        exit 0 unless answer == :yes
+      end
+    end
+
+    def puppet_repos_available?
+      hammer_cmd = '--output json repository list --fields name --content-type puppet'
+      puppet_repos = feature(:hammer).run(hammer_cmd)
+      !JSON.parse(puppet_repos).empty?
+    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/procedures/pulp/remove.rb

@@ -58,7 +58,8 @@ module Procedures::Pulp
     def ask_to_proceed(rm_cmds)
       question = "\nWARNING: All pulp2 packages will be removed with the following commands:\n"
       question += "\n# rpm -e #{pulp_packages.join('  ')}" if pulp_packages.any?
-      question += "\n# yum remove rh-mongodb34-*" \
+      question += "\n# yum remove rh-mongodb34-*"
+      question += "\n# yum remove squid mod_wsgi" \
         "\n\nAll pulp2 data will be removed.\n"
       question += rm_cmds.collect { |cmd| "\n# #{cmd}" }.join
       question += "\n\nDo you want to proceed?"
@@ -77,6 +78,8 @@ module Procedures::Pulp
 
       remove_mongo
 
+      remove_other_packages
+
       drop_migration_tables
 
       drop_migrations
@@ -96,6 +99,12 @@ module Procedures::Pulp
       end
     end
 
+    def remove_other_packages
+      with_spinner('Removing additional packages') do
+        packages_action(:remove, %w[squid mod_wsgi], :assumeyes => true)
+      end
+    end
+
     def drop_migration_tables
       with_spinner('Dropping migration tables') do
         feature(:pulpcore_database).psql(<<-SQL)

data/definitions/scenarios/content.rb

@@ -98,6 +98,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_10.rb

@@ -25,6 +25,7 @@ module Scenarios::Satellite_6_10
     end
 
     def compose
+      add_step(Checks::Puppet::WarnAboutPuppetRemoval)
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
       add_step(Checks::Foreman::CheckpointSegments)

data/lib/foreman_maintain/cli/content_command.rb

@@ -34,6 +34,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
         interactive_option(%w[assumeyes plaintext])
         def execute

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.8.9'.freeze
+  VERSION = '0.8.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.8.10
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -154,6 +154,7 @@ files:
 - definitions/checks/pulpcore/db_up.rb
 - definitions/checks/puppet/provide_upgrade_guide.rb
 - definitions/checks/puppet/verify_no_empty_cacert_requests.rb
+- definitions/checks/puppet/warn_about_puppet_removal.rb
 - definitions/checks/remote_execution/verify_settings_file_already_exists.rb
 - definitions/checks/repositories/check_non_rh_repository.rb
 - definitions/checks/repositories/check_upstream_repository.rb
@@ -262,6 +263,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/print_remove_instructions.rb
 - definitions/procedures/pulp/remove.rb