Class: ForemanMaintain::Utils::Backup

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Concerns::SystemHelpers

#check_max_version, #check_min_version, #command_present?, #create_lv_snapshot, #debian?, #directory_empty?, #el7?, #el8?, #el?, #el_major_version, #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, #get_lv_info, #get_lv_path, #hammer_package, #hostname, included, #os_facts, #package_manager, #package_version, #packages_action, #parse_csv, #parse_json, #proxy_plugin_name, #rpm_version, #ruby_prefix, #server?, #shellescape, #systemd_installed?, #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

rubocop:disable Metrics/MethodLength



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# 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

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 



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

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 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/foreman_maintain/utils/backup.rb', line 91

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

#file_map ⇒ Object

rubocop:enable Metrics/MethodLength



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# 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'),
    :pg_globals => map_file(@backup_dir, 'pg_globals.dump'),
    :metadata => map_file(@backup_dir, 'metadata.yml'),
    :pulpcore_dump => map_file(@backup_dir, 'pulpcore.dump')
  }
end

#foreman_logical_backup? ⇒ Boolean

Returns:

  • (Boolean) 


222
223
224
225
 
# File 'lib/foreman_maintain/utils/backup.rb', line 222

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

Returns:

  • (Boolean) 


216
217
218
219
220
 
# File 'lib/foreman_maintain/utils/backup.rb', line 216

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

Returns:

  • (Boolean) 


210
211
212
213
214
 
# File 'lib/foreman_maintain/utils/backup.rb', line 210

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

#fpc_logical_backup? ⇒ Boolean

Returns:

  • (Boolean) 


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/foreman_maintain/utils/backup.rb', line 193

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

Returns:

  • (Boolean) 


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/foreman_maintain/utils/backup.rb', line 176

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

Returns:

  • (Boolean) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/foreman_maintain/utils/backup.rb', line 158

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

Returns:

  • (Boolean) 


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

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

#katello_logical_backup? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/foreman_maintain/utils/backup.rb', line 140

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

Returns:

  • (Boolean) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/foreman_maintain/utils/backup.rb', line 122

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

TODO: Need to check for pulpcore feature?

Returns:

  • (Boolean) 


108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/foreman_maintain/utils/backup.rb', line 108

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



51
52
53
54
55
56
57
58
 
# File 'lib/foreman_maintain/utils/backup.rb', line 51

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 



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

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

#online_backup? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#present_files ⇒ Object 



60
61
62
63
 
# File 'lib/foreman_maintain/utils/backup.rb', line 60

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) 


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

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

#sql_dump_files_exist? ⇒ Boolean

Returns:

  • (Boolean) 


262
263
264
265
266
 
# File 'lib/foreman_maintain/utils/backup.rb', line 262

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) 


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

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

#valid_backup? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#valid_foreman_backup? ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/foreman_maintain/utils/backup.rb', line 87

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

#valid_fpc_backup? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/foreman_maintain/utils/backup.rb', line 79

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

#valid_katello_backup? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/foreman_maintain/utils/backup.rb', line 83

def valid_katello_backup?
  katello_online_backup? || katello_standard_backup? || katello_logical_backup?
end

#validate_hostname? ⇒ Boolean

Returns:

  • (Boolean) 


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/foreman_maintain/utils/backup.rb', line 227

def validate_hostname?
  # make sure that the system hostname is the same as the backup
  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