foreman_maintain 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a85ae503f11debb15fd1a4321f46da9f2d6a89db
-  data.tar.gz: 94b3ffb6d47033a5351798cde22c5c1924da69c2
+  metadata.gz: '078ab0c0f9b3bfe3b4a6a798aaa181bb0ecba87e'
+  data.tar.gz: 898a5faf68654553aafaa03c8afe026e33ddc8e2
 SHA512:
-  metadata.gz: 4a0956cc569272ede19b66d720c4ced7861f9a0a32c06cb6203188a1d8471f42cd2198976f3438b5a2ede7be86e164300df8bc3477c299b193ff156c69e6c5aa
-  data.tar.gz: f947a4053c037fe23563250e06928ab75e99d2a2b9fa78b6c2d03869bfa70419181d4960c476991242782a38d424d3c32fe9ff2366904311c4ad0f3da853a7ff
+  metadata.gz: c512de5ef767ec004443beb7f32386ea113899b626ebe195ac69aeba6d2ec21cb66fcb4d93b8423fbbb8e3ee56bf54f95d11d59bc6fc892fa412b28b532f9e3b
+  data.tar.gz: 3be8f1aad6584b3565841633d3b6f6ef99c2fbf7eb7b986e34e58b7dce60fd775bde2a3dbed6ce3a11cbddaff0490ae82d31f126ae92cfa36f40807b77836491

data/bin/foreman-maintain

@@ -9,4 +9,5 @@ CONFIG_FILE = '/etc/foreman-maintain/foreman_maintain.yml'.freeze
 ForemanMaintain.setup
 
 require 'foreman_maintain/cli'
-ForemanMaintain::Cli::MainCommand.run
+exit_code = ForemanMaintain::Cli::MainCommand.run
+exit(exit_code || 0)

data/definitions/checks/backup/directory_ready.rb

@@ -10,7 +10,7 @@ module Checks::Backup
 
     def run
       assert(File.directory?(@backup_dir), "Backup directory (#{@backup_dir}) does not exit.")
-      if local_psql_database?
+      if feature(:instance).postgresql_local?
         result = system("runuser - postgres -c 'test -w #{@backup_dir}'")
         assert(result, "Postgres user needs write access to the backup directory \n" \
           "Please allow the postgres user write access to #{@backup_dir}" \

data/definitions/checks/restore/validate_backup.rb

@@ -0,0 +1,77 @@
+require 'foreman_maintain/utils/backup'
+
+module Checks::Restore
+  class ValidateBackup < ForemanMaintain::Check
+    metadata do
+      description 'Validate backup has appropriate files'
+
+      param :backup_dir,
+            'Path to backup directory',
+            :required => true
+      manual_detection
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+      assert(backup.valid_backup?, valid_backup_message(backup))
+    end
+
+    def valid_backup_message(backup)
+      message = "\n"
+      message += "The given directory does not contain the required files or has too many files\n\n"
+      message += "All backup directories contain: #{backup.standard_files.join(', ')}\n"
+      message += required_files(backup)
+      message += 'Including pulp_data.tar is optional and '
+      message += "will restore pulp data to the filesystem if included.\n\n"
+      message += "Only the following files were found: #{backup.present_files.join(', ')}\n"
+      message
+    end
+
+    def required_files(backup)
+      message = ''
+      message += if feature(:instance).foreman_proxy_with_content?
+                   required_fpc_files(backup)
+                 elsif feature(:katello)
+                   required_katello_files(backup)
+                 else
+                   required_foreman_files(backup)
+                 end
+      message
+    end
+
+    def required_katello_files(backup)
+      backup_files_message(
+        backup.katello_online_files.join(', '),
+        backup.katello_offline_files.join(', '),
+        [backup.katello_online_files + backup.katello_offline_files].join(', ')
+      )
+    end
+
+    def required_fpc_files(backup)
+      backup_files_message(
+        backup.fpc_online_files.join(', '),
+        backup.fpc_offline_files.join(', '),
+        [backup.fpc_online_files + backup.fpc_offline_files].join(', ')
+      )
+    end
+
+    def required_foreman_files(backup)
+      backup_files_message(
+        backup.foreman_online_files.join(', '),
+        backup.foreman_offline_files.join(', '),
+        [backup.foreman_online_files + backup.foreman_offline_files].join(', ')
+      )
+    end
+
+    def backup_files_message(online_files, offline_files, logical_files)
+      message = ''
+      message += 'An online or remote database backup directory contains: '
+      message += "#{online_files}\n"
+      message += 'An offline backup directory contains: '
+      message += "#{offline_files}\n"
+      message += 'A logical backup directory contains: '
+      message += "#{logical_files}\n"
+      message
+    end
+  end
+end

data/definitions/checks/restore/validate_hostname.rb

@@ -0,0 +1,20 @@
+require 'foreman_maintain/utils/backup'
+
+module Checks::Restore
+  class ValidateHostname < ForemanMaintain::Check
+    metadata do
+      description 'Validate hostname is the same as backup'
+
+      param :backup_dir,
+            'Path to backup directory',
+            :required => true
+      manual_detection
+    end
+
+    def run
+      msg = 'The hostname in the backup does not match the hostname of the system'
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+      assert(backup.validate_hostname?, msg)
+    end
+  end
+end

data/definitions/features/foreman_proxy.rb

@@ -17,6 +17,10 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     dhcp_req_pass? && !syntax_error_exists?
   end
 
+  def with_content?
+    !!feature(:pulp)
+  end
+
   def services
     {
       'foreman-proxy'            => 20,
@@ -36,7 +40,8 @@ class Features::ForemanProxy < ForemanMaintain::Feature
   def config_files(for_features = ['all'])
     configs = [
       '/etc/foreman-proxy',
-      '/usr/share/foreman-proxy/.ssh/',
+      '/usr/share/foreman-proxy/.ssh',
+      '/var/lib/foreman-proxy/ssh',
       '/etc/smart_proxy_dynflow_core/settings.yml',
       '/etc/sudoers.d/foreman-proxy'
     ]

data/definitions/features/foreman_tasks.rb

@@ -108,7 +108,11 @@ class Features::ForemanTasks < ForemanMaintain::Feature
   end
 
   def services
-    { 'foreman-tasks' => 30 }
+    if check_min_version('foreman', '1.17')
+      { 'dynflowd' => 30 }
+    else
+      { 'foreman-tasks' => 30 }
+    end
   end
 
   private

data/definitions/features/instance.rb

@@ -29,6 +29,10 @@ class Features::Instance < ForemanMaintain::Feature
     end
   end
 
+  def database_remote?(feature)
+    !!feature(feature) && !feature(feature).local?
+  end
+
   def database_local?(feature)
     !!feature(feature) && feature(feature).local?
   end
@@ -36,4 +40,8 @@ class Features::Instance < ForemanMaintain::Feature
   def postgresql_local?
     database_local?(:candlepin_database) || database_local?(:foreman_database)
   end
+
+  def foreman_proxy_with_content?
+    feature(:foreman_proxy) && feature(:foreman_proxy).with_content? && !feature(:katello)
+  end
 end

data/definitions/features/katello.rb

@@ -7,7 +7,6 @@ class Features::Katello < ForemanMaintain::Feature
     end
   end
 
-  # TODO: refactor to new features?
   def data_dirs
     @dirs ||= ['/var/lib/pulp', '/var/lib/mongodb', '/var/lib/pgsql']
   end

data/definitions/features/mongo.rb

@@ -31,16 +31,31 @@ class Features::Mongo < ForemanMaintain::Feature
     @configuration = load_db_config(config_file)
   end
 
+  # guess mongo version from installed packages
+  # safe method to run mongo commands prior we know
+  # what version uses the target DB
+  def available_core
+    return @core unless @core.nil? # return correct mongo ver if known
+    if @available_core.nil?
+      @available_core = ForemanMaintain::Utils::MongoCoreInstalled.new
+    end
+    @available_core
+  end
+
   def core
     if @core.nil?
-      version = server_version
-      @core = if version =~ /^3\.4/
-                logger.debug("Mongo #{version} detected, using commands from rh-mongodb34 SCL")
-                ForemanMaintain::Utils::MongoCore34.new
-              else
-                logger.debug("Mongo #{version} detected, using default commands")
-                ForemanMaintain::Utils::MongoCore.new
-              end
+      begin
+        version = server_version
+        @core = if version =~ /^3\.4/
+                  load_mongo_core_34(version)
+                else
+                  load_mongo_core_default(version)
+                end
+      rescue ForemanMaintain::Error::ExecutionError
+        # server version detection failed
+        logger.debug('Mongo version detection failed, choosing from installed versions')
+        @core = @available_core
+      end
     end
     @core
   end
@@ -72,20 +87,27 @@ class Features::Mongo < ForemanMaintain::Feature
              :hidden_patterns => [config['password']].compact)
   end
 
+  def restore(dir, config = configuration)
+    cmd = base_command(core.restore_command, config,
+                       "-d #{config['name']} #{File.join(dir, config['name'])}")
+    execute!(cmd, :hidden_patterns => [config['password']].compact)
+  end
+
   def dropdb(config = configuration)
     execute!(mongo_command("--eval 'db.dropDatabase()'", config),
              :hidden_patterns => [config['password']].compact)
   end
 
   def ping(config = configuration)
-    execute?(mongo_command("--eval 'ping:1'"),
+    execute?(mongo_command("--eval 'ping:1'", config),
              :hidden_patterns => [config['password']].compact)
   end
 
   def server_version(config = configuration)
     # do not use any core methods as we need this prior the core is created
-    version = execute(base_command('mongo', config, "--eval 'db.version()' #{config['name']}"),
-                      :hidden_patterns => [config['password']].compact)
+    mongo_cmd = base_command(available_core.client_command, config,
+                             "--eval 'db.version()' #{config['name']}")
+    version = execute!(mongo_cmd, :hidden_patterns => [config['password']].compact)
     version.split("\n").last
   end
 
@@ -98,7 +120,8 @@ class Features::Mongo < ForemanMaintain::Feature
         :archive => backup_file,
         :command => 'create',
         :exclude => ['mongod.lock'],
-        :transform => 's,^,var/lib/mongodb/,S'
+        :transform => 's,^,var/lib/mongodb/,S',
+        :files => '*'
       }.merge(extra_tar_options)
       feature(:tar).run(tar_options)
     end
@@ -110,6 +133,22 @@ class Features::Mongo < ForemanMaintain::Feature
 
   private
 
+  def load_mongo_core_default(version)
+    unless find_package('mongodb')
+      raise ForemanMaintain::Error::Fail, 'Mongo client was not found'
+    end
+    logger.debug("Mongo #{version} detected, using default commands")
+    ForemanMaintain::Utils::MongoCore.new
+  end
+
+  def load_mongo_core_34(version)
+    unless find_package('rh-mongodb34-mongodb')
+      raise ForemanMaintain::Error::Fail, 'Mongo client ver. 3.4 was not found'
+    end
+    logger.debug("Mongo #{version} detected, using commands from rh-mongodb34 SCL")
+    ForemanMaintain::Utils::MongoCore34.new
+  end
+
   def norm_value(value)
     value = value.strip
     case value

data/definitions/features/pulp.rb

@@ -29,7 +29,8 @@ class Features::Pulp < ForemanMaintain::Feature
       '/etc/qpid-dispatch',
       '/etc/crane.conf',
       '/etc/default/pulp_workers',
-      '/var/lib/qpidd'
+      '/var/lib/qpidd',
+      '/etc/qpid-dispatch'
     ]
   end
 

data/definitions/features/service.rb

@@ -66,6 +66,42 @@ class Features::Service < ForemanMaintain::Feature
   end
 
   def perform_action_on_service(action, service)
+    if service == 'postgresql'
+      if feature(:instance).postgresql_local?
+        perform_action_on_local_service(action, service)
+      end
+      if feature(:instance).database_remote?(:candlepin_database)
+        remote_db_message('Candlepin', :candlepin_database, action)
+      end
+      if feature(:instance).database_remote?(:foreman_database)
+        remote_db_message('Foreman', :foreman_database, action)
+      end
+    elsif service =~ /^.*mongod$/ && feature(:instance).database_remote?(:mongo)
+      remote_db_message('Pulp', :mongo, action)
+    else
+      perform_action_on_local_service(action, service)
+    end
+  end
+
+  def remote_db_message(app, db, action)
+    ping = !!feature(db).ping
+    message = if %w[enable disable].include?(action)
+                " - #{app} DB is remote. Can not #{action} the service."
+              else
+                'the service is on remote host. The DB is ' + (ping ? 'UP.' : 'DOWN.')
+              end
+    if action == 'status'
+      puts "\nFor #{app} DB #{message}\n"
+    else
+      print " - #{message}"
+    end
+    logger.info(message)
+    if action == 'start' && !ping
+      raise ForemanMaintain::Error::Fail, "The remote #{app} databse is down."
+    end
+  end
+
+  def perform_action_on_local_service(action, service)
     command = service_command(action, service)
     if action == 'status'
       status = execute(command)

data/definitions/features/tar.rb

@@ -14,7 +14,11 @@ class Features::Tar < ForemanMaintain::Feature
   # @option options [String] :volume_size size of tar volume
   #                           (will try to split the archive when set)
   # @option options [String] :files (*) files to operate on
-  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+  # @option options [String] :directory change to directory DIR
+  # @option options [Boolean] :multi_volume create/list/extract multi-volume archive
+  # @option options [Boolean] :overwrite overwrite existing files when extracting
+  # @option options [Boolean] :gzip filter the archive through gzip
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
   def run(options = {})
     volume_size = options.fetch(:volume_size, nil)
     validate_volume_size(volume_size) unless volume_size.nil?
@@ -30,6 +34,9 @@ class Features::Tar < ForemanMaintain::Feature
       tar_command << "--new-volume-script=#{split_tar_script}"
     end
 
+    tar_command << '--overwrite' if options[:overwrite]
+    tar_command << '--gzip' if options[:gzip]
+
     exclude = options.fetch(:exclude, [])
     exclude.each do |ex|
       tar_command << "--exclude=#{ex}"
@@ -41,12 +48,17 @@ class Features::Tar < ForemanMaintain::Feature
     trans = options.fetch(:transform, nil)
     tar_command << "--transform '#{trans}'" if trans
 
-    tar_command << '-S'
-    tar_command << options.fetch(:files, '*')
+    tar_command << '-M' if options[:multi_volume]
+    tar_command << "--directory=#{options[:directory]}" if options[:directory]
+
+    if options[:files]
+      tar_command << '-S'
+      tar_command << options.fetch(:files, '*')
+    end
 
     execute!(tar_command.join(' '))
   end
-  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
   def validate_volume_size(size)
     if size.nil? || size !~ /^\d+[bBcGKkMPTw]?$/

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

@@ -1,6 +1,8 @@
 module Procedures::Backup
   module Online
     class PgGlobalObjects < ForemanMaintain::Procedure
+      include ForemanMaintain::Concerns::SystemHelpers
+
       metadata do
         description 'Backup Postgres global objects online'
         tags :backup
@@ -11,7 +13,7 @@ module Procedures::Backup
       end
 
       def run
-        if feature(:foreman_database).local? || feature(:candlepin_database).local?
+        if feature(:instance).postgresql_local?
           local_db = feature(:foreman_database).local? ? :foreman_database : :candlepin_database
           feature(local_db).backup_global_objects(File.join(@backup_dir, 'pg_globals.dump'))
         else

data/definitions/procedures/backup/prepare_directory.rb

@@ -16,7 +16,7 @@ module Procedures::Backup
         FileUtils.chmod_R 0o770, @backup_dir
       end
 
-      if local_psql_database? && !@preserve_dir
+      if feature(:instance).postgresql_local? && !@preserve_dir
         FileUtils.chown_R(nil, 'postgres', @backup_dir)
       end
 

data/definitions/procedures/backup/pulp.rb

@@ -33,7 +33,8 @@ module Procedures::Backup
         :exclude => ['var/lib/pulp/katello-export'],
         :listed_incremental => File.join(@backup_dir, '.pulp.snar'),
         :transform => 's,^,var/lib/pulp/,S',
-        :volume_size => @tar_volume_size
+        :volume_size => @tar_volume_size,
+        :files => '*'
       )
     end
 

data/definitions/procedures/pulp/migrate.rb

@@ -0,0 +1,21 @@
+module Procedures::Pulp
+  class Migrate < ForemanMaintain::Procedure
+    metadata do
+      description 'Migrate pulp db'
+      for_feature :pulp
+    end
+
+    def run
+      with_spinner('Migrating pulp') do |spinner|
+        necessary_services = feature(:mongo).services.keys + ['qpidd']
+        pulp_services = %w[pulp_celerybeat pulp_workers pulp_resource_manager]
+
+        feature(:service).handle_services(spinner, 'start', :only => necessary_services)
+        feature(:service).handle_services(spinner, 'stop', :only => pulp_services)
+
+        spinner.update('Migrating pulp database')
+        execute!('su - apache -s /bin/bash -c pulp-manage-db')
+      end
+    end
+  end
+end