foreman_maintain 1.1.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a7ae9f24c88731e052acb62c13b25d29074a07ad852daa258bed6322c1d22d
-  data.tar.gz: e0420aa7dc1935c61ef479aed3a43069281797ca41f131048902c727676c6634
+  metadata.gz: 1a8f35db6a3abfa83bcb5570efadb4e1bf8af20c4375dbf53b58eba26e9c0e08
+  data.tar.gz: a7a449095345a738b168a8e5657804426855e66d53d46686a3b0fe391d661932
 SHA512:
-  metadata.gz: e0b38e2d2819e152a508874b060b22f161aa4b56523d9b6869b714f9186920fa7d61fd10b09840158c94e4b55a7c18a718307e9a02f4320426f54baa9bdfdd9f
-  data.tar.gz: d53fb1934cdc2cbbc2cad92e43a4132ff0f8ea8eec1435bd930be575d3e2284a48278809b7576bdf24b8d7df36ac39fe2dcb223813dc9f8c3b57632e08e030e5
+  metadata.gz: 5d7556a2fd54939fe0aa1b80f6156f2df7427dfb962f746d0e0d58ab77038b1ed1b4e25105f46884c8b3f1a7d7aea53508f968c1c799d91a96bc3aa008298ff2
+  data.tar.gz: f67c0fac6450e02f4485ad2c8428867e3ba49430fcadf808fd32d79564bcaec18ad10e923277a454e809f8acd2a9403169864b7328f1af42962a5a3776eadf8f

data/definitions/features/foreman_database.rb

@@ -16,7 +16,13 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
   end
 
   def config_files
-    [postgresql_conf]
+    el? ? [postgresql_conf] : []
+  end
+
+  def config_dirs
+    # On Debian config files reside in /etc/postgresql/#{version}/main/
+    # There could be more than on config dir because of multiple versions
+    deb_postgresql_config_dirs
   end
 
   def services

data/definitions/features/installer.rb

@@ -64,7 +64,9 @@ class Features::Installer < ForemanMaintain::Feature
   def config_files
     Dir.glob(File.join(config_directory, '**/*')) +
       [
-        '/usr/local/bin/validate_postgresql_connection.sh'
+        '/usr/local/bin/validate_postgresql_connection.sh',
+        '/opt/puppetlabs/puppet/cache/foreman_cache_data',
+        '/opt/puppetlabs/puppet/cache/pulpcore_cache_data'
       ]
   end
 

data/definitions/features/nftables.rb

@@ -25,12 +25,14 @@ class Features::Nftables < ForemanMaintain::Feature
     execute!("nft add chain #{family} #{table} #{chain} #{chain_options}")
   end
 
-  def add_rule(options = {})
+  def add_rules(options = {})
     family = options.fetch(:family, ip_family)
     table = options.fetch(:table, table_name)
     chain = options.fetch(:chain, chain_name)
-    rule = options.fetch(:rule) # needs validation
-    execute!("nft add rule #{family} #{table} #{chain} #{rule}")
+    rules = options.fetch(:rules) # needs validation
+    rules.each do |rule|
+      execute!("nft add rule #{family} #{table} #{chain} #{rule}")
+    end
   end
 
   def table_exist?(name = table_name)

data/definitions/features/puppet_server.rb

@@ -11,8 +11,6 @@ class Features::PuppetServer < ForemanMaintain::Feature
     [
       '/etc/puppet',
       '/etc/puppetlabs',
-      '/opt/puppetlabs/puppet/cache/foreman_cache_data',
-      '/var/lib/puppet/foreman_cache_data',
       '/opt/puppetlabs/puppet/ssl/',
       '/var/lib/puppet/ssl',
       '/var/lib/puppet',

data/definitions/procedures/backup/config_files.rb

@@ -45,10 +45,22 @@ module Procedures::Backup
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
-    # rubocop:disable Metrics/AbcSize
     def config_files
+      configs, exclude_configs = available_features_config
+
+      if feature(:foreman_proxy)
+        configs += foreman_proxy_configs
+        exclude_configs += foreman_proxy_exclude_configs
+      end
+
+      configs += config_dirs
+      configs.compact.select { |path| Dir.glob(path).any? }
+      exclude_configs.compact.select { |path| Dir.glob(path).any? }
+      [configs, exclude_configs]
+    end
+
+    def available_features_config
       configs = []
       exclude_configs = []
       ForemanMaintain.available_features.each do |feature|
@@ -59,17 +71,20 @@ module Procedures::Backup
         exclude_configs += feature.config_files_to_exclude
         exclude_configs += feature.config_files_exclude_for_online if @online_backup
       end
+      [configs, exclude_configs]
+    end
 
-      if feature(:foreman_proxy)
-        configs += feature(:foreman_proxy).config_files(@proxy_features)
-        exclude_configs += feature(:foreman_proxy).config_files_to_exclude(@proxy_features)
-      end
+    def foreman_proxy_configs
+      feature(:foreman_proxy).config_files(@proxy_features)
+    end
 
-      configs.compact.select { |path| Dir.glob(path).any? }
-      exclude_configs.compact.select { |path| Dir.glob(path).any? }
-      [configs, exclude_configs]
+    def foreman_proxy_exclude_configs
+      feature(:foreman_proxy).config_files_to_exclude(@proxy_features)
+    end
+
+    def config_dirs
+      debian_or_ubuntu? ? feature(:foreman_database).config_dirs : []
     end
-    # rubocop:enable Metrics/AbcSize
 
     private
 

data/definitions/procedures/backup/metadata.rb

@@ -17,7 +17,7 @@ module Procedures::Backup
         metadata['os_version'] = release_info(spinner)
         metadata['plugin_list'] = plugin_list(spinner) || []
         metadata['proxy_features'] = proxy_feature_list(spinner) || []
-        metadata['rpms'] = rpms(spinner)
+        installed_pkgs(metadata)
         metadata['incremental'] = @incremental_dir || false
         metadata['online'] = @online_backup
         metadata['hostname'] = hostname
@@ -28,6 +28,15 @@ module Procedures::Backup
 
     private
 
+    def installed_pkgs(metadata)
+      installed_pkgs = package_manager.list_installed_packages
+      if el?
+        metadata[:rpms] = installed_pkgs
+      else
+        metadata[:debs] = installed_pkgs
+      end
+    end
+
     def save_metadata(metadata, spinner)
       spinner.update('Saving metadata to metadata.yml')
       File.open(File.join(@backup_dir, 'metadata.yml'), 'w') do |metadata_file|
@@ -37,12 +46,7 @@ module Procedures::Backup
 
     def release_info(spinner)
       spinner.update('Collecting system release info')
-      execute!('cat /etc/redhat-release').chomp
-    end
-
-    def rpms(spinner)
-      spinner.update('Collecting installed RPMs')
-      execute!('rpm -qa').split("\n")
+      "#{os_name} #{os_version}"
     end
 
     def plugin_list(spinner)

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

@@ -20,7 +20,7 @@ module Procedures::Backup
             local_backup
           end
         else
-          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
+          puts "Backup of #{pg_data_dirs.join(',')} is not supported for remote databases." \
             ' Doing postgres dump instead...'
           with_spinner('Getting Foreman DB dump') do
             feature(:foreman_database).dump_db(File.join(@backup_dir, 'foreman.dump'))
@@ -31,22 +31,43 @@ module Procedures::Backup
       private
 
       def local_backup
-        with_spinner("Collecting data from #{pg_data_dir}") do
-          feature(:foreman_database).backup_local(
-            pg_backup_file,
-            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-            :volume_size => @tar_volume_size,
-            :data_dir => pg_data_dir
-          )
+        with_spinner("Collecting data from #{pg_data_dirs.join(',')}") do
+          pg_data_dirs.each_with_index do |pg_dir, index|
+            do_backup(pg_dir, index == 0 ? 'create' : 'append')
+          end
         end
       end
 
+      def do_backup(pg_dir, cmd)
+        feature(:foreman_database).backup_local(
+          pg_backup_file,
+          :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
+          :volume_size => @tar_volume_size,
+          :data_dir => pg_dir,
+          :command => cmd
+        )
+      end
+
       def pg_backup_file
         File.join(@backup_dir, 'pgsql_data.tar')
       end
 
-      def pg_data_dir
+      def pg_data_dirs
+        el? ? [pg_data_dir_el] : pg_data_dirs_deb
+      end
+
+      def pg_data_dirs_deb
+        # The Debian based OSes support multiple installations of Postgresql
+        # There could be situations where Foreman db is either of these versions
+        # To be sure we backup the system correctly without missing anything
+        # we backup all of the Postgresql dirs
+        # Yet to implement the snapshot backup!
+        feature(:foreman_database).data_dir
+      end
+
+      def pg_data_dir_el
         return feature(:foreman_database).data_dir if @mount_dir.nil?
+
         mount_point = File.join(@mount_dir, 'pgsql')
         dir = feature(:foreman_database).find_base_directory(mount_point)
         fail!("Snapshot of Foreman DB was not found mounted in #{mount_point}") if dir.nil?

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

@@ -19,7 +19,7 @@ module Procedures::Backup
           '*** 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.' \
+          '*** the databases while the services are live.' \
           " If you wish to utilize the #{substr}\n" \
           '*** for production use you need to ensure that there are' \
           " no modifications occurring during\n" \

data/definitions/procedures/content/prepare.rb

@@ -4,6 +4,7 @@ module Procedures::Content
       description 'Prepare content for Pulp 3'
       for_feature :pulpcore
       param :quiet, 'Keep the output on a single line', :flag => true, :default => false
+      do_not_whitelist
     end
 
     def run

data/definitions/procedures/content/switchover.rb

@@ -9,6 +9,7 @@ module Procedures::Content
       end
 
       param :skip_deb, 'Do not run debian options in installer.'
+      do_not_whitelist
     end
 
     def run

data/definitions/procedures/foreman/apipie_cache.rb

@@ -6,7 +6,7 @@ module Procedures::Foreman
     end
 
     def run
-      execute!('foreman-rake apipie:cache')
+      execute!('FOREMAN_APIPIE_LANGS=en foreman-rake apipie:cache')
     end
   end
 end

data/definitions/procedures/installer/run_for_6_11.rb

@@ -0,0 +1,52 @@
+module Procedures::Installer
+  class RunFor6_11 < ForemanMaintain::Procedure
+    metadata do
+      description 'Run installer with Candlepin SSL CA'\
+                  ' when using external database with SSL'
+      param :assumeyes, 'Do not ask for confirmation'
+      manual_detection
+    end
+
+    def run
+      if extdb_and_ssl?
+        run_installer_with_extra_option
+      else
+        run_installer
+      end
+    end
+
+    def ext_db?
+      !feature(:foreman_database).local?
+    end
+
+    def installer_answers
+      @installer_answers ||= feature(:installer).answers
+    end
+
+    def server_db_with_ssl?
+      installer_answers.fetch('katello')['candlepin_db_ssl']
+    end
+
+    def extdb_and_ssl?
+      ext_db? && server_db_with_ssl?
+    end
+
+    def run_installer_with_extra_option
+      ssl_ca_path = installer_answers.fetch('foreman')['db_root_cert']
+      spinner_msg = "Running installer with --katello-candlepin-db-ssl-ca #{ssl_ca_path} argument!"
+      with_spinner(spinner_msg) do
+        installer_args = feature(:installer).installer_arguments
+        new_ssl_arg = " --katello-candlepin-db-ssl-ca #{ssl_ca_path}"
+        installer_args << new_ssl_arg
+        feature(:installer).run(installer_args)
+      end
+    end
+
+    def run_installer
+      with_spinner('Executing installer') do
+        assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
+        feature(:installer).upgrade(:interactive => !assumeyes_val)
+      end
+    end
+  end
+end

data/definitions/procedures/maintenance_mode/disable_maintenance_mode.rb

@@ -1,5 +1,6 @@
 module Procedures::MaintenanceMode
   class DisableMaintenanceMode < ForemanMaintain::Procedure
+    include ForemanMaintain::Concerns::Firewall::MaintenanceMode
     metadata do
       label :disable_maintenance_mode
       description 'Remove maintenance mode table/chain from nftables/iptables'
@@ -11,7 +12,7 @@ module Procedures::MaintenanceMode
       if feature(:instance).firewall
         feature(:instance).firewall.disable_maintenance_mode
       else
-        warn! 'Unable to find nftables or iptables'
+        notify_and_ask_to_install_firewall_utility
       end
     end
   end

data/definitions/procedures/maintenance_mode/enable_maintenance_mode.rb

@@ -1,5 +1,6 @@
 module Procedures::MaintenanceMode
   class EnableMaintenanceMode < ForemanMaintain::Procedure
+    include ForemanMaintain::Concerns::Firewall::MaintenanceMode
     metadata do
       label :enable_maintenance_mode
       description 'Add maintenance_mode tables/chain to nftables/iptables'
@@ -14,35 +15,5 @@ module Procedures::MaintenanceMode
         notify_and_ask_to_install_firewall_utility
       end
     end
-
-    def notify_and_ask_to_install_firewall_utility
-      puts 'Unable to find nftables or iptables!'
-      question, pkg = question_and_pkg_name
-      answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
-      if answer == :yes
-        packages_action(:install, pkg)
-        feature(:instance).firewall.enable_maintenance_mode
-      end
-    end
-
-    def can_install_nft?
-      nft_kernel_version = Gem::Version.new('3.13')
-      installed_kernel_version = Gem::Version.new(execute!('uname -r').split('-').first)
-      installed_kernel_version >= nft_kernel_version
-    end
-
-    def question_and_pkg_name
-      question = 'Do you want to install missing netfilter utility '
-      pkg_to_install = []
-      if can_install_nft?
-        question << 'nftables?'
-        pkg_to_install << 'nftables'
-      else
-        question << 'iptables?'
-        pkg_to_install << 'iptables'
-      end
-      question << "\nand start maintenance mode?"
-      [question, pkg_to_install]
-    end
   end
 end

data/definitions/procedures/packages/update.rb

@@ -6,12 +6,14 @@ module Procedures::Packages
       param :force, 'Do not skip if package is installed', :flag => true, :default => false
       param :warn_on_errors, 'Do not interrupt scenario on failure',
             :flag => true, :default => false
+      param :yum_options, 'Extra yum options if any', :array => true, :default => []
     end
 
     def run
       assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
       package_manager.clean_cache(:assumeyes => assumeyes_val)
-      packages_action(:update, @packages, :assumeyes => assumeyes_val)
+      opts = { :assumeyes => assumeyes_val, :yum_options => @yum_options }
+      packages_action(:update, @packages, opts)
     rescue ForemanMaintain::Error::ExecutionError => e
       if @warn_on_errors
         set_status(:warning, e.message)

data/definitions/procedures/restore/extract_files.rb

@@ -71,6 +71,10 @@ module Procedures::Restore
         :transform => any_database.restore_transform
       )
       feature(:tar).run(pgsql_data_tar)
+      del_data_dir_param if el?
+    end
+
+    def del_data_dir_param
       # workaround for https://tickets.puppetlabs.com/browse/MODULES-11160
       execute("sed -i '/data_directory/d' #{any_database.postgresql_conf}")
     end

data/definitions/procedures/selinux/set_file_security.rb

@@ -7,6 +7,9 @@ module Procedures::Selinux
             'Is the backup incremental?',
             :required => true
       manual_detection
+      confine do
+        File.directory?('/sys/fs/selinux')
+      end
     end
 
     def run

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
@@ -33,10 +34,19 @@ module ForemanMaintain::Scenarios
       when :offline
         add_offline_backup_steps
       when :snapshot
+        deb_snapshot_msg
         add_snapshot_backup_steps
       end
       add_step_with_context(Procedures::Backup::CompressData)
     end
+    # rubocop:enable Metrics/MethodLength
+
+    def deb_snapshot_msg
+      if debian_or_ubuntu?
+        puts 'The snapshot backup is not yet available for Debian based OSes!'
+        exit 0
+      end
+    end
 
     # rubocop:disable  Metrics/MethodLength
     def set_context_mapping

data/definitions/scenarios/packages.rb

@@ -107,9 +107,9 @@ module ForemanMaintain::Scenarios
         else
           add_steps_with_context(
             Procedures::Packages::UpdateAllConfirmation,
-            Procedures::Packages::InstallerConfirmation,
-            Procedures::Packages::UnlockVersions
+            Procedures::Packages::InstallerConfirmation
           )
+          add_step_with_context(Procedures::Packages::UnlockVersions)
           add_step_with_context(Procedures::Packages::Update,
                                 :force => true, :warn_on_errors => true)
           add_step_with_context(Procedures::Installer::Upgrade)

data/definitions/scenarios/puppet.rb

@@ -15,6 +15,9 @@ module ForemanMaintain::Scenarios
           add_step(Procedures::Puppet::RemovePuppet)
           add_step(Procedures::Puppet::RemovePuppetData) if context.get(:remove_data)
           add_step(Procedures::Service::Restart)
+          if server?
+            add_step(Procedures::Foreman::ApipieCache)
+          end
         end
       end
     end

data/definitions/scenarios/self_upgrade.rb

@@ -1,17 +1,6 @@
 module ForemanMaintain::Scenarios
   class SelfUpgradeBase < ForemanMaintain::Scenario
-    def enabled_system_repos_id
-      repository_manager.enabled_repos.keys
-    end
-
-    def enable_repos(repo_ids = stored_enabled_repos_ids)
-      add_step(Procedures::Repositories::Enable.new(repos: repo_ids))
-    end
-
-    def disable_repos(repo_ids = stored_enabled_repos_ids)
-      add_step(Procedures::Repositories::Disable.new(repos: repo_ids))
-    end
-
+    include ForemanMaintain::Concerns::Downstream
     def target_version
       current_full_version = feature(:instance).downstream.current_version
       @target_version ||= current_full_version.bump
@@ -43,33 +32,6 @@ module ForemanMaintain::Scenarios
       end
     end
 
-    def maintenance_repo_version
-      return '6' if current_version == '6.10'
-
-      current_version
-    end
-
-    def stored_enabled_repos_ids
-      @stored_enabled_repos_ids ||= begin
-        path = File.expand_path('enabled_repos.yml', ForemanMaintain.config.backup_dir)
-        @stored_enabled_repos_ids = File.file?(path) ? YAML.load(File.read(path)) : []
-      end
-    end
-
-    def all_maintenance_repos
-      repo_regex = if el7?
-                     /rhel-\d-server-satellite-maintenance-\d.\d-rpms/
-                   else
-                     /satellite-maintenance-\d.\d-for-rhel-\d-x86_64-rpms/
-                   end
-      stored_enabled_repos_ids.select { |id| !id.match(repo_regex).nil? }
-    end
-
-    def repos_ids_to_reenable
-      repos_ids_to_reenable = stored_enabled_repos_ids - all_maintenance_repos
-      repos_ids_to_reenable << maintenance_repo(maintenance_repo_version)
-    end
-
     def use_rhsm?
       return false if maintenance_repo_label
 
@@ -79,6 +41,14 @@ module ForemanMaintain::Scenarios
 
       true
     end
+
+    def req_repos_to_update_pkgs
+      if use_rhsm?
+        main_rh_repos + [maintenance_repo_id(target_version)]
+      else
+        [maintenance_repo_id(target_version)]
+      end
+    end
   end
 
   class SelfUpgrade < SelfUpgradeBase
@@ -92,28 +62,11 @@ module ForemanMaintain::Scenarios
     def compose
       if check_min_version('foreman', '2.5') || check_min_version('foreman-proxy', '2.5')
         pkgs_to_update = %w[satellite-maintain rubygem-foreman_maintain]
-        add_step(Procedures::Repositories::BackupEnabledRepos.new)
-        disable_repos
-        add_step(Procedures::Repositories::Enable.new(repos: [maintenance_repo_id(target_version)],
-                                                      use_rhsm: use_rhsm?))
-        add_step(Procedures::Packages::Update.new(packages: pkgs_to_update, assumeyes: true))
-        enable_repos(repos_ids_to_reenable)
-      end
-    end
-  end
-
-  class SelfUpgradeRescue < SelfUpgradeBase
-    metadata do
-      label :rescue_self_upgrade
-      description 'Disables all version specific maintenance repositories and,'\
-  		 "\nenables the repositories which were configured prior to self upgrade"
-      manual_detection
-      run_strategy :fail_slow
-    end
-
-    def compose
-      if check_min_version('foreman', '2.5') || check_min_version('foreman-proxy', '2.5')
-        enable_repos(repos_ids_to_reenable)
+        yum_options = req_repos_to_update_pkgs.map do |id|
+          "--enablerepo=#{id}"
+        end
+        add_step(Procedures::Packages::Update.new(packages: pkgs_to_update, assumeyes: true,
+                                                  yum_options: yum_options))
       end
     end
   end

data/definitions/scenarios/upgrade_to_capsule_6_12.rb

@@ -0,0 +1,90 @@
+module Scenarios::Capsule_6_12
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_scenario
+        confine do
+          feature(:capsule) &&
+            (feature(:capsule).current_minor_version == '6.11' || \
+            ForemanMaintain.upgrade_in_progress == '6.12')
+        end
+        instance_eval(&block)
+      end
+    end
+
+    def target_version
+      '6.12'
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Capsule 6.12'
+      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::Foreman::CheckpointSegments)
+      add_step(Checks::Repositories::Validate.new(:version => '6.12'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Capsule 6.12'
+      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 Capsule 6.12'
+      tags :migrations
+    end
+
+    def set_context_mapping
+      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '6.12'))
+      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true))
+      add_step_with_context(Procedures::Installer::Upgrade)
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures after migrating to Capsule 6.12'
+      tags :post_migrations
+    end
+
+    def compose
+      add_step(Procedures::RefreshFeatures)
+      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 Capsule 6.12'
+      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