foreman_maintain 0.6.15 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddf7d7720cb922e61c0d6245c14929ebb3745307b7b166f89921667a4948d4f1
-  data.tar.gz: 88c7794cbeb2c13d0bb8e86f4762a516ceec7e7ac48aa03b4c00bcb12bcbe33f
+  metadata.gz: 01f23ac8f61f67d6c71e3a31156f0267e724b62386f951e02ed4272276be5007
+  data.tar.gz: b4cc1198b259cbb1b074a2622caac177e7d93571cb3cb2f3d2d3630adaab205f
 SHA512:
-  metadata.gz: 786f1416f313f3a60d8109edf2c25636770c6592ffb74d921587d23b4da89f1fdd034cb42e610a1df86b54d9118e97b12f7bc8e004019ab664655d577893c1f9
-  data.tar.gz: 672090585c8fa8b490af89bc9fe14b94aca471ef1457e0553697285e24f20878e2c9743054c6451364418f6d403f129bef6636c7615605a43503843a133b7c83
+  metadata.gz: 21bfdc38c8d3a3a710aedb2e114bb0616e854b1144af15ede8ce0b326938662620e32117947f13c6eacff88b3ed5bc2076d403bb147310722c0110b71828d297
+  data.tar.gz: a232dd4b4ac70ad534fe4310a55382c89cfaf65b61a8afd3f850961c0ce84012810f91e577394c14d2fcaa2df2bc127b2d494312b3c8f31b3458031ef438add7

data/README.md

@@ -1,4 +1,4 @@
-# Foreman Maintenance [![Build Status](https://travis-ci.org/theforeman/foreman_maintain.svg?branch=master)](https://travis-ci.org/theforeman/foreman_maintain) <a href="https://codeclimate.com/github/theforeman/foreman_maintain"><img src="https://codeclimate.com/github/theforeman/foreman_maintain/badges/gpa.svg" /></a>
+# Foreman Maintain [![Build Status](https://github.com/theforeman/foreman_maintain/workflows/Ruby%20Tests/badge.svg?event=pull_request)](https://github.com/theforeman/foreman_maintain/workflows/Ruby%20Tests/badge.svg?event=pull_request) <a href="https://codeclimate.com/github/theforeman/foreman_maintain"><img src="https://codeclimate.com/github/theforeman/foreman_maintain/badges/gpa.svg" /></a>
 
 The `foreman_maintain` aims to provide various features that helps keep the
 Foreman/Satellite up and running. It supports multiple versions and subparts
@@ -52,7 +52,7 @@ Subcommands:
       is-enabled                    Get maintenance-mode status code
 
     content                       Content related commands
-      prepare                       Prepare content for Pulp 3 
+      prepare                       Prepare content for Pulp 3
       switchover                    Switch support for certain content from Pulp 2 to Pulp 3
 ```
 

data/definitions/checks/disk/available_space_candlepin.rb

@@ -0,0 +1,27 @@
+module Checks
+  module Disk
+    class AvailableSpaceCandlepin < ForemanMaintain::Check
+      metadata do
+        label :available_space_cp
+        description 'Check to make sure /var/lib/candlepin has enough space'
+        tags :pre_upgrade
+        confine do
+          feature(:candlepin) && check_min_version('candlepin', '3.1')
+        end
+      end
+
+      MAX_USAGE_IN_PERCENT = 90
+
+      def run
+        assert(enough_space?, "System has more than #{MAX_USAGE_IN_PERCENT}% space used"\
+               " on #{feature(:candlepin).work_dir}.\n"\
+               'See https://bugzilla.redhat.com/show_bug.cgi?id=1898605')
+      end
+
+      def enough_space?
+        io_obj = ForemanMaintain::Utils::Disk::IODevice.new(feature(:candlepin).work_dir)
+        io_obj.space_used_in_percent < MAX_USAGE_IN_PERCENT
+      end
+    end
+  end
+end

data/definitions/checks/foreman_tasks/not_paused.rb

@@ -9,23 +9,20 @@ module Checks::ForemanTasks
     end
 
     def run
-      paused_tasks_count = feature(:foreman_tasks).paused_tasks_count(ignored_tasks)
+      paused_tasks_count = feature(:foreman_tasks).paused_tasks_count()
       assert(paused_tasks_count == 0,
              "There are currently #{paused_tasks_count} paused tasks in the system",
-             :next_steps =>
-               [Procedures::ForemanTasks::Resume.new,
-                Procedures::ForemanTasks::UiInvestigate.new('search_query' => scoped_search_query)])
+             :next_steps => next_procedures)
     end
 
-    # Note: this is for UI link generation only: we are not using scoped search for querying
-    # the tasks itself as we use direct SQL instead
-    def scoped_search_query
-      "state = paused AND label !^(#{ignored_tasks.join(' ')})"
-    end
-
-    def ignored_tasks
-      %w[Actions::Candlepin::ListenOnCandlepinEvents
-         Actions::Katello::EventQueue::Monitor]
+    def next_procedures
+      if assumeyes?
+        return [Procedures::ForemanTasks::Resume.new,
+                Procedures::ForemanTasks::Delete.new(:state => :paused)]
+      end
+      [Procedures::ForemanTasks::Resume.new,
+       Procedures::ForemanTasks::Delete.new(:state => :paused),
+       Procedures::ForemanTasks::UiInvestigate.new('search_query' => 'state = paused')]
     end
   end
 end

data/definitions/checks/package_manager/yum/validate_yum_config.rb

@@ -0,0 +1,51 @@
+module Checks::PackageManager
+  module Yum
+    class ValidateYumConfig < ForemanMaintain::Check
+      metadata do
+        label :validate_yum_config
+        description 'Check to validate yum configuration before upgrade'
+        tags :pre_upgrade
+      end
+
+      def run
+        final_result = verify_config_options
+        assert(
+          final_result[:matched_keys].empty?,
+          failure_message(final_result)
+        )
+      end
+
+      private
+
+      def failure_message(final_result)
+        verb_string = final_result[:matched_keys].length > 1 ? 'are' : 'is'
+
+        "#{final_result[:matched_keys].join(',')} #{verb_string} set in /etc/yum.conf as below:"\
+        "\n#{final_result[:grep_output]}"\
+        "\nUnset this configuration as it is risky while yum update or upgrade!"
+      end
+
+      def verify_config_options
+        result = {}
+        combined_regex = yum_config_options.values.join('|')
+        result[:grep_output] = execute_grep_cmd(combined_regex)
+        result[:matched_keys] = yum_config_options.keys.select do |key|
+          result[:grep_output].include?(key)
+        end
+        result
+      end
+
+      def execute_grep_cmd(regex_string)
+        execute_with_status("grep -iE '#{regex_string}' /etc/yum.conf")[1]
+      end
+
+      def yum_config_options
+        @yum_config_options ||= {
+          'exclude' => '^exclude\s*=\s*\S+.*$',
+          'clean_requirements_on_remove' =>
+            '^clean_requirements_on_remove\s*=\S*(1|yes|true)$'
+        }
+      end
+    end
+  end
+end

data/definitions/features/candlepin.rb

@@ -7,6 +7,10 @@ class Features::Candlepin < ForemanMaintain::Feature
     end
   end
 
+  def work_dir
+    '/var/lib/candlepin'
+  end
+
   def services
     [
       system_service('tomcat', 20),

data/definitions/features/foreman_cockpit.rb

@@ -0,0 +1,15 @@
+class Features::ForemanCockpit < ForemanMaintain::Feature
+  metadata do
+    label :foreman_cockpit
+
+    confine do
+      server? && find_package('tfm-rubygem-foreman_remote_execution-cockpit')
+    end
+  end
+
+  def services
+    [
+      system_service('foreman-cockpit')
+    ]
+  end
+end

data/definitions/features/foreman_tasks.rb

@@ -89,13 +89,19 @@ class Features::ForemanTasks < ForemanMaintain::Feature
 
     if state == :old
       old_tasks_condition
+    elsif state == :paused
+      paused_tasks_condition
     else
       tasks_condition(state)
     end
   end
 
   def resume_task_using_hammer
-    feature(:hammer).run('task resume')
+    if check_min_version('satellite', '6.8')
+      feature(:hammer).run('task resume --search ""')
+    else
+      feature(:hammer).run('task resume')
+    end
   end
 
   def fetch_tasks_status(state, spinner)
@@ -176,6 +182,10 @@ class Features::ForemanTasks < ForemanMaintain::Feature
        "foreman_tasks_tasks.started_at < CURRENT_DATE - INTERVAL '#{MIN_AGE} days'"
   end
 
+  def paused_tasks_condition(state = "'paused'")
+    "foreman_tasks_tasks.state IN (#{state})"
+  end
+
   def prepare_for_backup(state)
     dir = backup_dir(state)
     execute("mkdir -p #{dir}")
@@ -193,6 +203,6 @@ class Features::ForemanTasks < ForemanMaintain::Feature
   end
 
   def valid(state)
-    %w[old planning pending].include?(state.to_s)
+    %w[old planning pending paused].include?(state.to_s)
   end
 end

data/definitions/features/pulpcore.rb

@@ -5,24 +5,39 @@ class Features::Pulpcore < ForemanMaintain::Feature
     label :pulpcore
 
     confine do
-      ForemanMaintain::Utils::Service::Systemd.new('pulpcore-api', 0).exist?
+      ForemanMaintain::Utils::Service::Systemd.new('pulpcore-api', 0).exist? &&
+        ForemanMaintain::Utils::Service::Systemd.new('pulpcore-api', 0).enabled?
     end
   end
 
   def services
-    [
+    self.class.pulpcore_common_services + [
       system_service('rh-redis5-redis', 5),
-      system_service('pulpcore-api', 10),
-      system_service('pulpcore-content', 10),
-      system_service('pulpcore-resource-manager', 10),
       system_service('pulpcore-worker@*', 20, :all => true, :skip_enablement => true),
       system_service('httpd', 30)
     ]
   end
 
+  def self.pulpcore_migration_services
+    pulpcore_common_services + [
+      ForemanMaintain::Utils.system_service('pulpcore-worker@1', 20),
+      ForemanMaintain::Utils.system_service('pulpcore-worker@2', 20),
+      ForemanMaintain::Utils.system_service('pulpcore-worker@3', 20),
+      ForemanMaintain::Utils.system_service('pulpcore-worker@4', 20)
+    ]
+  end
+
   def config_files
     [
       '/etc/pulp/settings.py'
     ]
   end
+
+  def self.pulpcore_common_services
+    [
+      ForemanMaintain::Utils.system_service('pulpcore-api', 10, :socket => 'pulpcore-api'),
+      ForemanMaintain::Utils.system_service('pulpcore-content', 10, :socket => 'pulpcore-content'),
+      ForemanMaintain::Utils.system_service('pulpcore-resource-manager', 10)
+    ]
+  end
 end

data/definitions/procedures/backup/accessibility_confirmation.rb

@@ -7,7 +7,7 @@ module Procedures::Backup
 
     def run
       answer = ask_decision("WARNING: This script will stop your services.\n\n" \
-         'Do you want to proceed?', 'y(yes), q(quit)')
+         'Do you want to proceed?', actions_msg: 'y(yes), q(quit)')
       abort! unless answer == :yes
     end
   end

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

@@ -4,21 +4,26 @@ module Procedures::Backup
       metadata do
         description 'Data consistency warning'
         tags :backup
+        param :include_db_dumps, 'Are database dumps included in backup', :flag => true,
+                                                                          :default => false
       end
 
       def run
-        answer = ask_decision(
-          "*** WARNING: The online backup is intended for making a copy of the data\n" \
+        answer = ask_decision(warning_message(@include_db_dumps), actions_msg: 'y(yes), q(quit)')
+        abort! unless answer == :yes
+      end
+
+      def warning_message(include_db_dumps)
+        substr = include_db_dumps ? 'database dump' : 'online backup'
+        "*** WARNING: The #{substr} is intended for making a copy of the data\n" \
           '*** for debugging purposes only.' \
           " The backup routine can not ensure 100% consistency while the\n" \
           "*** backup is taking place as there is a chance there may be data mismatch between\n" \
           '*** Mongo and Postgres databases while the services are live.' \
-          " If you wish to utilize the online backup\n" \
+          " If you wish to utilize the #{substr}\n" \
           '*** for production use you need to ensure that there are' \
           " no modifications occurring during\n" \
-          "*** your backup run.\n\nDo you want to proceed?", 'y(yes), q(quit)'
-        )
-        abort! unless answer == :yes
+          "*** your backup run.\n\nDo you want to proceed?"
       end
     end
   end

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

@@ -40,7 +40,7 @@ module Procedures::Backup
           '*** If you would like to continue, the snapshot size will be required to be at least' \
           " the size of the actual #{shared_lv.join(', ')} database.\n" \
           "*** You can skip this confirmation with the '-y' flag.\n\n" \
-          'Do you want to proceed?', 'y(yes), q(quit)')
+          'Do you want to proceed?', actions_msg: 'y(yes), q(quit)')
         abort! unless answer == :yes
       end
     end

data/definitions/procedures/content/migration_stats.rb

@@ -0,0 +1,12 @@
+module Procedures::Content
+  class MigrationStats < ForemanMaintain::Procedure
+    metadata do
+      description 'Retrieve Pulp 2 to Pulp 3 migration statistics'
+      for_feature :pulpcore
+    end
+
+    def run
+      puts execute!('foreman-rake katello:pulp3_migration_stats')
+    end
+  end
+end

data/definitions/procedures/content/prepare.rb

@@ -3,15 +3,11 @@ module Procedures::Content
     metadata do
       description 'Prepare content for Pulp 3'
       for_feature :pulpcore
-
-      confine do
-        # FIXME: remove this condition on next downstream upgrade scenario
-        !feature(:instance).downstream
-      end
     end
 
     def run
-      puts execute!('foreman-rake katello:pulp3_migration')
+      # use interactive to get realtime output
+      puts execute!('foreman-rake katello:pulp3_migration', :interactive => true)
     end
   end
 end

data/definitions/procedures/content/prepare_abort.rb

@@ -0,0 +1,12 @@
+module Procedures::Content
+  class PrepareAbort < ForemanMaintain::Procedure
+    metadata do
+      description 'Abort all running Pulp 2 to Pulp 3 migration tasks'
+      for_feature :pulpcore
+    end
+
+    def run
+      puts execute!('foreman-rake katello:pulp3_migration_abort')
+    end
+  end
+end

data/definitions/procedures/content/switchover.rb

@@ -5,7 +5,7 @@ module Procedures::Content
       for_feature :pulpcore
 
       confine do
-        # FIXME: remove this condition on next downstream upgrade scenario
+        # FIXME: remove this condition for the 6.10 upgrade scenario
         !feature(:instance).downstream
       end
     end

data/definitions/procedures/foreman_tasks/delete.rb

@@ -1,6 +1,6 @@
 module Procedures::ForemanTasks
   class Delete < ForemanMaintain::Procedure
-    ALLOWED_STATES_VALUES = %w[old planning pending].freeze
+    ALLOWED_STATES_VALUES = %w[old planning pending paused].freeze
 
     metadata do
       param :state,
@@ -19,12 +19,11 @@ module Procedures::ForemanTasks
           feature(:foreman_tasks).backup_tasks(@state) do |backup_progress|
             spinner.update backup_progress
           end
-
-          spinner.update "Deleting #{@state} tasks [running]"
+          spinner.update "Deleting #{count_tasks_before} #{@state} tasks [running]"
           count_tasks_later = feature(:foreman_tasks).delete(@state)
           spinner.update "Deleting #{@state} tasks [DONE]"
           spinner.update(
-            "Deleted #{@state} stopped and paused tasks: #{count_tasks_before - count_tasks_later}"
+            "Deleted #{@state} tasks: #{count_tasks_before - count_tasks_later}"
           )
         end
       end

data/definitions/procedures/foreman_tasks/resume.rb

@@ -6,8 +6,13 @@ module Procedures::ForemanTasks
       description 'Resume paused tasks'
     end
 
+    WAIT_TIME = 30
+
     def run
       output << feature(:foreman_tasks).resume_task_using_hammer
+      with_spinner('Waiting 30 seconds for resumed tasks to start.') do
+        sleep WAIT_TIME
+      end
     end
   end
 end

data/definitions/procedures/packages/installer_confirmation.rb

@@ -11,7 +11,7 @@ module Procedures::Packages
         "is in a consistent state.\n" \
         "As a result some of your services may be restarted. \n\n" \
         'Do you want to proceed?'
-      answer = ask_decision(question, 'y(yes), q(quit)')
+      answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
       abort! unless answer == :yes
     end
   end

data/definitions/procedures/packages/update_all_confirmation.rb

@@ -16,7 +16,7 @@ module Procedures::Packages
           "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)
+        answer = ask_decision(question, actions_msg: 'y(yes), q(quit)', ignore_assumeyes: true)
         abort! unless answer == :yes
       end
     end

data/definitions/procedures/prep_6_10_upgrade.rb

@@ -0,0 +1,29 @@
+class Procedures::Prep610Upgrade < ForemanMaintain::Procedure
+  metadata do
+    description 'Preparations for the Satellite 6.10 upgrade'
+
+    confine do
+      feature(:satellite) &&
+        feature(:satellite).current_minor_version == '6.9'
+    end
+  end
+
+  def run
+    puts time_warning
+    with_spinner('Updating filesystem permissions for Pulp 3') do |spinner|
+      spinner.update('$ chmod -R g+rwX /var/lib/pulp/content')
+      FileUtils.chmod_R 'g=rwX', '/var/lib/pulp/content'
+      spinner.update("$ find /var/lib/pulp/content -type d -perm -g-s -exec chmod g+s {} \;")
+      execute!('find /var/lib/pulp/content -type d -perm -g-s -exec chmod g+s {} \;')
+      spinner.update('$ chown -R :pulp /var/lib/pulp/content')
+      FileUtils.chown_R nil, 'pulp', '/var/lib/pulp/content'
+    end
+  end
+
+  private
+
+  def time_warning
+    "\e[33mprep-6.10-upgrade may take a while depending on the "\
+    "size of /var/lib/pulp/content\e[0m"
+  end
+end