foreman_maintain 0.6.0 → 0.6.5

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/features/tar.rb

@@ -38,6 +38,7 @@ class Features::Tar < ForemanMaintain::Feature
   # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   def tar_command(options)
     volume_size = options.fetch(:volume_size, nil)
+    absolute_names = options.fetch(:absolute_names, nil)
     validate_volume_size(volume_size) unless volume_size.nil?
 
     tar_command = ['tar']
@@ -45,6 +46,10 @@ class Features::Tar < ForemanMaintain::Feature
     tar_command << "--#{options.fetch(:command, 'create')}"
     tar_command << "--file=#{options.fetch(:archive)}"
 
+    if absolute_names
+      tar_command << '--absolute-names'
+    end
+
     if volume_size
       split_tar_script = default_split_tar_script
       tar_command << "--tape-length=#{volume_size}"

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/backup/offline/pulpcore_db.rb

@@ -0,0 +1,57 @@
+module Procedures::Backup
+  module Offline
+    class PulpcoreDB < ForemanMaintain::Procedure
+      metadata do
+        description 'Backup Pulpcore DB offline'
+        tags :backup
+        label :backup_offline_pulpcore_db
+        for_feature :pulpcore_database
+        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
+        param :backup_dir, 'Directory where to backup to', :required => true
+        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
+        param :mount_dir, 'Snapshot mount directory'
+      end
+
+      def run
+        if feature(:pulpcore_database).local?
+          if File.exist?(pg_backup_file)
+            puts 'Already done'
+          else
+            local_backup
+          end
+        else
+          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
+            ' Doing postgres dump instead...'
+          with_spinner('Getting Pulpcore DB dump') do
+            feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
+          end
+        end
+      end
+
+      private
+
+      def local_backup
+        with_spinner("Collecting data from #{pg_data_dir}") do
+          feature(:pulpcore_database).backup_local(
+            pg_backup_file,
+            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
+            :volume_size => @tar_volume_size,
+            :data_dir => pg_data_dir
+          )
+        end
+      end
+
+      def pg_backup_file
+        File.join(@backup_dir, 'pgsql_data.tar')
+      end
+
+      def pg_data_dir
+        return feature(:pulpcore_database).data_dir if @mount_dir.nil?
+        mount_point = File.join(@mount_dir, 'pgsql')
+        dir = feature(:pulpcore_database).find_base_directory(mount_point)
+        fail!("Snapshot of Pulpcore DB was not found mounted in #{mount_point}") if dir.nil?
+        dir
+      end
+    end
+  end
+end

data/definitions/procedures/backup/online/pulpcore_db.rb

@@ -0,0 +1,20 @@
+module Procedures::Backup
+  module Online
+    class PulpcoreDB < ForemanMaintain::Procedure
+      metadata do
+        description 'Backup Pulpcore database online'
+        tags :backup
+        label :backup_online_pulpcore_db
+        for_feature :pulpcore_database
+        preparation_steps { Checks::Pulpcore::DBUp.new }
+        param :backup_dir, 'Directory where to backup to', :required => true
+      end
+
+      def run
+        with_spinner('Getting Pulpcore DB dump') do
+          feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/backup/snapshot/logical_volume_confirmation.rb

@@ -16,6 +16,7 @@ module Procedures::Backup
         dbs[:mongo] = 'Mongo' if db_local?(:mongo)
         dbs[:candlepin_database] = 'Candlepin' if db_local?(:candlepin_database)
         dbs[:foreman_database] = 'Foreman' if db_local?(:foreman_database)
+        dbs[:pulpcore_database] = 'Pulpcore' if db_local?(:pulpcore_database)
 
         shared_lv = dbs.inject([]) do |list, (db_label, db_name)|
           db_lv = get_lv_info(feature(db_label).data_dir)

data/definitions/procedures/backup/snapshot/mount_pulpcore_db.rb

@@ -0,0 +1,48 @@
+require 'procedures/backup/snapshot/mount_base'
+module Procedures::Backup
+  module Snapshot
+    class MountPulpcoreDB < MountBase
+      metadata do
+        description 'Create and mount snapshot of Pulpcore DB'
+        tags :backup
+        label :backup_snapshot_mount_pulpcore_db
+        for_feature :pulpcore_database
+        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
+        MountBase.common_params(self)
+        param :backup_dir, 'Directory where to backup to'
+      end
+
+      def run
+        if feature(:pulpcore_database).local?
+          snapshot
+        else
+          dump_pulpcore
+        end
+      end
+
+      private
+
+      def dump_pulpcore
+        puts 'LV snapshots are not supported for remote databases. Doing postgres dump instead... '
+        with_spinner('Getting Pulpcore DB dump') do
+          feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
+        end
+      end
+
+      def snapshot
+        mount_point = mount_location('pgsql')
+        FileUtils.mkdir_p(mount_point) unless File.directory?(mount_point)
+        if directory_empty?(mount_point)
+          with_spinner('Creating snapshot of Postgres') do |spinner|
+            lv_info = get_lv_info(feature(:pulpcore_database).data_dir)
+            create_lv_snapshot('pgsql-snap', @block_size, lv_info[0])
+            spinner.update("Mounting snapshot of Postgres on #{mount_point}")
+            mount_snapshot('pgsql', lv_info[1])
+          end
+        else
+          puts 'Snapshot of Postgres is already mounted'
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/content/prepare.rb

@@ -2,11 +2,11 @@ module Procedures::Content
   class Prepare < ForemanMaintain::Procedure
     metadata do
       description 'Prepare content for Pulp 3'
-      for_feature :pulp3
+      for_feature :pulpcore
     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

@@ -0,0 +1,22 @@
+module Procedures::Content
+  class Switchover < ForemanMaintain::Procedure
+    metadata do
+      description 'Switch support for certain content from Pulp 2 to Pulp 3'
+      for_feature :pulpcore
+    end
+
+    def run
+      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']
+      feature(:installer).run(args.join(' '))
+    end
+  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/installer_confirmation.rb

@@ -5,7 +5,7 @@ module Procedures::Packages
     end
 
     def run
-      question = "WARNING: This script runs #{feature(:installer).installer_command} " \
+      question = "\nWARNING: This script runs #{feature(:installer).installer_command} " \
         "after the yum execution \n" \
         "to ensure the #{feature(:instance).product_name} " \
         "is in a consistent state.\n" \

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/packages/update_all_confirmation.rb

@@ -0,0 +1,24 @@
+module Procedures::Packages
+  class UpdateAllConfirmation < ForemanMaintain::Procedure
+    metadata do
+      param :packages, 'List of packages to update', :array => true
+
+      description 'Confirm update all is intentional'
+    end
+
+    def run
+      if @packages.nil? || @packages.empty?
+        question = "\nWARNING: No specific packages to update were provided\n" \
+          "so we are going to update all available packages.\n" \
+          "It is recommended to update everything only as part of upgrade\n" \
+          "of the #{feature(:instance).product_name} to the next version. \n" \
+          "To Upgrade to next version use 'foreman-maintain upgrade'.\n\n" \
+          "NOTE: --assumeyes is not applicable for this check\n\n" \
+          "Do you want to proceed with update of everything regardless\n" \
+          'of the recommendations?'
+        answer = ask_decision(question, 'y(yes), q(quit)', ignore_assumeyes: true)
+        abort! unless answer == :yes
+      end
+    end
+  end
+end

data/definitions/procedures/pulpcore/migrate.rb

@@ -0,0 +1,25 @@
+module Procedures::Pulpcore
+  class Migrate < ForemanMaintain::Procedure
+    include ForemanMaintain::Concerns::SystemService
+
+    metadata do
+      description 'Migrate pulpcore db'
+      for_feature :pulpcore
+    end
+
+    def run
+      with_spinner('Migrating pulpcore') do |spinner|
+        necessary_services = feature(:pulpcore_database).services
+        pulp_services = feature(:pulpcore).services
+
+        feature(:service).handle_services(spinner, 'start', :only => necessary_services)
+        feature(:service).handle_services(spinner, 'stop', :only => pulp_services)
+
+        spinner.update('Migrating pulpcore database')
+        execute!('sudo PULP_SETTINGS=/etc/pulp/settings.py '\
+          'DJANGO_SETTINGS_MODULE=pulpcore.app.settings '\
+          'python3-django-admin migrate --noinput')
+      end
+    end
+  end
+end

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/drop_databases.rb

@@ -8,7 +8,7 @@ module Procedures::Restore
             :required => true
 
       confine do
-        feature(:foreman_database) || feature(:candlepin_database)
+        feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database)
       end
     end
 
@@ -19,6 +19,9 @@ module Procedures::Restore
         feature(:service).handle_services(spinner, 'start', :only => ['postgresql'])
         drop_foreman(backup, spinner)
         drop_candlepin(backup, spinner)
+        if feature(:pulpcore)
+          drop_pulpcore(backup, spinner)
+        end
       end
     end
 
@@ -35,5 +38,12 @@ module Procedures::Restore
         feature(:candlepin_database).dropdb
       end
     end
+
+    def drop_pulpcore(backup, spinner)
+      if backup.file_map[:pulpcore_dump][:present]
+        spinner.update('Dropping pulpcore database')
+        feature(:pulpcore_database).dropdb
+      end
+    end
   end
 end