foreman_maintain 0.6.0 → 0.6.5

data/definitions/procedures/restore/extract_files.rb

@@ -29,6 +29,7 @@ module Procedures::Restore
     def base_tar
       {
         :overwrite => true,
+        :absolute_names => true,
         :listed_incremental => '/dev/null',
         :command => 'extract',
         :directory => '/'

data/definitions/procedures/restore/pulpcore_dump.rb

@@ -0,0 +1,30 @@
+module Procedures::Restore
+  class PulpcoreDump < ForemanMaintain::Procedure
+    metadata do
+      description 'Restore pulpcore postgresql dump from backup'
+      param :backup_dir,
+            'Path to backup directory',
+            :required => true
+      preparation_steps { Checks::Pulpcore::DBUp.new }
+      confine do
+        feature(:pulpcore_database)
+      end
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+
+      with_spinner('Restoring pulpcore postgresql dump') do |spinner|
+        restore_pulpcore_dump(backup, spinner)
+      end
+    end
+
+    def restore_pulpcore_dump(backup, spinner)
+      if backup.file_map[:pulpcore_dump][:present]
+        spinner.update('Restoring pulpcore dump')
+        local = feature(:pulpcore_database).local?
+        feature(:pulpcore_database).restore_dump(backup.file_map[:pulpcore_dump][:path], local)
+      end
+    end
+  end
+end

data/definitions/procedures/restore/regenerate_queues.rb

@@ -0,0 +1,69 @@
+module Procedures::Restore
+  class RegenerateQueues < ForemanMaintain::Procedure
+    metadata do
+      advanced_run false
+      description 'Regenerate required activemq and 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)
+        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/procedures/service/stop.rb

@@ -8,7 +8,7 @@ module Procedures::Service
     end
 
     def run
-      run_service_action('stop', common_options)
+      run_service_action('stop', common_options.merge(:include_sockets => true))
     end
   end
 end

data/definitions/scenarios/backup.rb

@@ -51,12 +51,15 @@ module ForemanMaintain::Scenarios
                   Procedures::Backup::Online::PgGlobalObjects => :backup_dir,
                   Procedures::Backup::Online::CandlepinDB => :backup_dir,
                   Procedures::Backup::Online::ForemanDB => :backup_dir,
+                  Procedures::Backup::Online::PulpcoreDB => :backup_dir,
                   Procedures::Backup::Offline::CandlepinDB => :backup_dir,
                   Procedures::Backup::Offline::ForemanDB => :backup_dir,
+                  Procedures::Backup::Offline::PulpcoreDB => :backup_dir,
                   Procedures::Backup::Offline::Mongo => :backup_dir,
                   Procedures::Backup::Snapshot::LogicalVolumeConfirmation => :backup_dir,
                   Procedures::Backup::Snapshot::MountCandlepinDB => :backup_dir,
                   Procedures::Backup::Snapshot::MountForemanDB => :backup_dir,
+                  Procedures::Backup::Snapshot::MountPulpcoreDB => :backup_dir,
                   Procedures::Backup::Snapshot::MountMongo => :backup_dir)
       context.map(:preserve_dir,
                   Checks::Backup::DirectoryReady => :preserve_dir,
@@ -73,15 +76,18 @@ module ForemanMaintain::Scenarios
                   Procedures::Backup::Snapshot::CleanMount => :mount_dir,
                   Procedures::Backup::Snapshot::MountCandlepinDB => :mount_dir,
                   Procedures::Backup::Snapshot::MountForemanDB => :mount_dir,
+                  Procedures::Backup::Snapshot::MountPulpcoreDB => :mount_dir,
                   Procedures::Backup::Offline::Mongo => :mount_dir,
                   Procedures::Backup::Pulp => :mount_dir,
                   Procedures::Backup::Offline::CandlepinDB => :mount_dir,
-                  Procedures::Backup::Offline::ForemanDB => :mount_dir)
+                  Procedures::Backup::Offline::ForemanDB => :mount_dir,
+                  Procedures::Backup::Offline::PulpcoreDB => :mount_dir)
       context.map(:snapshot_block_size,
                   Procedures::Backup::Snapshot::MountMongo => :block_size,
                   Procedures::Backup::Snapshot::MountPulp => :block_size,
                   Procedures::Backup::Snapshot::MountForemanDB => :block_size,
-                  Procedures::Backup::Snapshot::MountCandlepinDB => :block_size)
+                  Procedures::Backup::Snapshot::MountCandlepinDB => :block_size,
+                  Procedures::Backup::Snapshot::MountPulpcoreDB => :block_size)
       context.map(:skip_pulp_content,
                   Procedures::Backup::Pulp => :skip,
                   Procedures::Backup::Snapshot::LogicalVolumeConfirmation => :skip_pulp,
@@ -135,6 +141,7 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Offline::Mongo,
         Procedures::Backup::Offline::CandlepinDB,
         Procedures::Backup::Offline::ForemanDB,
+        Procedures::Backup::Offline::PulpcoreDB,
         Procedures::Service::Start,
         find_procedures(:maintenance_mode_off)
       )
@@ -150,6 +157,9 @@ module ForemanMaintain::Scenarios
       if feature(:instance).database_local?(:foreman_database)
         add_step_with_context(Procedures::Backup::Online::ForemanDB)
       end
+      if feature(:instance).database_local?(:pulpcore_database)
+        add_step_with_context(Procedures::Backup::Online::PulpcoreDB)
+      end
       if feature(:instance).database_local?(:mongo)
         add_step_with_context(Procedures::Backup::Online::Mongo)
       end
@@ -168,6 +178,7 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Snapshot::MountPulp,
         Procedures::Backup::Snapshot::MountCandlepinDB,
         Procedures::Backup::Snapshot::MountForemanDB,
+        Procedures::Backup::Snapshot::MountPulpcoreDB,
         Procedures::Service::Start,
         find_procedures(:maintenance_mode_off),
         Procedures::Backup::Pulp
@@ -178,6 +189,9 @@ module ForemanMaintain::Scenarios
       if feature(:instance).database_local?(:foreman_database)
         add_step_with_context(Procedures::Backup::Offline::ForemanDB)
       end
+      if feature(:instance).database_local?(:pulpcore_database)
+        add_step_with_context(Procedures::Backup::Offline::PulpcoreDB)
+      end
       if feature(:instance).database_local?(:mongo)
         add_step_with_context(Procedures::Backup::Offline::Mongo)
       end
@@ -186,14 +200,17 @@ module ForemanMaintain::Scenarios
     # rubocop:enable  Metrics/MethodLength
 
     def add_online_backup_steps
-      add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true)
+      add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true,
+                                                             :online_backup => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
       add_steps_with_context(
         Procedures::Backup::Online::Mongo,
         Procedures::Backup::Online::PgGlobalObjects,
         Procedures::Backup::Online::CandlepinDB,
-        Procedures::Backup::Online::ForemanDB
+        Procedures::Backup::Online::ForemanDB,
+        Procedures::Backup::Online::PulpcoreDB
       )
+      add_step_with_context(Procedures::Backup::Metadata, :online_backup => true)
     end
 
     def strategy

data/definitions/scenarios/content.rb

@@ -0,0 +1,27 @@
+module ForemanMaintain::Scenarios
+  module Content
+    class Prepare < ForemanMaintain::Scenario
+      metadata do
+        label :content_prepare
+        description 'Prepare content for Pulp 3'
+        manual_detection
+      end
+
+      def compose
+        add_step(Procedures::Content::Prepare)
+      end
+    end
+
+    class Switchover < ForemanMaintain::Scenario
+      metadata do
+        label :content_switchover
+        description 'Switch support for certain content from Pulp 2 to Pulp 3'
+        manual_detection
+      end
+
+      def compose
+        add_step(Procedures::Content::Switchover)
+      end
+    end
+  end
+end

data/definitions/scenarios/packages.rb

@@ -1,5 +1,16 @@
 module ForemanMaintain::Scenarios
   module Packages
+    def self.skip_installer_run?(packages_list)
+      packages_list = packages_list.split(',').map(&:strip) if packages_list.is_a?(String)
+
+      return false unless packages_list.any? { |p| p.include?('foreman_maintain') }
+      return true if packages_list.length == 1
+
+      fm_pkg = ForemanMaintain.main_package_name
+      puts "ERROR: install or update '#{fm_pkg}' package individually."
+      exit 1
+    end
+
     class Status < ForemanMaintain::Scenario
       metadata do
         label :packages_status
@@ -45,13 +56,17 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        add_step_with_context(Procedures::Packages::InstallerConfirmation)
-        add_step_with_context(Procedures::Packages::UnlockVersions)
-        add_step_with_context(Procedures::Packages::Install,
-                              :force => true, :warn_on_errors => true)
-        add_step_with_context(Procedures::Installer::Run,
-                              :arguments => '--upgrade --disable-system-checks')
-        add_step(Procedures::Packages::LockingStatus)
+        if Packages.skip_installer_run?(context.get(:packages))
+          add_step_with_context(Procedures::Packages::Install,
+                                :force => true, :warn_on_errors => true)
+        else
+          add_step_with_context(Procedures::Packages::InstallerConfirmation)
+          add_step_with_context(Procedures::Packages::UnlockVersions)
+          add_step_with_context(Procedures::Packages::Install,
+                                :force => true, :warn_on_errors => true)
+          add_step_with_context(Procedures::Installer::Upgrade)
+          add_step(Procedures::Packages::LockingStatus)
+        end
       end
 
       def set_context_mapping
@@ -71,17 +86,26 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        add_step_with_context(Procedures::Packages::InstallerConfirmation)
-        add_step_with_context(Procedures::Packages::UnlockVersions)
-        add_step_with_context(Procedures::Packages::Update, :force => true, :warn_on_errors => true)
-        add_step_with_context(Procedures::Installer::Run,
-                              :arguments => '--upgrade --disable-system-checks')
-        add_step(Procedures::Packages::LockingStatus)
+        if Packages.skip_installer_run?(context.get(:packages))
+          add_step_with_context(Procedures::Packages::Update,
+                                :force => true, :warn_on_errors => true)
+        else
+          add_steps_with_context(
+            Procedures::Packages::UpdateAllConfirmation,
+            Procedures::Packages::InstallerConfirmation,
+            Procedures::Packages::UnlockVersions
+          )
+          add_step_with_context(Procedures::Packages::Update,
+                                :force => true, :warn_on_errors => true)
+          add_step_with_context(Procedures::Installer::Upgrade)
+          add_step(Procedures::Packages::LockingStatus)
+        end
       end
 
       def set_context_mapping
         context.map(:packages,
-                    Procedures::Packages::Update => :packages)
+                    Procedures::Packages::Update => :packages,
+                    Procedures::Packages::UpdateAllConfirmation => :packages)
         context.map(:assumeyes,
                     Procedures::Packages::Update => :assumeyes)
       end

data/definitions/scenarios/restore.rb

@@ -36,14 +36,18 @@ module ForemanMaintain::Scenarios
       end
       restore_mongo_dump(backup)
       add_steps_with_context(Procedures::Pulp::Migrate,
-                             Procedures::Service::Start,
+                             Procedures::Pulpcore::Migrate)
+
+      add_steps_with_context(Procedures::Restore::RegenerateQueues) if backup.online_backup?
+      add_steps_with_context(Procedures::Service::Start,
                              Procedures::Service::DaemonReload)
     end
     # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
     def drop_dbs(backup)
       if backup.file_map[:candlepin_dump][:present] ||
-         backup.file_map[:foreman_dump][:present]
+         backup.file_map[:foreman_dump][:present] ||
+         (feature(:pulpcore) && backup.file_map[:pulpcore_dump][:present])
         add_steps_with_context(Procedures::Restore::DropDatabases)
       end
     end
@@ -58,6 +62,9 @@ module ForemanMaintain::Scenarios
       if backup.file_map[:foreman_dump][:present]
         add_steps_with_context(Procedures::Restore::ForemanDump)
       end
+      if feature(:pulpcore) && backup.file_map[:pulpcore_dump][:present]
+        add_steps_with_context(Procedures::Restore::PulpcoreDump)
+      end
     end
 
     def restore_mongo_dump(backup)
@@ -83,6 +90,7 @@ module ForemanMaintain::Scenarios
                   Procedures::Restore::PgGlobalObjects => :backup_dir,
                   Procedures::Restore::CandlepinDump => :backup_dir,
                   Procedures::Restore::ForemanDump => :backup_dir,
+                  Procedures::Restore::PulpcoreDump => :backup_dir,
                   Procedures::Restore::ExtractFiles => :backup_dir,
                   Procedures::Restore::MongoDump => :backup_dir)
 

data/definitions/scenarios/upgrade_to_capsule_6_7.rb

@@ -0,0 +1,88 @@
+module Scenarios::Capsule_6_7
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_scenario
+        confine do
+          feature(:capsule) &&
+            (feature(:capsule).current_minor_version == '6.6' || \
+            ForemanMaintain.upgrade_in_progress == '6.7')
+        end
+        instance_eval(&block)
+      end
+    end
+
+    def target_version
+      '6.7'
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Capsule 6.7'
+      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.7'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Capsule 6.7'
+      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.7'
+      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.7'))
+      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.7'
+      tags :post_migrations
+    end
+
+    def compose
+      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.7'
+      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

data/definitions/scenarios/upgrade_to_capsule_6_7_z.rb

@@ -0,0 +1,88 @@
+module Scenarios::Capsule_6_7_z
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_scenario
+        confine do
+          feature(:capsule) &&
+            (feature(:capsule).current_minor_version == '6.7' || \
+              ForemanMaintain.upgrade_in_progress == '6.7.z')
+        end
+        instance_eval(&block)
+      end
+    end
+
+    def target_version
+      '6.7.z'
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Capsule 6.7.z'
+      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.7'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Capsule 6.7.z'
+      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.7.z'
+      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.7'))
+      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.7.z'
+      tags :post_migrations
+    end
+
+    def compose
+      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.7.z'
+      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