foreman_maintain 0.1.6 → 0.2.0

data/definitions/scenarios/services.rb

@@ -0,0 +1,156 @@
+module ForemanMaintain::Scenarios
+  class ServiceRestart < ForemanMaintain::Scenario
+    metadata do
+      description 'Restart Services'
+      tags :service_restart
+      label :service_restart
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_checks(:root_user))
+      add_steps_with_context(Procedures::Service::Restart)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::Restart => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::Restart => :exclude)
+
+      context.map(:wait_for_hammer_ping,
+                  Procedures::Service::Restart => :wait_for_hammer_ping)
+    end
+  end
+
+  class ServiceStop < ForemanMaintain::Scenario
+    metadata do
+      description 'Stop Services'
+      tags :service_stop
+      label :service_stop
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_checks(:root_user))
+      add_steps_with_context(Procedures::Service::Stop)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::Stop => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::Stop => :exclude)
+    end
+  end
+
+  class ServiceStart < ForemanMaintain::Scenario
+    metadata do
+      description 'Start Services'
+      tags :service_start
+      label :service_start
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_checks(:root_user))
+      add_steps_with_context(Procedures::Service::Start)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::Start => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::Start => :exclude)
+    end
+  end
+
+  class ServiceList < ForemanMaintain::Scenario
+    metadata do
+      description 'Service List'
+      tags :services_list
+      label :services_list
+      manual_detection
+    end
+
+    def compose
+      add_steps_with_context(Procedures::Service::List)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::List => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::List => :exclude)
+    end
+  end
+
+  class ServiceEnable < ForemanMaintain::Scenario
+    metadata do
+      description 'Enable Services'
+      tags :service_enable
+      label :service_enable
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_checks(:root_user))
+      add_steps_with_context(Procedures::Service::Enable)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::Enable => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::Enable => :exclude)
+    end
+  end
+
+  class ServiceDisable < ForemanMaintain::Scenario
+    metadata do
+      description 'Disable Services'
+      tags :service_disable
+      label :service_disable
+      manual_detection
+    end
+
+    def compose
+      add_steps(find_checks(:root_user))
+      add_steps_with_context(Procedures::Service::Disable)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::Disable => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::Disable => :exclude)
+    end
+  end
+
+  class ServiceStatus < ForemanMaintain::Scenario
+    metadata do
+      description 'Status Services'
+      tags :service_status
+      label :service_status
+      manual_detection
+    end
+
+    def compose
+      add_steps_with_context(Procedures::Service::Status)
+    end
+
+    def set_context_mapping
+      context.map(:only,
+                  Procedures::Service::Status => :only)
+
+      context.map(:exclude,
+                  Procedures::Service::Status => :exclude)
+    end
+  end
+end

data/definitions/scenarios/upgrade_to_satellite_6_2.rb

@@ -33,7 +33,7 @@ module Scenarios::Satellite_6_2
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::KatelloService::Stop.new)
+      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -57,7 +57,7 @@ module Scenarios::Satellite_6_2
     end
 
     def compose
-      add_step(Procedures::KatelloService::Start.new)
+      add_step(Procedures::Service::Start.new)
       add_steps(find_procedures(:post_migrations))
     end
   end

data/definitions/scenarios/upgrade_to_satellite_6_2_z.rb

@@ -33,7 +33,7 @@ module Scenarios::Satellite_6_2_z
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::KatelloService::Stop.new)
+      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -57,7 +57,7 @@ module Scenarios::Satellite_6_2_z
     end
 
     def compose
-      add_step(Procedures::KatelloService::Start.new)
+      add_step(Procedures::Service::Start.new)
       add_steps(find_procedures(:post_migrations))
     end
   end

data/definitions/scenarios/upgrade_to_satellite_6_3.rb

@@ -34,7 +34,7 @@ module Scenarios::Satellite_6_3
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::KatelloService::Stop.new)
+      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -58,7 +58,7 @@ module Scenarios::Satellite_6_3
     end
 
     def compose
-      add_step(Procedures::KatelloService::Start.new)
+      add_step(Procedures::Service::Start.new)
       add_steps(find_procedures(:post_migrations))
     end
   end

data/definitions/scenarios/upgrade_to_satellite_6_3_z.rb

@@ -33,7 +33,7 @@ module Scenarios::Satellite_6_3_z
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::KatelloService::Stop.new)
+      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -57,7 +57,7 @@ module Scenarios::Satellite_6_3_z
     end
 
     def compose
-      add_step(Procedures::KatelloService::Start.new)
+      add_step(Procedures::Service::Start.new)
       add_steps(find_procedures(:post_migrations))
     end
   end

data/definitions/scenarios/upgrade_to_satellite_6_4.rb

@@ -0,0 +1,79 @@
+module Scenarios::Satellite_6_4
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_to_satellite_6_4
+        confine do
+          feature(:downstream) && feature(:downstream).current_minor_version == '6.3'
+        end
+        instance_eval(&block)
+      end
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Satellite 6.4'
+      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.4'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Satellite 6.4'
+      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 Satellite 6.4'
+      tags :migrations
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '6.4'))
+      add_step(Procedures::Packages::Update.new(:assumeyes => true))
+      add_step(Procedures::Installer::Upgrade.new)
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures after migrating to Satellite 6.4'
+      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 Satellite 6.4'
+      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
+
+ForemanMaintain::UpgradeRunner.register_version('6.4', :upgrade_to_satellite_6_4)

data/definitions/scenarios/upgrade_to_satellite_6_4_z.rb

@@ -0,0 +1,79 @@
+module Scenarios::Satellite_6_4_z
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_to_satellite_6_4_z
+        confine do
+          feature(:downstream) && feature(:downstream).current_minor_version == '6.4'
+        end
+        instance_eval(&block)
+      end
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Satellite 6.4.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.4'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Satellite 6.4.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 Satellite 6.4.z'
+      tags :migrations
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '6.4'))
+      add_step(Procedures::Packages::Update.new(:assumeyes => true))
+      add_step(Procedures::Installer::Upgrade.new)
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures after migrating to Satellite 6.4.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 Satellite 6.4.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
+
+ForemanMaintain::UpgradeRunner.register_version('6.4.z', :upgrade_to_satellite_6_4_z)

data/lib/foreman_maintain.rb

@@ -11,6 +11,7 @@ require 'timeout'
 module ForemanMaintain
   require 'foreman_maintain/core_ext'
   require 'foreman_maintain/concerns/logger'
+  require 'foreman_maintain/concerns/reporter'
   require 'foreman_maintain/concerns/finders'
   require 'foreman_maintain/concerns/metadata'
   require 'foreman_maintain/concerns/scenario_metadata'
@@ -76,6 +77,10 @@ module ForemanMaintain
       @detector ||= Detector.new
     end
 
+    def reporter
+      @reporter ||= ForemanMaintain::Reporter::CLIReporter.new
+    end
+
     def available_features(*args)
       detector.available_features(*args)
     end

data/lib/foreman_maintain/cli.rb

@@ -4,7 +4,9 @@ require 'foreman_maintain/cli/base'
 require 'foreman_maintain/cli/transform_clamp_options'
 require 'foreman_maintain/cli/health_command'
 require 'foreman_maintain/cli/upgrade_command'
+require 'foreman_maintain/cli/backup_command'
 require 'foreman_maintain/cli/advanced_command'
+require 'foreman_maintain/cli/service_command'
 
 module ForemanMaintain
   module Cli
@@ -13,7 +15,9 @@ module ForemanMaintain
 
       subcommand 'health', 'Health related commands', HealthCommand
       subcommand 'upgrade', 'Upgrade related commands', UpgradeCommand
+      subcommand 'backup', 'Backup server', BackupCommand
       subcommand 'advanced', 'Advanced tools for server maintenance', AdvancedCommand
+      subcommand 'service', 'Control applicable services', ServiceCommand
 
       def run(*arguments)
         logger.info("Running foreman-maintain command with arguments #{arguments.inspect}")

data/lib/foreman_maintain/cli/backup_command.rb

@@ -0,0 +1,157 @@
+module ForemanMaintain
+  module Cli
+    module BackupCommon
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      def backup_dir
+        @backup_dir ||= preserve_directory? ? backup_root_dir : backup_subdir
+      end
+
+      def timestamp
+        DateTime.now.strftime('%Y-%m-%d-%H-%M-%S')
+      end
+
+      def backup_subdir
+        name = feature(:instance).product_name.downcase.tr(' ', '-')
+        File.join(backup_root_dir, "#{name}-backup-" + timestamp)
+      end
+
+      def perform_backup(strategy, options = {})
+        backup_scenario = backup_scenario(options, strategy)
+        rescue_scenario = rescue_scenario(options, strategy)
+        puts "Starting backup: #{Time.now}"
+        run_scenario(backup_scenario, rescue_scenario)
+        puts "Done with backup: #{Time.now}"
+        final_message
+        exit runner.exit_code
+      end
+
+      module ClassMethods
+        # rubocop:disable  Metrics/MethodLength
+        def common_backup_options
+          # TODO: BACKUP_DIR in f-m config - should be default?
+          parameter 'BACKUP_DIR', 'Path to backup dir',
+                    :attribute_name => :backup_root_dir do |dir|
+            File.expand_path(dir)
+          end
+          option ['-s', '--skip-pulp-content'], :flag, 'Do not backup Pulp content'
+          option ['-p', '--preserve-directory'], :flag, 'Do not create a time-stamped subdirectory'
+          option ['-t', '--split-pulp-tar'], 'SPLIT_SIZE',
+                 'Split pulp data into files of a specified size, i.e. (100M, 50G). ' \
+                 "See '--tape-length' in 'info tar' for all sizes" do |size|
+            self.class.valid_tape_size(size)
+          end
+          option ['-i', '--incremental'], 'PREVIOUS_BACKUP_DIR',
+                 'Backup changes since previous backup' do |dir|
+            unless File.directory?(dir)
+              raise ArgumentError, "Previous backup directory does not exist: #{dir}"
+            end
+            dir
+          end
+          proxy_name = ForemanMaintain.detector.feature(:downstream) ? 'Capsule' : 'Foreman Proxy'
+          option '--features', 'FEATURES',
+                 "#{proxy_name} features to include in the backup. " \
+                     'Valid features are tftp, dns, dhcp, openscap, and all.', :multivalued => true
+        end
+        # rubocop:enable  Metrics/MethodLength
+
+        def valid_tape_size(size)
+          begin
+            ForemanMaintain.detector.feature(:tar).validate_volume_size(size)
+          rescue ForemanMaintain::Error::Validation => e
+            raise ArgumentError, e.message
+          end
+          size
+        end
+      end
+
+      private
+
+      def rescue_scenario(options, strategy)
+        Scenarios::BackupRescueCleanup.new({
+          :backup_dir => backup_dir,
+          :strategy => strategy,
+          :preserve_dir => preserve_directory?
+        }.merge(options))
+      end
+
+      def backup_scenario(options, strategy)
+        Scenarios::Backup.new({
+          :backup_dir => backup_dir,
+          :strategy => strategy,
+          :preserve_dir => preserve_directory?,
+          :proxy_features => features,
+          :tar_volume_size => split_pulp_tar,
+          :skip_pulp_content => skip_pulp_content?,
+          :incremental_dir => incremental
+        }.merge(options))
+      end
+
+      def final_message
+        if runner.quit?
+          if preserve_directory?
+            puts "Backup didn't finish. Incomplete backup is preserved in: #{backup_dir}"
+          else
+            puts "Backup didn't finish. Incomplete backup was removed."
+          end
+        else
+          puts "**** BACKUP Complete, contents can be found in: #{backup_dir} ****"
+        end
+      end
+    end
+
+    class OnlineBackupCommand < Base
+      include BackupCommon
+      interactive_option
+      common_backup_options
+
+      def execute
+        perform_backup(:online)
+      end
+    end
+
+    class OfflineBackupCommand < Base
+      include BackupCommon
+      interactive_option
+      common_backup_options
+      option '--include-db-dumps', :flag, 'Also dump full database schema before offline backup'
+
+      def execute
+        perform_backup(:offline,
+                       :include_db_dumps => include_db_dumps?)
+      end
+    end
+
+    class SnapshotBackupCommand < Base
+      include BackupCommon
+      interactive_option
+      common_backup_options
+      option ['-d', '--snapshot-mount-dir'], 'SNAPSHOT_MOUNT_DIR',
+             "Override default directory ('/var/snap/') where the snapshots will be mounted",
+             :default => '/var/snap/' do |dir|
+        unless File.directory?(dir)
+          raise ArgumentError, "Snapshot mount directory does not exist: #{dir}"
+        end
+        dir
+      end
+      option ['-b', '--snapshot-block-size'], 'SNAPSHOT_BLOCK_SIZE',
+             'Override default block size (2G)', :default => '2G'
+
+      def execute
+        perform_backup(:snapshot,
+                       :snapshot_mount_dir => snapshot_mount_dir,
+                       :snapshot_block_size => snapshot_block_size)
+      end
+    end
+
+    # rubocop:disable Metrics/LineLength
+    class BackupCommand < Base
+      subcommand 'online', 'Keep services online during backup', OnlineBackupCommand
+      subcommand 'offline', 'Shut down services to preserve consistent backup', OfflineBackupCommand
+      subcommand 'snapshot', 'Use snapshots of the databases to create backup', SnapshotBackupCommand
+    end
+    # rubocop:enable Metrics/LineLength
+  end
+end