foreman_maintain 0.6.10 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e382b3653ec4332ef6bc891b83e92263874dfc079fb84c1f3db951696804832e
-  data.tar.gz: 03b8467289528688c03ed6ad7b8361befee931c9eb0d51a897aa38a755b9ad8a
+  metadata.gz: 4151b9d6dbc810f7f85aa093bdcfc4f967530dbeddcf7e13e88ce998125211dc
+  data.tar.gz: e7db5a3881d9652bae19c61f95ff95076745f36212c6e36f4cf582d4b5f33c8f
 SHA512:
-  metadata.gz: 0f9b4071adbda3fb4f39c84a6c02891aa4e54c0138d8245dfb2da93844bbc6b51e8db88a0424a006fde8563b7b4806b833176caeacaaa9c4b3101ef23824c4f0
-  data.tar.gz: a00abc28ccc812b76de1ca75849f471bd16944fb3cd8bc7ead833f0c077c17e1860626ba6e9c52af834fa1f21c2a6c6b0c331551bc435d921926fdc694cda045
+  metadata.gz: 56165e03d708aa74d5b370cd7f2ca96a0121b2b97d14f326372181ef2c464eb9856dbafd1f60ad99aea89c9a610a1579a334a4a69c12abee38b70d2eb84a899a
+  data.tar.gz: e43c42dbbe5aab6752e16429dae6fd70367510be2df57f026aa5ad53bb1efb9ef9e4eb2efc4331aef3823b93729412b789bc8c3e8396e03b4563bc82cf42199b

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

@@ -5,24 +5,41 @@ 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
-    [
-      system_service('rh-redis5-redis', 5),
-      system_service('pulpcore-api', 10),
-      system_service('pulpcore-content', 10),
-      system_service('pulpcore-resource-manager', 10),
+    pulpcore_common_services + [
       system_service('pulpcore-worker@*', 20, :all => true, :skip_enablement => true),
       system_service('httpd', 30)
     ]
   end
 
+  def pulpcore_migration_services
+    pulpcore_common_services + [
+      system_service('pulpcore-worker@1', 20),
+      system_service('pulpcore-worker@2', 20),
+      system_service('pulpcore-worker@3', 20),
+      system_service('pulpcore-worker@4', 20)
+    ]
+  end
+
   def config_files
     [
       '/etc/pulp/settings.py'
     ]
   end
+
+  private
+
+  def pulpcore_common_services
+    [
+      system_service('rh-redis5-redis', 5),
+      system_service('pulpcore-api', 10, :socket => 'pulpcore-api'),
+      system_service('pulpcore-content', 10, :socket => 'pulpcore-content'),
+      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

@@ -16,7 +16,7 @@ module Procedures::Backup
           " If you wish to utilize the online backup\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)'
+          "*** your backup run.\n\nDo you want to proceed?", actions_msg: 'y(yes), q(quit)'
         )
         abort! unless answer == :yes
       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,11 +3,6 @@ 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

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/installer/upgrade_rake_task.rb

@@ -0,0 +1,11 @@
+module Procedures::Installer
+  class UpgradeRakeTask < ForemanMaintain::Procedure
+    metadata do
+      description 'Execute upgrade:run rake task'
+    end
+
+    def run
+      execute!('foreman-rake upgrade:run')
+    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,31 @@
+class Procedures::Prep610Upgrade < ForemanMaintain::Procedure
+  metadata do
+    description 'Preparations for the Satellite 6.10 upgrade'
+
+    confine do
+      ::Scenarios.const_defined?('Satellite_6_10') &&
+        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'
+      # TODO: Install Pulp 3 without starting services?
+    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

data/definitions/procedures/restore/confirmation.rb

@@ -10,7 +10,7 @@ module Procedures::Restore
                 "Your existing installation will be replaced with the backup database.\n" \
                 "Once this operation is complete there is no going back.\n" \
                 'Do you want to proceed?'
-      answer = ask_decision(warning, 'y(yes), q(quit)')
+      answer = ask_decision(warning, actions_msg: 'y(yes), q(quit)')
       abort! unless answer == :yes
     end
   end

data/definitions/procedures/restore/installer_reset.rb

@@ -12,7 +12,7 @@ module Procedures::Restore
 
     def installer_cmd
       installer = "yes | #{feature(:installer).installer_command} "
-      installer << '-v --reset '
+      installer << reset_option
       if feature(:instance).foreman_proxy_with_content?
         installer << '--foreman-proxy-register-in-foreman false '
       end
@@ -27,5 +27,14 @@ module Procedures::Restore
       end
       installer
     end
+
+    def reset_option
+      if check_min_version('foreman', '2.2') || \
+         check_min_version('foreman-proxy', '2.2')
+        return '-v --reset-data '
+      end
+
+      '-v --reset '
+    end
   end
 end

data/definitions/scenarios/content.rb

@@ -8,11 +8,29 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        # FIXME: remove this condition on next downstream upgrade scenario
-        if Procedures::Content::Prepare.present?
+        if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
+          enable_and_start_services
           add_step(Procedures::Content::Prepare)
+          disable_and_stop_services
         end
       end
+
+      private
+
+      def enable_and_start_services
+        add_step(Procedures::Service::Start)
+        add_step(Procedures::Service::Enable.
+                 new(:only => feature(:pulpcore).pulpcore_migration_services))
+        add_step(Procedures::Service::Start.
+                 new(:only => feature(:pulpcore).pulpcore_migration_services))
+      end
+
+      def disable_and_stop_services
+        add_step(Procedures::Service::Stop.
+                 new(:only => feature(:pulpcore).pulpcore_migration_services))
+        add_step(Procedures::Service::Disable.
+                 new(:only => feature(:pulpcore).pulpcore_migration_services))
+      end
     end
 
     class Switchover < ForemanMaintain::Scenario
@@ -23,9 +41,38 @@ module ForemanMaintain::Scenarios
       end
 
       def compose
-        # FIXME: remove this condition on next downstream upgrade scenario
+        # FIXME: remove this condition for the 6.10 upgrade scenario
         if Procedures::Content::Switchover.present?
           add_step(Procedures::Content::Switchover)
+          add_step(Procedures::Foreman::ApipieCache)
+        end
+      end
+    end
+
+    class PrepareAbort < ForemanMaintain::Scenario
+      metadata do
+        label :content_prepare_abort
+        description 'Abort all running Pulp 2 to Pulp 3 migration tasks'
+        manual_detection
+      end
+
+      def compose
+        if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
+          add_step(Procedures::Content::PrepareAbort)
+        end
+      end
+    end
+
+    class MigrationStats < ForemanMaintain::Scenario
+      metadata do
+        label :content_migration_stats
+        description 'Retrieve Pulp 2 to Pulp 3 migration statistics'
+        manual_detection
+      end
+
+      def compose
+        if feature(:satellite) && feature(:satellite).at_least_version?('6.9')
+          add_step(Procedures::Content::MigrationStats)
         end
       end
     end

data/definitions/scenarios/prep_6_10_upgrade.rb

@@ -0,0 +1,13 @@
+module ForemanMaintain::Scenarios
+  class Prep610Upgrade < ForemanMaintain::Scenario
+    metadata do
+      label :prep_6_10_upgrade
+      description 'Preparations for the Satellite 6.10 upgrade'
+      manual_detection
+    end
+
+    def compose
+      add_step(Procedures::Prep610Upgrade)
+    end
+  end
+end