foreman_maintain 1.3.0 → 1.3.1

data/definitions/procedures/pulp/print_remove_instructions.rb

@@ -1,16 +0,0 @@
-module Procedures::Pulp
-  class PrintRemoveInstructions < ForemanMaintain::Procedure
-    metadata do
-      description 'Print pulp 2 removal instructions'
-    end
-
-    def run
-      puts '======================================================'
-      puts 'Migration of content from Pulp 2 to Pulp3 is complete'
-      puts 'After verifying accessibility of content from clients,'
-      puts 'it is strongly recommend to run "foreman-maintain content remove-pulp2"'
-      puts 'This will remove Pulp 2, MongoDB, and all pulp2 content in /var/lib/pulp/content/'
-      puts '======================================================'
-    end
-  end
-end

data/definitions/procedures/pulp/remove.rb

@@ -1,222 +0,0 @@
-module Procedures::Pulp
-  class Remove < ForemanMaintain::Procedure
-    metadata do
-      description 'Remove pulp2'
-      param :assumeyes, 'Do not ask for confirmation', :default => false
-
-      confine do
-        check_min_version('katello-common', '4.0')
-      end
-
-      param :assume_yes, 'Run the full removal without asking.'
-    end
-
-    def sys
-      ForemanMaintain::Utils::SystemHelpers.new
-    end
-
-    def pulp_data_dirs
-      [
-        '/etc/pki/pulp/content',
-        '/var/lib/pulp/published',
-        '/var/lib/pulp/content',
-        '/var/lib/pulp/importers',
-        '/var/lib/pulp/uploads',
-        '/var/lib/mongodb/',
-        '/var/cache/pulp',
-        '/var/spool/squid'
-      ].select { |dir| File.directory?(dir) }
-    end
-
-    def pulp_data_dirs_mountpoints
-      pulp_data_dirs.select { |d| Pathname(d).mountpoint? }
-    end
-
-    def deletable_pulp_dirs
-      @deletable_pulp_dirs ||= pulp_data_dirs - pulp_data_dirs_mountpoints
-    end
-
-    # rubocop:disable  Metrics/MethodLength
-    def pulp_packages
-      possible = %w[pulp-admin-client pulp-agent pulp-consumer-client pulp-deb-admin-extensions
-                    pulp-deb-plugins pulp-docker-admin-extensions pulp-docker-plugins
-                    pulp-nodes-admin-extensions pulp-nodes-child pulp-nodes-common
-                    pulp-nodes-consumer-extensions pulp-nodes-parent pulp-ostree-admin-extensions
-                    pulp-ostree-plugins pulp-puppet-admin-extensions
-                    pulp-puppet-consumer-extensions pulp-puppet-handlers pulp-puppet-plugins
-                    pulp-puppet-tools pulp-python-admin-extensions pulp-python-plugins
-                    pulp-rpm-admin-extensions pulp-rpm-consumer-extensions pulp-rpm-handlers
-                    pulp-rpm-plugins pulp-rpm-yumplugins pulp-selinux pulp-server python-bson
-                    python-crane python-isodate python-mongoengine python-nectar
-                    python-pulp-agent-lib python-pulp-bindings python-pulp-client-lib
-                    python-pulp-common python-pulp-deb-common python-pulp-devel
-                    python-pulp-docker-common python-pulp-integrity python-pulp-manifest
-                    python-pulp-oid_validation python-pulp-ostree-common python-pulp-puppet-common
-                    python-pulp-python-common python-pulp-repoauth python-pulp-rpm-common
-                    python-pulp-streamer python-pymongo python-pymongo-gridfs python2-amqp
-                    python2-billiard python2-celery python2-debpkgr python2-django python2-kombu
-                    python2-solv python2-vine pulp-katello pulp-maintenance
-                    python3-pulp-2to3-migration]
-
-      @installed_pulp_packages ||= possible.select { |pkg| find_package(pkg) }
-      @installed_pulp_packages
-    end
-
-    def data_dir_removal_cmds(pulp_dirs)
-      pulp_dirs.map { |dir| "rm -rf #{dir}" }
-    end
-
-    def ask_to_proceed
-      rm_cmds = data_dir_removal_cmds(pulp_data_dirs)
-      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 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?"
-      answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
-      abort! if answer != :yes
-    end
-
-    def run
-      assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
-
-      ask_to_proceed unless assumeyes_val
-
-      remove_pulp if pulp_packages.any?
-
-      remove_mongo
-
-      remove_other_packages
-
-      drop_migration_tables
-
-      drop_migrations
-
-      delete_pulp_data
-
-      restart_pulpcore_services
-    end
-
-    def remove_pulp
-      with_spinner('Removing pulp2 packages') do
-        execute!("rpm -e #{pulp_packages.join('  ')}")
-      end
-    end
-
-    def remove_mongo
-      with_spinner('Removing mongo packages') do
-        packages_action(:remove, ['rh-mongodb34-*'], :assumeyes => true)
-      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)
-          BEGIN;
-          DROP TABLE IF EXISTS pulp_2to3_migration_migrationplan,
-            pulp_2to3_migration_pulp2blob,
-            pulp_2to3_migration_pulp2content,
-            pulp_2to3_migration_pulp2debcomponent,
-            pulp_2to3_migration_pulp2debcomponentpackage,
-            pulp_2to3_migration_pulp2debpackage,
-            pulp_2to3_migration_pulp2debrelease,
-            pulp_2to3_migration_pulp2debreleasearchitecture,
-            pulp_2to3_migration_pulp2distribution,
-            pulp_2to3_migration_pulp2distributor,
-            pulp_2to3_migration_pulp2distributor_pulp2_repos,
-            pulp_2to3_migration_pulp2erratum,
-            pulp_2to3_migration_pulp2importer,
-            pulp_2to3_migration_pulp2iso,
-            pulp_2to3_migration_pulp2lazycatalog,
-            pulp_2to3_migration_pulp2manifest,
-            pulp_2to3_migration_pulp2manifestlist,
-            pulp_2to3_migration_pulp2modulemd,
-            pulp_2to3_migration_pulp2modulemddefaults,
-            pulp_2to3_migration_pulp2packagecategory,
-            pulp_2to3_migration_pulp2packageenvironment,
-            pulp_2to3_migration_pulp2packagegroup,
-            pulp_2to3_migration_pulp2packagelangpacks,
-            pulp_2to3_migration_pulp2repocontent,
-            pulp_2to3_migration_pulp2repository,
-            pulp_2to3_migration_pulp2rpm,
-            pulp_2to3_migration_pulp2srpm,
-            pulp_2to3_migration_pulp2tag,
-            pulp_2to3_migration_pulp2yumrepometadatafile,
-            pulp_2to3_migration_reposetup CASCADE;
-          DROP SEQUENCE IF EXISTS pulp_2to3_migration_pulp2distributor_pulp2_repos_id_seq;
-          END;
-        SQL
-      end
-    end
-
-    def drop_migrations
-      with_spinner('Dropping migrations') do
-        feature(:pulpcore_database).psql(<<-SQL)
-          BEGIN;
-          DELETE FROM django_migrations WHERE app = 'pulp_2to3_migration';
-          DELETE FROM auth_permission WHERE content_type_id in (SELECT id FROM django_content_type WHERE app_label = 'pulp_2to3_migration');
-          DELETE FROM django_admin_log WHERE content_type_id in (SELECT id FROM django_content_type WHERE app_label = 'pulp_2to3_migration');
-          DELETE FROM django_content_type WHERE app_label = 'pulp_2to3_migration';
-          END;
-        SQL
-      end
-    end
-    # rubocop:enable Metrics/BlockLength
-
-    def delete_pulp_data
-      non_mountpoints = data_dir_removal_cmds(deletable_pulp_dirs)
-      mountpoints = pulp_data_dirs_mountpoints
-      with_spinner('') do |spinner|
-        if non_mountpoints.any?
-          spinner.update('Deleting pulp2 data directories.')
-          non_mountpoints.each do |cmd|
-            execute!(cmd)
-          end
-          msg_for_del_non_mountpoints(mountpoints, spinner)
-        end
-        if mountpoints.any?
-          msg_for_del_mountpoints(mountpoints, spinner)
-        end
-      end
-    end
-
-    def msg_for_del_non_mountpoints(mountpoints, spinner)
-      if mountpoints.empty?
-        spinner.update('Done deleting all pulp2 data directories.')
-      else
-        spinner.update("Deleted: #{deletable_pulp_dirs.join("\n")}")
-      end
-    end
-
-    def msg_for_del_mountpoints(mountpoints, spinner)
-      _, cmd_name = ForemanMaintain.pkg_and_cmd_name
-      if mountpoints.count > 1
-        spinner.update("The directories #{mountpoints.join(',')} are individual mountpoints.")
-        puts  "\nThe #{cmd_name} won't delete these directories.\n"\
-              'You need to remove content and these directories on your own.'
-      else
-        spinner.update("The directory #{mountpoints.join(',')} is individual mountpoint.")
-        puts  "\nThe #{cmd_name} won't delete the directory.\n"\
-              'You need to remove content and the directory on your own.'
-      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/restore/ensure_mongo_engine_matches.rb

@@ -1,35 +0,0 @@
-module Procedures::Restore
-  class EnsureMongoEngineMatches < ForemanMaintain::Procedure
-    metadata do
-      description 'Ensure restored MongoDB storage engine matches the current DB'
-      for_feature :mongo
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    def run
-      if feature(:mongo).local? && mongo_data_dir_exists? && engine_mismatch?
-        with_spinner('Clean MongoDB data') do |spinner|
-          feature(:service).handle_services(spinner, 'stop', :only => feature(:mongo).services)
-          spinner.update('Clean MongoDB data')
-          data_path = Dir[feature(:mongo).data_dir + '/*']
-          FileUtils.rm_rf(data_path)
-          FileUtils.rm_rf('/var/tmp/mongodb_engine_upgrade')
-          feature(:service).handle_services(spinner, 'start', :only => feature(:mongo).services)
-        end
-      end
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    private
-
-    def engine_mismatch?
-      tiger_file = File.join(feature(:mongo).data_dir, 'WiredTiger.wt')
-      config_file = feature(:mongo).core.server_config_files.first
-      File.exist?(tiger_file) && File.open(config_file).grep(/^storage.engine:\s*mmapv1/).any?
-    end
-
-    def mongo_data_dir_exists?
-      File.directory?(feature(:mongo).data_dir)
-    end
-  end
-end

data/definitions/procedures/restore/mongo_dump.rb

@@ -1,41 +0,0 @@
-module Procedures::Restore
-  class MongoDump < ForemanMaintain::Procedure
-    metadata do
-      description 'Restore mongo dump'
-      for_feature :pulp2
-      param :backup_dir,
-            'Path to backup directory',
-            :required => true
-      preparation_steps do
-        [Checks::Mongo::DBUp.new, Checks::Mongo::ToolsInstalled.new]
-      end
-      confine do
-        feature(:mongo) && feature(:pulp2)
-      end
-    end
-
-    def run
-      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
-      with_spinner('Restoring mongo dump') do |spinner|
-        handle_mongo_service('start', spinner)
-        drop_and_restore_mongo(backup, spinner)
-        handle_mongo_service('stop', spinner)
-      end
-    end
-
-    def handle_mongo_service(action, spinner)
-      if feature(:instance).database_local?(:mongo)
-        feature(:service).handle_services(spinner, action,
-                                          :only => feature(:mongo).services)
-      end
-    end
-
-    def drop_and_restore_mongo(backup, spinner)
-      spinner.update('Dropping pulp_database')
-      feature(:mongo).dropdb
-
-      spinner.update('Restoring mongo dump')
-      feature(:mongo).restore(backup.file_map[:mongo_dump][:path])
-    end
-  end
-end

data/definitions/procedures/restore/regenerate_queues.rb

@@ -1,69 +0,0 @@
-module Procedures::Restore
-  class RegenerateQueues < ForemanMaintain::Procedure
-    metadata do
-      advanced_run false
-      description 'Regenerate required activemq and/or qpidd queues while restoring online backup'
-      confine do
-        feature(:pulp2)
-      end
-    end
-
-    def qpid_router_broker_port
-      @qpid_router_broker_port ||= feature(:installer).
-                                   answers['foreman_proxy_content']['qpid_router_broker_port']
-    end
-
-    def qpid_configs
-      @qpid_configs ||= {
-        'ssl_cert' => "/etc/pki/katello/certs/#{hostname}-qpid-broker.crt",
-        'ssl_key' => "/etc/pki/katello/private/#{hostname}-qpid-broker.key",
-        'amqps_url' => "amqps://localhost:#{qpid_router_broker_port}"
-      }
-    end
-
-    def katello_events
-      %w[compliance.created
-         entitlement.created
-         entitlement.deleted
-         pool.created
-         pool.deleted]
-    end
-
-    def run
-      with_spinner('Resetting the queues') do |spinner|
-        regenerate_activemq_queues(spinner) if feature(:candlepin)
-        regenerate_qpidd_queues(spinner)
-        spinner.update('Queues created successfully')
-      end
-    end
-
-    def regenerate_activemq_queues(spinner)
-      # The activemq queues(/var/lib/candlepin/activemq-artemis) regenerate on tomcat restart.
-      # After stopping the tomcat here, service start is triggered from the restore scenario.
-      spinner.update('Stopping tomcat service')
-      feature(:candlepin).services.select(&:exist?).first.stop
-      spinner.update('Recreating activemq queues')
-      execute!('rm -rf /var/lib/candlepin/activemq-artemis/')
-    end
-
-    def run_qpid_command(opts)
-      execute!("qpid-config --ssl-certificate #{qpid_configs['ssl_cert']} \\
-                --ssl-key #{qpid_configs['ssl_key']} -b #{qpid_configs['amqps_url']} #{opts}")
-    end
-
-    def regenerate_qpidd_queues(spinner)
-      feature(:service).handle_services(spinner, 'stop', :only => ['qpidd'])
-      execute!('rm -rf /var/lib/qpidd/.qpidd/qls')
-      spinner.update('Starting qpidd service')
-      feature(:service).handle_services(spinner, 'start', :only => ['qpidd'])
-      spinner.update('Service qpidd started, waiting 60 seconds to start it completely')
-      sleep 60
-      spinner.update('Recreating qpidd queues')
-      run_qpid_command('add exchange topic event --durable')
-      run_qpid_command('add queue katello_event_queue --durable')
-      katello_events.each do |event|
-        run_qpid_command("bind event katello_event_queue #{event}")
-      end
-    end
-  end
-end

data/definitions/scenarios/content.rb

@@ -1,158 +0,0 @@
-module ForemanMaintain::Scenarios
-  module Content
-    class ContentBase < ForemanMaintain::Scenario
-      def enable_and_start_services
-        add_step(Procedures::Service::Enable.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-        add_step(Procedures::Service::Start.
-                 new(:include => Features::Pulpcore.pulpcore_migration_services))
-      end
-
-      def disable_and_stop_services
-        add_step(Procedures::Service::Stop.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-        add_step(Procedures::Service::Disable.
-                 new(:only => Features::Pulpcore.pulpcore_migration_services))
-      end
-    end
-
-    class Prepare < ContentBase
-      metadata do
-        label :content_prepare
-        description 'Prepare content for Pulp 3'
-        manual_detection
-      end
-
-      def compose
-        if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
-          enable_and_start_services
-          add_step(Procedures::Content::Prepare.new(quiet: quiet?))
-          disable_and_stop_services
-        elsif !feature(:satellite)
-          add_step(Procedures::Content::Prepare.new(quiet: quiet?))
-        end
-      end
-
-      private
-
-      def quiet?
-        !!context.get(:quiet)
-      end
-    end
-
-    class Switchover < ContentBase
-      metadata do
-        label :content_switchover
-        description 'Switch support for certain content from Pulp 2 to Pulp 3'
-        manual_detection
-      end
-
-      def compose
-        add_step_with_context(Procedures::Content::Switchover)
-        add_step(Procedures::Foreman::ApipieCache)
-      end
-    end
-
-    class PrepareAbort < ContentBase
-      metadata do
-        label :content_prepare_abort
-        description 'Abort all running Pulp 2 to Pulp 3 migration tasks'
-        manual_detection
-      end
-
-      def compose
-        if !feature(:satellite) || feature(:satellite).at_least_version?('6.9')
-          enable_and_start_services if feature(:satellite)
-          add_step(Procedures::Content::PrepareAbort)
-          disable_and_stop_services if feature(:satellite)
-        end
-      end
-    end
-
-    class MigrationStats < ContentBase
-      metadata do
-        label :content_migration_stats
-        description 'Retrieve Pulp 2 to Pulp 3 migration statistics'
-        manual_detection
-      end
-
-      def compose
-        if !feature(:satellite) || feature(:satellite).at_least_version?('6.9')
-          add_step(Procedures::Content::MigrationStats)
-        end
-      end
-    end
-
-    class MigrationReset < ContentBase
-      metadata do
-        label :content_migration_reset
-        description 'Reset the Pulp 2 to Pulp 3 migration data (pre-switchover)'
-        manual_detection
-      end
-
-      def compose
-        if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
-          enable_and_start_services
-          add_step(Procedures::Content::MigrationReset)
-          disable_and_stop_services
-        elsif !feature(:satellite)
-          add_step(Procedures::Content::MigrationReset)
-        end
-      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
-        description 'Remove Pulp2 and mongodb packages and data'
-        param :assumeyes, 'Do not ask for confirmation'
-        manual_detection
-      end
-
-      def set_context_mapping
-        context.map(:assumeyes, Procedures::Pulp::Remove => :assumeyes)
-        context.map(:assumeyes, Procedures::Content::FixPulpcoreArtifactOwnership => :assumeyes)
-      end
-
-      def compose
-        add_step_with_context(Procedures::Pulp::Remove)
-        add_step_with_context(Procedures::Content::FixPulpcoreArtifactOwnership)
-      end
-    end
-
-    class FixPulpcoreArtifactOwnership < ContentBase
-      metadata do
-        label :content_fix_pulpcore_artifact_ownership
-        description 'Fix Pulpcore artifact ownership to be pulp:pulp'
-        param :assumeyes, 'Do not ask for confirmation'
-        manual_detection
-      end
-
-      def set_context_mapping
-        context.map(:assumeyes, Procedures::Content::FixPulpcoreArtifactOwnership => :assumeyes)
-      end
-
-      def compose
-        add_step_with_context(Procedures::Content::FixPulpcoreArtifactOwnership)
-      end
-    end
-  end
-end

data/definitions/scenarios/prep_6_10_upgrade.rb

@@ -1,13 +0,0 @@
-module ForemanMaintain::Scenarios
-  class Prep610Upgrade < ForemanMaintain::Scenario
-    metadata do
-      label :prep_6_10_upgrade
-      description 'Preparations for the Satellite 6.10 upgrade'
-      manual_detection
-    end
-
-    def compose
-      add_step(Procedures::Prep610Upgrade)
-    end
-  end
-end

data/definitions/scenarios/upgrade_to_capsule_6_10.rb

@@ -1,89 +0,0 @@
-module Scenarios::Capsule_6_10
-  class Abstract < ForemanMaintain::Scenario
-    def self.upgrade_metadata(&block)
-      metadata do
-        tags :upgrade_scenario
-        confine do
-          feature(:capsule) &&
-            (feature(:capsule).current_minor_version == '6.9' || \
-            ForemanMaintain.upgrade_in_progress == '6.10')
-        end
-        instance_eval(&block)
-      end
-    end
-
-    def target_version
-      '6.10'
-    end
-  end
-
-  class PreUpgradeCheck < Abstract
-    upgrade_metadata do
-      description 'Checks before upgrading to Capsule 6.10'
-      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 => '6.10'))
-    end
-  end
-
-  class PreMigrations < Abstract
-    upgrade_metadata do
-      description 'Procedures before migrating to Capsule 6.10'
-      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 6.10'
-      tags :migrations
-    end
-
-    def set_context_mapping
-      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
-    end
-
-    def compose
-      add_step(Procedures::Repositories::Setup.new(:version => '6.10'))
-      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 6.10'
-      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 6.10'
-      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