foreman_maintain 0.3.6 → 0.4.1

data/definitions/features/system_repos.rb

@@ -0,0 +1,50 @@
+class Features::SystemRepos < ForemanMaintain::Feature
+  metadata do
+    label :system_repos
+    description 'Feature for operations on yum repositories of system'
+  end
+
+  def upstream_repos
+    repositories = {}
+    enabled_repos_hash.each do |repo, url|
+      upstream_repo_urls.each do |regex|
+        repositories[repo] = url if url =~ regex
+      end
+    end
+    repositories
+  end
+
+  def enabled_repos_hash
+    repos = execute("yum repolist enabled -d 6 -e 0 2> /dev/null | grep -E 'Repo-id|Repo-baseurl'")
+    return {} if repos.empty?
+
+    Hash[*repos.delete!(' ').split("\n")]
+  end
+
+  def upstream_repos_ids
+    trim_repoids(upstream_repos.keys)
+  end
+
+  def disable_repos(repo_ids)
+    execute!("yum-config-manager --disable #{repo_ids.join(',')}")
+  end
+
+  private
+
+  def trim_repoids(repos)
+    repos.map { |r| r.gsub(%r{Repo-id:|\/+\w*}, '') }
+  end
+
+  def upstream_repo_urls
+    repo_urls = { :Foreman => %r{yum.theforeman.org\/},
+                  :Katello => %r{fedorapeople.org\/groups\/katello\/releases\/yum\/[\/|\w|.]*} }
+    [/#{repo_urls[:Foreman]}+releases/,
+     /#{repo_urls[:Foreman]}+plugins/,
+     /#{repo_urls[:Katello]}+katello/,
+     /#{repo_urls[:Katello]}+client/,
+     /#{repo_urls[:Katello]}+candlepin/,
+     /#{repo_urls[:Katello]}+pulp/,
+     %r{yum.puppetlabs.com\/el\/[\w|\/|\.]*\/x86_64},
+     %r{repos.fedorapeople.org\/repos\/pulp\/[\/|\w|.]*\/x86_64}]
+  end
+end

data/definitions/features/tar.rb

@@ -56,6 +56,7 @@ class Features::Tar < ForemanMaintain::Feature
       tar_command << options.fetch(:files, '*')
     end
 
+    logger.debug("Invoking tar from #{FileUtils.pwd}")
     execute!(tar_command.join(' '))
   end
   # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

data/definitions/procedures/backup/config_files.rb

@@ -11,8 +11,6 @@ module Procedures::Backup
       param :backup_dir, 'Directory where to backup to', :required => true
       param :proxy_features, 'List of proxy features to backup (default: all)',
             :array => true, :default => ['all']
-      param :ignore_changed_files, 'Should packing tar ignore changed files',
-            :flag => true, :default => false
     end
 
     def run
@@ -20,10 +18,9 @@ module Procedures::Backup
       increments = File.join(@backup_dir, '.config.snar')
       with_spinner('Collecting config files to backup') do
         configs = config_files.join(' ')
-        statuses = @ignore_changed_files ? [0, 1] : [0]
         execute!("tar --selinux --create --gzip --file=#{tarball} " \
           "--listed-incremental=#{increments} --ignore-failed-read " \
-          "#{configs}", :valid_exit_statuses => statuses)
+          "#{configs}")
       end
     end
 

data/definitions/procedures/backup/offline/mongo.rb

@@ -26,7 +26,7 @@ module Procedures::Backup
       def data_dir
         return nil if @mount_dir.nil?
         mount_point = File.join(@mount_dir, 'mongodb')
-        dir = feature(:mongo).find_base_directory(mount_point)
+        dir = feature(:mongo).find_marked_directory(mount_point)
         fail!("Snapshot of Mongo DB was not found mounted in #{mount_point}") if dir.nil?
         dir
       end

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

@@ -14,7 +14,11 @@ module Procedures::Backup
 
       def run
         if feature(:instance).postgresql_local?
-          local_db = feature(:foreman_database).local? ? :foreman_database : :candlepin_database
+          local_db = if feature(:instance).database_local?(:foreman_database)
+                       :foreman_database
+                     else
+                       :candlepin_database
+                     end
           feature(local_db).backup_global_objects(File.join(@backup_dir, 'pg_globals.dump'))
         else
           skip 'Backup of global objects is not supported for remote databases.'

data/definitions/procedures/backup/pulp.rb

@@ -41,7 +41,12 @@ module Procedures::Backup
     def pulp_dir
       return feature(:pulp).data_dir if @mount_dir.nil?
       mount_point = File.join(@mount_dir, 'pulp')
-      feature(:pulp).find_base_directory(mount_point)
+      dir = feature(:pulp).find_marked_directory(mount_point)
+      unless dir
+        raise ForemanMaintain::Error::Fail,
+              "Pulp base directory not found in the mount point (#{mount_point})"
+      end
+      dir
     end
 
     def ensure_dir_unchanged

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

@@ -37,9 +37,9 @@ module Procedures::Backup
           '*** It is highly suggested to backup to a different logical volume than' \
           " the #{shared_lv.join(', ')} database.\n" \
           '*** 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" \
+          " 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/n)?', 'y(yes), q(quit)')
+          'Do you want to proceed?', 'y(yes), q(quit)')
         abort! unless answer == :yes
       end
     end

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

@@ -17,12 +17,7 @@ module Procedures::Backup
 
       def run
         if feature(:mongo).local?
-          with_spinner('Creating snapshot of Mongo DB') do |spinner|
-            lv_info = get_lv_info(feature(:mongo).data_dir)
-            create_lv_snapshot('mongodb-snap', @block_size, lv_info[0])
-            spinner.update("Mounting snapshot of Mongo DB on #{mount_location('mongodb')}")
-            mount_snapshot('mongodb', lv_info[1])
-          end
+          mount_local
         else
           puts 'LV snapshots are not supported for remote databases. Doing dump instead...'
           with_spinner('Getting dump of Mongo DB') do
@@ -30,6 +25,19 @@ module Procedures::Backup
           end
         end
       end
+
+      private
+
+      def mount_local
+        with_spinner('Creating snapshot of Mongo DB') do |spinner|
+          feature(:mongo).with_marked_directory(feature(:mongo).data_dir) do
+            lv_info = get_lv_info(feature(:mongo).data_dir)
+            create_lv_snapshot('mongodb-snap', @block_size, lv_info[0])
+            spinner.update("Mounting snapshot of Mongo DB on #{mount_location('mongodb')}")
+            mount_snapshot('mongodb', lv_info[1])
+          end
+        end
+      end
     end
   end
 end

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

@@ -13,10 +13,12 @@ module Procedures::Backup
       def run
         skip if @skip
         with_spinner('Creating snapshot of Pulp') do |spinner|
-          lv_info = get_lv_info(feature(:pulp).data_dir)
-          create_lv_snapshot('pulp-snap', @block_size, lv_info[0])
-          spinner.update("Mounting snapshot of Pulp on #{mount_location('pulp')}")
-          mount_snapshot('pulp', lv_info[1])
+          feature(:pulp).with_marked_directory(feature(:pulp).data_dir) do
+            lv_info = get_lv_info(feature(:pulp).data_dir)
+            create_lv_snapshot('pulp-snap', @block_size, lv_info[0])
+            spinner.update("Mounting snapshot of Pulp on #{mount_location('pulp')}")
+            mount_snapshot('pulp', lv_info[1])
+          end
         end
       end
     end

data/definitions/procedures/crond/start.rb

@@ -0,0 +1,19 @@
+require 'procedures/service/base'
+
+module Procedures::Crond
+  class Start < Procedures::Service::Base
+    metadata do
+      description 'Start cron service'
+
+      for_feature :cron
+      tags :post_migrations, :maintenance_mode_off
+
+      after :iptables_remove_maintenance_mode_chain
+      advanced_run false
+    end
+
+    def run
+      run_service_action('start', :only => [feature(:cron).service_name])
+    end
+  end
+end

data/definitions/procedures/crond/stop.rb

@@ -0,0 +1,18 @@
+require 'procedures/service/base'
+
+module Procedures::Crond
+  class Stop < Procedures::Service::Base
+    metadata do
+      description 'Stop cron service'
+      tags :pre_migrations, :maintenance_mode_on
+      for_feature :cron
+
+      after :iptables_add_maintenance_mode_chain
+      advanced_run false
+    end
+
+    def run
+      run_service_action('stop', :only => [feature(:cron).service_name])
+    end
+  end
+end

data/definitions/procedures/iptables/add_maintenance_mode_chain.rb

@@ -0,0 +1,15 @@
+module Procedures::Iptables
+  class AddMaintenanceModeChain < ForemanMaintain::Procedure
+    metadata do
+      label :iptables_add_maintenance_mode_chain
+      for_feature :iptables
+      description 'Add maintenance_mode chain to iptables'
+      tags :pre_migrations, :maintenance_mode_on
+      after :sync_plans_disable
+    end
+
+    def run
+      feature(:iptables).add_maintenance_mode_chain
+    end
+  end
+end

data/definitions/procedures/iptables/remove_maintenance_mode_chain.rb

@@ -0,0 +1,15 @@
+module Procedures::Iptables
+  class RemoveMaintenanceModeChain < ForemanMaintain::Procedure
+    metadata do
+      label :iptables_remove_maintenance_mode_chain
+      for_feature :iptables
+      description 'Remove maintenance_mode chain from iptables'
+      tags :post_migrations, :maintenance_mode_off
+      after :sync_plans_enable
+    end
+
+    def run
+      feature(:iptables).remove_maintenance_mode_chain
+    end
+  end
+end

data/definitions/procedures/maintenance_mode/is_enabled.rb

@@ -0,0 +1,16 @@
+module Procedures::MaintenanceMode
+  class IsEnabled < ForemanMaintain::Procedure
+    metadata do
+      description 'Showing status code for maintenance_mode'
+      for_feature :iptables
+      advanced_run false
+    end
+
+    attr_reader :status_code
+
+    def run
+      @status_code = feature(:iptables).maintenance_mode_chain_exist? ? 1 : 0
+      puts "Maintenance mode is #{@status_code == 0 ? 'Off' : 'On'}"
+    end
+  end
+end

data/definitions/procedures/passenger_recycler.rb

@@ -3,11 +3,12 @@ class Procedures::PassengerRecycler < ForemanMaintain::Procedure
     description 'Perform Passenger memory recycling'
 
     confine do
-      execute?('which scl') && execute?('which passenger-recycler')
+      execute?('which passenger-recycler')
     end
   end
 
   def run
-    execute!('scl enable tfm -- ruby passenger-recycler')
+    passenger_recycler_path = execute('which passenger-recycler')
+    execute!(passenger_recycler_path)
   end
 end

data/definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb

@@ -0,0 +1,37 @@
+module Procedures::Puppet
+  class DeleteEmptyCaCertRequestFiles < ForemanMaintain::Procedure
+    metadata do
+      description 'Delete empty CA cert request files'
+      confine do
+        feature(:puppet_server)
+      end
+    end
+
+    def run
+      cacert_dir_path = feature(:puppet_server).cacert_requests_directory
+      if feature(:puppet_server).cacert_requests_dir_exists?
+        files = feature(:puppet_server).find_empty_cacert_request_files
+        if files.empty?
+          puts "No empty file(s) under #{cacert_dir_path}"
+        else
+          print_files_details(files, cacert_dir_path)
+          with_spinner('Deleting empty CA cert request files') do |spinner|
+            feature(:puppet_server).delete_empty_cacert_files
+            spinner.update 'Done with deleting empty cert request files'
+          end
+        end
+      else
+        skip "#{cacert_dir_path} directory not found"
+      end
+    end
+
+    private
+
+    def print_files_details(files, cacert_dir_path)
+      puts "Empty CA cert file(s) under #{cacert_dir_path}:"
+      files.each_with_index do |file_name, index|
+        puts "#{index + 1}. #{file_name}"
+      end
+    end
+  end
+end

data/definitions/procedures/repositories/disable.rb

@@ -0,0 +1,13 @@
+module Procedures::Repositories
+  class Disable < ForemanMaintain::Procedure
+    metadata do
+      param :repos, 'List of repositories to disable'
+      description 'Disable repositories'
+    end
+    def run
+      with_spinner('Disabling repositories') do
+        feature(:system_repos).disable_repos(@repos)
+      end
+    end
+  end
+end

data/definitions/procedures/service/base.rb

@@ -7,8 +7,9 @@ module Procedures
 
       def self.common_params(context)
         context.instance_eval do
-          param :only, 'A comma-separated list of services to include', :array => true
+          param :only, 'A comma-separated list of services to run', :array => true
           param :exclude, 'A comma-separated list of services to skip', :array => true
+          param :include, 'A comma-separated list of services to include', :array => true
         end
       end
 
@@ -24,7 +25,7 @@ module Procedures
       end
 
       def common_options
-        { :only => @only, :exclude => @exclude }
+        { :only => @only, :exclude => @exclude, :include => @include }
       end
 
       private

data/definitions/procedures/sync_plans/disable.rb

@@ -4,7 +4,7 @@ module Procedures::SyncPlans
     metadata do
       for_feature :sync_plans
       description 'disable active sync plans'
-      tags :pre_migrations
+      tags :pre_migrations, :maintenance_mode_on
 
       confine do
         feature(:katello)
@@ -21,7 +21,7 @@ module Procedures::SyncPlans
       default_storage = ForemanMaintain.storage(:default)
       feature(:sync_plans).load_from_storage(default_storage)
       with_spinner('disabling sync plans') do |spinner|
-        ids = feature(:sync_plans).sync_plan_ids_by_status(true)
+        ids = feature(:sync_plans).ids_by_status(true)
         feature(:sync_plans).make_disable(ids)
         spinner.update "Total #{ids.length} sync plans are now disabled."
       end

data/definitions/procedures/sync_plans/enable.rb

@@ -4,7 +4,7 @@ module Procedures::SyncPlans
     metadata do
       for_feature :sync_plans
       description 're-enable sync plans'
-      tags :post_migrations
+      tags :post_migrations, :maintenance_mode_off
       before :disk_io
 
       confine do

data/definitions/scenarios/backup.rb

@@ -19,6 +19,7 @@ module ForemanMaintain::Scenarios
       param :tar_volume_size, 'Size of tar volume (indicates splitting)'
     end
 
+    # rubocop:disable  Metrics/MethodLength
     def compose
       check_valid_startegy
       safety_confirmation
@@ -26,6 +27,7 @@ module ForemanMaintain::Scenarios
       prepare_directory
       logical_volume_confirmation
       add_step_with_context(Procedures::Backup::Metadata)
+      add_step_with_context(Procedures::Backup::ConfigFiles)
 
       case strategy
       when :online
@@ -33,10 +35,11 @@ module ForemanMaintain::Scenarios
       when :offline
         add_offline_backup_steps
       when :snapshot
-        add_snaphot_backup_steps
+        add_snapshot_backup_steps
       end
       add_step_with_context(Procedures::Backup::CompressData)
     end
+    # rubocop:enable  Metrics/MethodLength
 
     # rubocop:disable  Metrics/MethodLength
     def set_context_mapping
@@ -127,15 +130,14 @@ module ForemanMaintain::Scenarios
     def add_offline_backup_steps
       include_dumps if include_db_dumps?
       add_steps_with_context(
-        Procedures::MaintenanceMode::Enable,
+        find_procedures(:maintenance_mode_on),
         Procedures::Service::Stop,
-        Procedures::Backup::ConfigFiles,
         Procedures::Backup::Pulp,
         Procedures::Backup::Offline::Mongo,
         Procedures::Backup::Offline::CandlepinDB,
         Procedures::Backup::Offline::ForemanDB,
         Procedures::Service::Start,
-        Procedures::MaintenanceMode::Disable
+        find_procedures(:maintenance_mode_off)
       )
     end
 
@@ -155,18 +157,17 @@ module ForemanMaintain::Scenarios
     end
 
     # rubocop:disable  Metrics/MethodLength
-    def add_snaphot_backup_steps
+    def add_snapshot_backup_steps
       add_steps_with_context(
         Procedures::Backup::Snapshot::PrepareMount,
-        Procedures::MaintenanceMode::Enable,
+        find_procedures(:maintenance_mode_on),
         Procedures::Service::Stop,
-        Procedures::Backup::ConfigFiles,
         Procedures::Backup::Snapshot::MountMongo,
         Procedures::Backup::Snapshot::MountPulp,
         Procedures::Backup::Snapshot::MountCandlepinDB,
         Procedures::Backup::Snapshot::MountForemanDB,
         Procedures::Service::Start,
-        Procedures::MaintenanceMode::Disable,
+        find_procedures(:maintenance_mode_off),
         Procedures::Backup::Pulp
       )
       if feature(:instance).database_local?(:candlepin_database)
@@ -183,7 +184,6 @@ module ForemanMaintain::Scenarios
     # rubocop:enable  Metrics/MethodLength
 
     def add_online_backup_steps
-      add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
       add_steps_with_context(
         Procedures::Backup::Online::Mongo,
@@ -219,7 +219,7 @@ module ForemanMaintain::Scenarios
 
     def compose
       add_step_with_context(Procedures::Service::Start) if strategy != :online
-      add_step_with_context(Procedures::MaintenanceMode::Disable) if strategy != :online
+      add_steps_with_context(find_procedures(:maintenance_mode_off)) if strategy != :online
       add_step_with_context(Procedures::Backup::Snapshot::CleanMount) if strategy == :snapshot
       add_step_with_context(Procedures::Backup::Clean)
     end