foreman_maintain 0.6.13 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a459203e886ab2569e44fe1248dcc5e678e9cb2752bee8d6ff1454687a3811b
-  data.tar.gz: 94d4ef1cd297ed24fde199194215e2ab5f1b799ec33b60335e1dc94835a9b48b
+  metadata.gz: b7bee1fb68980f7f9358b61a13c7d0a5eba0c78d308ebcfeb717e31cb6c71942
+  data.tar.gz: 808fb2970b786aec29df42004b22ecf82b52e8bd31666410136842c6621d2b67
 SHA512:
-  metadata.gz: cc7422d890bf9637fa08f6efd8c8f5877371d14575746cd2d0e79771fe98aac99edd0aa8a591f86ff236f300723e1507e4dbae41c0d996d81049f31e187d2289
-  data.tar.gz: 24a5d18d3154143f4091777dd57f2f162736d1fdf83e1327062029f36601e78e48c6ca7feb1f812d7e1a5350de2634136dee07eb3eff22012810cf28982448e9
+  metadata.gz: 3b5cba26dc0b3011336003c542e7d051b48a1a8896d5b36865d21b25e4a9367b1d1b3929d409ef6bb00fc2947c4f27141e0433a4e14c536291a269c0b334c1f5
+  data.tar.gz: a9e794c196a502b2307506863f0e75e1a4a1a803793986040d118f679f0bd921b0f8a5a95f76516844e97c71f831be5b2cdd9bd7052bb2fc6409dd4089e09f75

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

@@ -18,31 +18,39 @@ module Checks
       # rubocop:disable Metrics/MethodLength
       def check_custom_hiera
         hiera_file = feature(:installer).custom_hiera_file
-        if (config = YAML.load_file(hiera_file)) &&
-           config.key?('postgresql::server::config_entries')
-          if config['postgresql::server::config_entries'].nil?
-            return <<-MESSAGE.strip_heredoc
-            ERROR: 'postgresql::server::config_entries' cannot be null.
-            Please remove it from following file and re-run the command.
-            - #{hiera_file}
-            MESSAGE
-          elsif config['postgresql::server::config_entries'].key?('checkpoint_segments')
-            message = <<-MESSAGE.strip_heredoc
-            ERROR: Tuning option 'checkpoint_segments' found.
-            This option is no longer valid for PostgreSQL 9.5 or newer.
-            Please remove it from following file and re-run the command.
-            - #{hiera_file}
-            MESSAGE
-            if feature(:katello)
-              message += <<-MESSAGE.strip_heredoc
-              The presence of checkpoint_segments in #{hiera_file} indicates manual tuning.
-              Manual tuning can override values provided by the --tuning parameter.
-              Review #{hiera_file} for values that are already provided by the built in tuning profiles.
-              Built in tuning profiles also provide a supported upgrade path.
+        begin
+          config = YAML.load_file(hiera_file)
+          if config.is_a?(Hash) && config.key?('postgresql::server::config_entries')
+            if config['postgresql::server::config_entries'].nil?
+              return <<-MESSAGE.strip_heredoc
+              ERROR: 'postgresql::server::config_entries' cannot be null.
+              Please remove it from following file and re-run the command.
+              - #{hiera_file}
               MESSAGE
+            elsif config['postgresql::server::config_entries'].key?('checkpoint_segments')
+              message = <<-MESSAGE.strip_heredoc
+              ERROR: Tuning option 'checkpoint_segments' found.
+              This option is no longer valid for PostgreSQL 9.5 or newer.
+              Please remove it from following file and re-run the command.
+              - #{hiera_file}
+              MESSAGE
+              if feature(:katello)
+                message += <<-MESSAGE.strip_heredoc
+                The presence of checkpoint_segments in #{hiera_file} indicates manual tuning.
+                Manual tuning can override values provided by the --tuning parameter.
+                Review #{hiera_file} for values that are already provided by the built in tuning profiles.
+                Built in tuning profiles also provide a supported upgrade path.
+                MESSAGE
+              end
+              return message
             end
-            return message
+          elsif config.is_a?(String)
+            fail! "Error: File #{hiera_file} is not a yaml file."
+            exit 1
           end
+        rescue Psych::SyntaxError
+          fail! "Found syntax error in file: #{hiera_file}"
+          exit 1
         end
       end
       # rubocop:enable Metrics/MethodLength

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

@@ -7,10 +7,6 @@ class Features::DynflowSidekiq < ForemanMaintain::Feature
     end
   end
 
-  def services
-    service_names.map { |service| system_service service, instance_priority(service) }
-  end
-
   def config_files
     # Workaround until foreman-installer can deploy scaled workers
     service_symlinks = configured_instances.map do |service|
@@ -22,6 +18,13 @@ class Features::DynflowSidekiq < ForemanMaintain::Feature
     ].flatten
   end
 
+  def services
+    service_names.map do |service|
+      system_service service, instance_priority(service),
+                     :instance_parent_unit => 'dynflow-sidekiq@'
+    end
+  end
+
   private
 
   def instance_priority(instance)

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