Class: ForemanMaintain::Utils::Backup

Inherits:
Object
  • Object
show all
Includes:
Concerns::SystemHelpers
Defined in:
lib/foreman_maintain/utils/backup.rb

Constant Summary

Constants included from Concerns::OsFacts

Concerns::OsFacts::FALLBACK_OS_RELEASE_FILE, Concerns::OsFacts::OS_RELEASE_FILE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Concerns::SystemHelpers

#check_max_version, #check_min_version, #command_present?, #directory_empty?, #execute, #execute!, #execute?, #execute_runner, #execute_with_status, #file_exists?, #file_nonzero?, #find_dir_containing_file, #find_package, #find_symlinks, #foreman_plugin_name, #format_shell_args, #hammer_package, #hammer_plugin_name, #hostname, included, #package_manager, #package_version, #packages_action, #parse_csv, #parse_json, #proxy_plugin_name, #repository_manager, #ruby_prefix, #server?, #shellescape, #systemd_installed?, #version

Methods included from Concerns::OsFacts

#centos?, #cpu_cores, #deb_major_version, #debian?, #debian_or_ubuntu?, #el8?, #el?, #el_major_version, #el_short_name, #facts, #memory, #os_id, #os_id_like_list, #os_name, #os_release_file, #os_version, #os_version_codename, #os_version_id, #rhel?, #ubuntu?, #ubuntu_major_version

Methods included from Concerns::Finders

#check, #detector, #feature, #find_all_scenarios, #find_checks, #find_procedures, #find_scenarios, #procedure

Methods included from Concerns::Logger

#logger

Constructor Details

#initialize(backup_dir) ⇒ Backup

Returns a new instance of Backup.



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/foreman_maintain/utils/backup.rb', line 14

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 = @foreman_online_files + ['candlepin.dump', 'pulpcore.dump']
  @katello_offline_files = ['pgsql_data.tar.gz']
  @fpc_online_files = ['pulpcore.dump']
  @fpc_offline_files = ['pgsql_data.tar.gz']
end

Instance Attribute Details

#foreman_offline_files ⇒ Object

Returns the value of attribute foreman_offline_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def foreman_offline_files
  @foreman_offline_files
end

#foreman_online_files ⇒ Object

Returns the value of attribute foreman_online_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def foreman_online_files
  @foreman_online_files
end

#fpc_offline_files ⇒ Object

Returns the value of attribute fpc_offline_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def fpc_offline_files
  @fpc_offline_files
end

#fpc_online_files ⇒ Object

Returns the value of attribute fpc_online_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def fpc_online_files
  @fpc_online_files
end

#katello_offline_files ⇒ Object

Returns the value of attribute katello_offline_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def katello_offline_files
  @katello_offline_files
end

#katello_online_files ⇒ Object

Returns the value of attribute katello_online_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def katello_online_files
  @katello_online_files
end

#standard_files ⇒ Object

Returns the value of attribute standard_files.



10
11
12
 
# File 'lib/foreman_maintain/utils/backup.rb', line 10

def standard_files
  @standard_files
end

Instance Method Details

#check_backup ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'lib/foreman_maintain/utils/backup.rb', line 56

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) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/foreman_maintain/utils/backup.rb', line 81

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

#different_source_os? ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
 
# File 'lib/foreman_maintain/utils/backup.rb', line 273

def different_source_os?
  source_os_version != "#{os_name} #{os_version}"
end

#dumps_for_hybrid_db_setup(dbs_hash) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/foreman_maintain/utils/backup.rb', line 165

def dumps_for_hybrid_db_setup(dbs_hash)
  present = []
  absent = []
  dbs_hash.each do |data_file, dbs|
    dbs.each do |db|
      feature_label = "#{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 ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/foreman_maintain/utils/backup.rb', line 26

def file_map
  @file_map ||= {
    :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'),
    :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? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
163
 
# File 'lib/foreman_maintain/utils/backup.rb', line 160

def foreman_logical_backup?
  check_file_existence(:present => [:pgsql_data, :foreman_dump],
    :absent => [:candlepin_dump, :pulpcore_dump])
end

#foreman_online_backup? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
158
 
# File 'lib/foreman_maintain/utils/backup.rb', line 155

def foreman_online_backup?
  check_file_existence(:present => [:foreman_dump],
    :absent => [:candlepin_dump, :pgsql_data, :pulpcore_dump])
end

#foreman_standard_backup? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
153
 
# File 'lib/foreman_maintain/utils/backup.rb', line 150

def foreman_standard_backup?
  check_file_existence(:present => [:pgsql_data],
    :absent => [:candlepin_dump, :foreman_dump, :pulpcore_dump])
end

#fpc_hybrid_db_backup? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
146
147
148
 
# File 'lib/foreman_maintain/utils/backup.rb', line 143

def fpc_hybrid_db_backup?
  all_dbs = { :pgsql_data => ['pulpcore'] }
  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? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
141
 
# File 'lib/foreman_maintain/utils/backup.rb', line 137

def fpc_logical_backup?
  present = [:pulpcore_dump, :pgsql_data]
  absent = [:candlepin_dump, :foreman_dump]
  check_file_existence(:present => present, :absent => absent)
end

#fpc_online_backup? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
134
135
 
# File 'lib/foreman_maintain/utils/backup.rb', line 131

def fpc_online_backup?
  present = [:pulpcore_dump]
  absent = [:pgsql_data, :candlepin_dump, :foreman_dump]
  check_file_existence(:present => present, :absent => absent)
end

#fpc_standard_backup? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
127
128
129
 
# File 'lib/foreman_maintain/utils/backup.rb', line 124

def fpc_standard_backup?
  present = [:pgsql_data]
  absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
  check_file_existence(:present => present,
    :absent => absent)
end

#incremental? ⇒ Boolean

Returns:

  • (Boolean) 


249
250
251
 
# File 'lib/foreman_maintain/utils/backup.rb', line 249

def incremental?
  !!metadata.fetch('incremental', false)
end

#installed_rpms ⇒ Object 



257
258
259
 
# File 'lib/foreman_maintain/utils/backup.rb', line 257

def installed_rpms
  metadata.fetch('rpms', metadata.fetch(:rpms, []))
end

#katello_hybrid_db_backup? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
121
122
 
# File 'lib/foreman_maintain/utils/backup.rb', line 118

def katello_hybrid_db_backup?
  all_dbs = { :pgsql_data => %w[candlepin foreman pulpcore] }
  present, absent = dumps_for_hybrid_db_setup(all_dbs)
  check_file_existence(:present => present, :absent => absent)
end

#katello_logical_backup? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
114
115
116
 
# File 'lib/foreman_maintain/utils/backup.rb', line 111

def katello_logical_backup?
  present = [:pgsql_data, :candlepin_dump, :foreman_dump, :pulpcore_dump]
  absent = []
  check_file_existence(:present => present,
    :absent => absent)
end

#katello_online_backup? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
107
108
109
 
# File 'lib/foreman_maintain/utils/backup.rb', line 104

def katello_online_backup?
  present = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
  absent = [:pgsql_data]
  check_file_existence(:present => present,
    :absent => absent)
end

#katello_standard_backup? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
101
102
 
# File 'lib/foreman_maintain/utils/backup.rb', line 97

def katello_standard_backup?
  present = [:pgsql_data]
  absent = [:candlepin_dump, :foreman_dump, :pulpcore_dump]
  check_file_existence(:present => present,
    :absent => absent)
end

#map_file(backup_dir, filename) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/foreman_maintain/utils/backup.rb', line 38

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 ⇒ Object 



226
227
228
229
230
231
232
 
# File 'lib/foreman_maintain/utils/backup.rb', line 226

def metadata
  if file_map[:metadata][:present]
    YAML.load_file(file_map[:metadata][:path])
  else
    {}
  end
end

#online_backup? ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
 
# File 'lib/foreman_maintain/utils/backup.rb', line 253

def online_backup?
  !!metadata.fetch('online', false)
end

#present_files ⇒ Object 



47
48
49
50
 
# File 'lib/foreman_maintain/utils/backup.rb', line 47

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? ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/foreman_maintain/utils/backup.rb', line 234

def pulp_tar_split?
  File.exist?(File.join(@backup_dir, 'pulp_data.part0002'))
end

#source_os_version ⇒ Object 



269
270
271
 
# File 'lib/foreman_maintain/utils/backup.rb', line 269

def source_os_version
  metadata.fetch('os_version', 'unknown')
end

#sql_dump_files_exist? ⇒ Boolean

Returns:

  • (Boolean) 


243
244
245
246
247
 
# File 'lib/foreman_maintain/utils/backup.rb', line 243

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? ⇒ Boolean

Returns:

  • (Boolean) 


238
239
240
241
 
# File 'lib/foreman_maintain/utils/backup.rb', line 238

def tar_backups_exist?
  file_map[:pulp_data][:present] ||
    file_map[:pgsql_data][:present]
end

#valid_backup? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/foreman_maintain/utils/backup.rb', line 52

def valid_backup?
  file_map[:config_files][:present] && check_backup
end

#valid_foreman_backup? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/foreman_maintain/utils/backup.rb', line 77

def valid_foreman_backup?
  foreman_standard_backup? || foreman_online_backup? || foreman_logical_backup?
end

#valid_fpc_backup? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
69
 
# File 'lib/foreman_maintain/utils/backup.rb', line 66

def valid_fpc_backup?
  fpc_online_backup? || fpc_standard_backup? || fpc_logical_backup? || \
    fpc_hybrid_db_backup?
end

#valid_katello_backup? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
74
75
 
# File 'lib/foreman_maintain/utils/backup.rb', line 71

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? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/foreman_maintain/utils/backup.rb', line 184

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 ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/foreman_maintain/utils/backup.rb', line 206

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

#with_puppetserver? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
 
# File 'lib/foreman_maintain/utils/backup.rb', line 261

def with_puppetserver?
  installed_rpms.any? { |rpm| rpm.start_with?('puppetserver-') }
end

#with_qpidd? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
 
# File 'lib/foreman_maintain/utils/backup.rb', line 265

def with_qpidd?
  installed_rpms.any? { |rpm| rpm.start_with?('qpid-cpp-server-') }
end