class ForemanMaintain::Utils::Backup

Attributes

foreman_offline_files[RW]
foreman_online_files[RW]
fpc_offline_files[RW]
fpc_online_files[RW]
katello_offline_files[RW]
katello_online_files[RW]
standard_files[RW]

Public Class Methods

new(backup_dir) click to toggle source

rubocop:disable Metrics/MethodLength

# File lib/foreman_maintain/utils/backup.rb, line 15
def initialize(backup_dir)
  # fpc stands for foreman proxy w/ content
  @backup_dir = backup_dir
  @standard_files = ['config_files.tar.gz']
  @foreman_online_files = ['foreman.dump']
  @foreman_offline_files = ['pgsql_data.tar.gz']
  @katello_online_files = ['candlepin.dump', 'foreman.dump']
  @katello_offline_files = ['pgsql_data.tar.gz']
  if feature(:pulp2)
    @katello_online_files  << 'mongo_dump'
    @katello_offline_files << 'mongo_data.tar.gz'
    @fpc_online_files = ['mongo_dump']
    @fpc_offline_files = ['mongo_data.tar.gz']
  elsif feature(:pulpcore_database)
    @katello_online_files << 'foreman.dump'
    @fpc_online_files = ['pulpcore.dump']
    @fpc_offline_files = ['pgsql_data.tar.gz']
  end
end

Public Instance Methods

check_backup() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 68
def check_backup
  if feature(:instance).foreman_proxy_with_content?
    valid_fpc_backup?
  elsif feature(:katello)
    valid_katello_backup?
  else
    valid_foreman_backup?
  end
end
check_file_existence(existence_map) click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 94
def check_file_existence(existence_map)
  existence_map[:present].each do |file|
    unless file_map[file][:present]
      return false
    end
  end

  existence_map[:absent].each do |file|
    if file_map[file][:present]
      return false
    end
  end

  true
end
dumps_for_hybrid_db_setup(dbs_hash) click to toggle source

rubocop:disable Metrics/MethodLength

# File lib/foreman_maintain/utils/backup.rb, line 247
def dumps_for_hybrid_db_setup(dbs_hash)
  present = []
  absent = []
  dbs_hash.each do |data_file, dbs|
    dbs.each do |db|
      feature_label = db == 'mongo' ? db : "#{db}_database"
      dump_file = "#{db}_dump"
      if feature(feature_label.to_sym).local?
        present |= [data_file]
        absent << dump_file.to_sym
      else
        present << dump_file.to_sym
      end
    end
    absent |= [data_file] unless present.include?(data_file)
  end
  [present, absent]
end
file_map() click to toggle source

rubocop:enable Metrics/MethodLength

# File lib/foreman_maintain/utils/backup.rb, line 36
def file_map
  @file_map ||= {
    :mongo_data => map_file(@backup_dir, 'mongo_data.tar.gz'),
    :pgsql_data => map_file(@backup_dir, 'pgsql_data.tar.gz'),
    :pulp_data => map_file(@backup_dir, 'pulp_data.tar'),
    :foreman_dump => map_file(@backup_dir, 'foreman.dump'),
    :candlepin_dump => map_file(@backup_dir, 'candlepin.dump'),
    :mongo_dump => map_file(@backup_dir, 'mongo_dump'),
    :config_files => map_file(@backup_dir, 'config_files.tar.gz'),
    :metadata => map_file(@backup_dir, 'metadata.yml'),
    :pulpcore_dump => map_file(@backup_dir, 'pulpcore.dump')
  }
end
foreman_logical_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 241
def foreman_logical_backup?
  check_file_existence(:present => [:pgsql_data, :foreman_dump],
                       :absent => [:candlepin_dump, :mongo_data, :mongo_dump, :pulpcore_dump])
end
foreman_online_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 235
def foreman_online_backup?
  check_file_existence(:present => [:foreman_dump],
                       :absent => [:candlepin_dump, :pgsql_data,
                                   :mongo_data, :mongo_dump, :pulpcore_dump])
end
foreman_standard_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 229
def foreman_standard_backup?
  check_file_existence(:present => [:pgsql_data],
                       :absent => [:candlepin_dump, :foreman_dump, :pulpcore_dump,
                                   :mongo_data, :mongo_dump])
end
fpc_hybrid_db_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 220
def fpc_hybrid_db_backup?
  all_dbs = { :pgsql_data => [], :mongo_data => [] }
  all_dbs[:pgsql_data] << 'pulpcore' if feature(:pulpcore_database)
  all_dbs[:mongo_data] << 'mongo' if feature(:mongo)
  present, absent = dumps_for_hybrid_db_setup(all_dbs)
  absent.concat [:candlepin_dump, :foreman_dump]
  check_file_existence(:present => present, :absent => absent)
end
fpc_logical_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 203
def fpc_logical_backup?
  present = []
  absent = [:candlepin_dump, :foreman_dump]
  if feature(:pulpcore_database) && !feature(:pulp2)
    present.concat [:pulpcore_dump, :pgsql_data]
    absent.concat [:mongo_dump, :mongo_data]
  elsif feature(:pulp2) && feature(:pulpcore_database)
    present.concat [:mongo_dump, :mongo_data, :pulpcore_dump, :pgsql_data]
  elsif feature(:pulp2)
    present.concat [:mongo_dump, :mongo_data]
    absent.concat [:pulpcore_dump, :pgsql_data]
  else
    return false
  end
  check_file_existence(:present => present, :absent => absent)
end
fpc_online_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 186
def fpc_online_backup?
  present = []
  absent = [:mongo_data, :pgsql_data, :candlepin_dump, :foreman_dump]
  if feature(:pulpcore_database) && !feature(:pulp2)
    present.concat [:pulpcore_dump]
    absent.concat [:mongo_dump]
  elsif feature(:pulp2) && feature(:pulpcore_database)
    present.concat [:mongo_dump, :pulpcore_dump]
  elsif feature(:pulp2)
    present.concat [:mongo_dump]
    absent.concat [:pulpcore_dump]
  else
    return false
  end
  check_file_existence(:present => present, :absent => absent)
end
fpc_standard_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 168
def fpc_standard_backup?
  present = []
  absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump, :mongo_dump]
  if feature(:pulpcore_database) && !feature(:pulp2)
    present.concat [:pgsql_data]
    absent.concat [:mongo_data]
  elsif feature(:pulp2) && feature(:pulpcore_database)
    present.concat [:mongo_data, :pgsql_data]
  elsif feature(:pulp2)
    present.concat [:mongo_data]
    absent.concat [:pgsql_data]
  else
    return false
  end
  check_file_existence(:present => present,
                       :absent => absent)
end
incremental?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 333
def incremental?
  !!metadata.fetch('incremental', false)
end
katello_hybrid_db_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 160
def katello_hybrid_db_backup?
  all_dbs = { :pgsql_data => %w[candlepin foreman], :mongo_data => [] }
  all_dbs[:pgsql_data] << 'pulpcore' if feature(:pulpcore_database)
  all_dbs[:mongo_data] << 'mongo' if feature(:mongo)
  present, absent = dumps_for_hybrid_db_setup(all_dbs)
  check_file_existence(:present => present, :absent => absent)
end
katello_logical_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 142
def katello_logical_backup?
  present = [:pgsql_data, :candlepin_dump, :foreman_dump]
  absent = []
  if feature(:pulpcore_database) && !feature(:pulp2)
    present.concat [:pulpcore_dump]
    absent.concat [:mongo_dump, :mongo_data]
  elsif feature(:pulp2) && feature(:pulpcore_database)
    present.concat [:mongo_dump, :mongo_data, :pulpcore_dump]
  elsif feature(:pulp2)
    present.concat [:mongo_dump, :mongo_data]
    absent.concat [:pulpcore_dump]
  else
    return false
  end
  check_file_existence(:present => present,
                       :absent => absent)
end
katello_online_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 124
def katello_online_backup?
  present = [:candlepin_dump, :foreman_dump]
  absent = [:mongo_data, :pgsql_data]
  if feature(:pulpcore_database) && !feature(:pulp2)
    present.concat [:pulpcore_dump]
    absent.concat [:mongo_dump]
  elsif feature(:pulp2) && feature(:pulpcore_database)
    present.concat [:mongo_dump, :pulpcore_dump]
  elsif feature(:pulp2)
    present.concat [:mongo_dump]
    absent.concat [:pulpcore_dump]
  else
    return false
  end
  check_file_existence(:present => present,
                       :absent => absent)
end
katello_standard_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 110
def katello_standard_backup?
  present = [:pgsql_data]
  absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump, :mongo_dump]
  if feature(:pulpcore_database) && !feature(:pulp2)
    absent.concat [:mongo_data]
  elsif feature(:pulp2)
    present.concat [:mongo_data]
  else
    return false
  end
  check_file_existence(:present => present,
                       :absent => absent)
end
map_file(backup_dir, filename) click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 50
def map_file(backup_dir, filename)
  file_path = File.join(backup_dir, filename)
  present = File.exist?(file_path)
  {
    :present => present,
    :path => file_path
  }
end
metadata() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 309
def metadata
  if file_map[:metadata][:present]
    YAML.load_file(file_map[:metadata][:path])
  else
    {}
  end
end
online_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 337
def online_backup?
  !!metadata.fetch('online', false)
end
present_files() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 59
def present_files
  present_files = file_map.select { |_k, v| v[:present] }
  present_files.values.map { |f| File.basename(f[:path]) }
end
pulp_tar_split?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 317
def pulp_tar_split?
  File.exist?(File.join(@backup_dir, 'pulp_data.part0002'))
end
sql_dump_files_exist?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 327
def sql_dump_files_exist?
  file_map[:foreman_dump][:present] ||
    file_map[:candlepin_dump][:present] ||
    (feature(:pulpcore_database) && file_map[:pulpcore_dump][:present])
end
tar_backups_exist?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 321
def tar_backups_exist?
  file_map[:mongo_data][:present] ||
    file_map[:pulp_data][:present] ||
    file_map[:pgsql_data][:present]
end
valid_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 64
def valid_backup?
  file_map[:config_files][:present] && check_backup
end
valid_foreman_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 90
def valid_foreman_backup?
  foreman_standard_backup? || foreman_online_backup? || foreman_logical_backup?
end
valid_fpc_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 78
def valid_fpc_backup?
  fpc_online_backup? || fpc_standard_backup? || fpc_logical_backup? || \
    # fpc can have setup where mongo or pulpcore db is external but not both
    fpc_hybrid_db_backup?
end
valid_katello_backup?() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 84
def valid_katello_backup?
  katello_online_backup? || katello_standard_backup? || katello_logical_backup? || \
    # Katello can have setup where some of dbs are external but not all
    katello_hybrid_db_backup?
end
validate_hostname?() click to toggle source

rubocop:enable Metrics/MethodLength

# File lib/foreman_maintain/utils/backup.rb, line 267
def validate_hostname?
  # make sure that the system hostname is the same as the backup
  hostname_from_metadata = metadata.fetch('hostname', nil)
  if hostname_from_metadata
    hostname_from_metadata == hostname
  else
    config_tarball = file_map[:config_files][:path]
    tar_cmd = "tar zxf #{config_tarball} etc/httpd/conf/httpd.conf --to-stdout --occurrence=1"
    status, httpd_config = execute_with_status(tar_cmd)

    # Incremental backups sometimes don't include httpd.conf. Since a "base" backup
    # is restored before an incremental, we can assume that the hostname is checked
    # during the base backup restore
    if status == 0
      match = httpd_config.match(/\s*ServerName\s+"*([^ "]+)"*\s*$/)
      match ? match[1] == hostname : false
    else
      true
    end
  end
end
validate_interfaces() click to toggle source
# File lib/foreman_maintain/utils/backup.rb, line 289
def validate_interfaces
  # I wanted to do `Socket.getifaddrs.map(&:name).uniq`,
  # but this has to work with Ruby 2.0, and Socket.getifaddrs is 2.1+
  errors = {}
  system_interfaces = Dir.entries('/sys/class/net') - ['.', '..']

  proxy_config = metadata.fetch('proxy_config', {})

  %w[dns dhcp].each do |feature|
    next unless proxy_config.fetch(feature, false)

    wanted_interface = proxy_config.fetch("#{feature}_interface", 'lo')
    unless system_interfaces.include?(wanted_interface)
      errors[feature] = { 'configured' => wanted_interface, 'available' => system_interfaces }
    end
  end

  return errors
end