foreman_maintain 0.6.1 → 0.6.6

data/definitions/features/katello.rb

@@ -52,6 +52,13 @@ class Features::Katello < ForemanMaintain::Feature
   end
   # rubocop:enable  Metrics/MethodLength
 
+  def config_files_exclude_for_online
+    [
+      '/var/lib/qpidd',
+      '/var/lib/candlepin/activemq-artemis'
+    ]
+  end
+
   private
 
   def installer_scenario_answers

data/definitions/features/puppet_server.rb

@@ -29,7 +29,7 @@ class Features::PuppetServer < ForemanMaintain::Feature
   end
 
   def puppet_version
-    version(execute!('puppet --version'))
+    version(execute!("#{puppet_path} --version"))
   end
 
   def find_empty_cacert_request_files
@@ -56,6 +56,10 @@ class Features::PuppetServer < ForemanMaintain::Feature
   end
 
   def puppet_ssldir_path
-    execute!('puppet master --configprint ssldir')
+    execute!("#{puppet_path} config print ssldir")
+  end
+
+  def puppet_path
+    '/opt/puppetlabs/bin/puppet'
   end
 end

data/definitions/features/service.rb

@@ -27,7 +27,7 @@ class Features::Service < ForemanMaintain::Feature
   end
 
   def filtered_services(options)
-    service_list = existing_services
+    service_list = include_unregistered_services(existing_services, options[:include])
     service_list = filter_services(service_list, options)
     raise 'No services found matching your parameters' unless service_list.any?
 
@@ -99,9 +99,14 @@ class Features::Service < ForemanMaintain::Feature
     %w[start stop restart status enable disable].include?(action)
   end
 
-  def filter_services(service_list, options)
-    service_list = include_unregistered_services(service_list, options[:include])
+  def extend_service_list_with_sockets(service_list, options)
+    return service_list unless options[:include_sockets]
+
+    socket_list = service_list.map(&:socket).compact.select(&:exist?)
+    service_list + socket_list
+  end
 
+  def filter_services(service_list, options)
     if options[:only] && options[:only].any?
       service_list = service_list.select do |service|
         options[:only].any? { |opt| service.matches?(opt) }
@@ -112,6 +117,8 @@ class Features::Service < ForemanMaintain::Feature
     if options[:exclude] && options[:exclude].any?
       service_list = service_list.reject { |service| options[:exclude].include?(service.name) }
     end
+
+    service_list = extend_service_list_with_sockets(service_list, options)
     service_list.sort
   end
 

data/definitions/procedures/backup/config_files.rb

@@ -17,6 +17,8 @@ module Procedures::Backup
             :array => true, :default => ['all']
       param :ignore_changed_files, 'Should packing tar ignore changed files',
             :flag => true, :default => false
+      param :online_backup, 'The config files are being prepared for an online backup',
+            :flag => true, :default => false
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -55,6 +57,7 @@ module Procedures::Backup
 
         configs += feature.config_files
         exclude_configs += feature.config_files_to_exclude
+        exclude_configs += feature.config_files_exclude_for_online if @online_backup
       end
 
       if feature(:foreman_proxy)

data/definitions/procedures/backup/metadata.rb

@@ -6,6 +6,7 @@ module Procedures::Backup
       preparation_steps { Checks::Foreman::DBUp.new if feature(:foreman_server) }
       param :backup_dir, 'Directory where to backup to', :required => true
       param :incremental_dir, 'Changes since specified backup only'
+      param :online_backup, 'Select for online backup', :flag => true, :default => false
     end
 
     def run
@@ -16,6 +17,7 @@ module Procedures::Backup
         metadata['proxy_features'] = proxy_feature_list(spinner) || []
         metadata['rpms'] = rpms(spinner)
         metadata['incremental'] = @incremental_dir || false
+        metadata['online'] = @online_backup
         save_metadata(metadata, spinner)
       end
     end

data/definitions/procedures/content/prepare.rb

@@ -6,7 +6,7 @@ module Procedures::Content
     end
 
     def run
-      execute!('foreman-rake katello:pulp3_migration')
+      puts execute!('foreman-rake katello:pulp3_migration')
     end
   end
 end

data/definitions/procedures/content/switchover.rb

@@ -6,12 +6,17 @@ module Procedures::Content
     end
 
     def run
-      execute!('foreman-rake katello:pulp3_migration')
-      execute!('foreman-rake katello:pulp3_post_migration_check')
-      execute!('foreman-rake katello:pulp3_content_switchover')
+      puts 'Performing final content migration before switching content'
+      puts execute!('foreman-rake katello:pulp3_migration')
+      puts 'Performing a check to verify everything that is needed has been migrated'
+      puts execute!('foreman-rake katello:pulp3_post_migration_check')
+      puts 'Switching specified content over to pulp 3'
+      puts execute!('foreman-rake katello:pulp3_content_switchover')
+      puts 'Re-running the installer to switch specified content over to pulp3'
       args = ['--foreman-proxy-content-proxy-pulp-isos-to-pulpcore=true',
               '--katello-use-pulp-2-for-file=false',
-              '--katello-use-pulp-2-for-docker=false']
+              '--katello-use-pulp-2-for-docker=false',
+              '--katello-use-pulp-2-for-yum=false']
       feature(:installer).run(args.join(' '))
     end
   end

data/definitions/procedures/hammer_setup.rb

@@ -5,7 +5,7 @@ class Procedures::HammerSetup < ForemanMaintain::Procedure
   end
 
   def run
-    if feature(:foreman_server) && ForemanMaintain::Utils.system_service('httpd', 30).running?
+    if feature(:foreman_server) && feature(:foreman_server).services_running?
       puts 'Configuring Hammer CLI...'
       result = feature(:hammer).setup_admin_access
       logger.info 'Hammer was configured successfully.' if result

data/definitions/procedures/installer/run.rb

@@ -2,10 +2,12 @@ module Procedures::Installer
   class Run < ForemanMaintain::Procedure
     metadata do
       param :arguments, 'Arguments passed to installer'
+      param :assumeyes, 'Do not ask for confirmation'
     end
 
     def run
-      feature(:installer).run(@arguments, :interactive => true)
+      assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
+      feature(:installer).run(@arguments, :interactive => !assumeyes_val)
     end
 
     def description

data/definitions/procedures/installer/upgrade.rb

@@ -1,7 +1,12 @@
 module Procedures::Installer
   class Upgrade < ForemanMaintain::Procedure
+    metadata do
+      param :assumeyes, 'Do not ask for confirmation'
+    end
+
     def run
-      feature(:installer).upgrade(:interactive => true)
+      assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
+      feature(:installer).run(@arguments, :interactive => !assumeyes_val)
     end
   end
 end

data/definitions/procedures/packages/update.rb

@@ -10,7 +10,7 @@ module Procedures::Packages
 
     def run
       assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
-      package_manager.clean_cache
+      package_manager.clean_cache(:assumeyes => assumeyes_val)
       packages_action(:update, @packages, :assumeyes => assumeyes_val)
     rescue ForemanMaintain::Error::ExecutionError => e
       if @warn_on_errors

data/definitions/procedures/restore/configs.rb

@@ -19,10 +19,15 @@ module Procedures::Restore
       end
     end
 
+    # rubocop:disable  Metrics/MethodLength
     def restore_configs(backup)
       exclude = ForemanMaintain.available_features.each_with_object([]) do |feat, cfgs|
+        if backup.online_backup?
+          feat.config_files_exclude_for_online.each { |f| cfgs << f.gsub(%r{^/}, '') }
+        end
         feat.config_files_to_exclude.each { |f| cfgs << f.gsub(%r{^/}, '') }
       end
+
       tar_options = {
         :overwrite => true,
         :listed_incremental => '/dev/null',
@@ -35,6 +40,7 @@ module Procedures::Restore
 
       feature(:tar).run(tar_options)
     end
+    # rubocop:enable  Metrics/MethodLength
 
     def reload_configs
       feature(:mongo).reload_db_config if feature(:mongo)

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

@@ -200,7 +200,8 @@ 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,
@@ -209,6 +210,7 @@ module ForemanMaintain::Scenarios
         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,15 +86,20 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        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::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

data/definitions/scenarios/restore.rb

@@ -20,6 +20,7 @@ module ForemanMaintain::Scenarios
                              Checks::Restore::ValidateHostname,
                              Procedures::Selinux::SetFileSecurity,
                              Procedures::Restore::Configs)
+      add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
       unless backup.incremental?
         add_steps_with_context(Procedures::Restore::EnsureMongoEngineMatches,
                                Procedures::Restore::InstallerReset)
@@ -36,9 +37,12 @@ module ForemanMaintain::Scenarios
       end
       restore_mongo_dump(backup)
       add_steps_with_context(Procedures::Pulp::Migrate,
-                             Procedures::Pulpcore::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)
+      add_step_with_context(Procedures::Crond::Start) if feature(:cron)
     end
     # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
@@ -96,4 +100,15 @@ module ForemanMaintain::Scenarios
                   Procedures::Selinux::SetFileSecurity => :incremental_backup)
     end
   end
+
+  class RestoreRescue < ForemanMaintain::Scenario
+    metadata do
+      description 'Resuce Restore backup'
+      manual_detection
+    end
+
+    def compose
+      add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
+    end
+  end
 end