1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
# frozen_string_literal: true
module Backup
class Manager
FILE_NAME_SUFFIX = '_gitlab_backup.tar'
MANIFEST_NAME = 'backup_information.yml'
attr_reader :progress, :remote_storage, :options
def initialize(progress, definitions: nil)
@progress = progress
@definitions = definitions
@options = Backup::Options.new
@metadata = Backup::Metadata.new(manifest_filepath)
@options.extract_from_env! # preserve existing behavior
@remote_storage = Backup::RemoteStorage.new(progress: progress, options: options)
end
def create
# Deprecation: Using backup_id (ENV['BACKUP']) to specify previous backup was deprecated in 15.0
previous_backup = options.previous_backup || options.backup_id
unpack(previous_backup) if options.incremental?
run_all_create_tasks
puts_time "Warning: Your gitlab.rb and gitlab-secrets.json files contain sensitive data \n" \
"and are not included in this backup. You will need these files to restore a backup.\n" \
"Please back them up manually.".color(:red)
puts_time "Backup #{backup_id} is done."
end
def run_create_task(task_name)
build_backup_information
definition = definitions[task_name]
destination_dir = File.join(Gitlab.config.backup.path, definition.destination_path)
unless definition.enabled?
puts_time "Dumping #{definition.human_name} ... ".color(:blue) + "[DISABLED]".color(:cyan)
return
end
if options.skip_task?(task_name)
puts_time "Dumping #{definition.human_name} ... ".color(:blue) + "[SKIPPED]".color(:cyan)
return
end
puts_time "Dumping #{definition.human_name} ... ".color(:blue)
definition.target.dump(destination_dir, backup_id)
puts_time "Dumping #{definition.human_name} ... ".color(:blue) + "done".color(:green)
rescue Backup::DatabaseBackupError, Backup::FileBackupError => e
puts_time "Dumping #{definition.human_name} failed: #{e.message}".color(:red)
end
def restore
unpack(options.backup_id)
run_all_restore_tasks
puts_time "Warning: Your gitlab.rb and gitlab-secrets.json files contain sensitive data \n" \
"and are not included in this backup. You will need to restore these files manually.".color(:red)
puts_time "Restore task is done."
end
def run_restore_task(task_name)
read_backup_information
definition = definitions[task_name]
unless definition.enabled?
puts_time "Restoring #{definition.human_name} ... ".color(:blue) + "[DISABLED]".color(:cyan)
return
end
puts_time "Restoring #{definition.human_name} ... ".color(:blue)
warning = definition.target.pre_restore_warning
if warning.present?
puts_time warning.color(:red)
Gitlab::TaskHelpers.ask_to_continue
end
definition.target.restore(File.join(Gitlab.config.backup.path, definition.destination_path), backup_id)
puts_time "Restoring #{definition.human_name} ... ".color(:blue) + "done".color(:green)
warning = definition.target.post_restore_warning
if warning.present?
puts_time warning.color(:red)
Gitlab::TaskHelpers.ask_to_continue
end
rescue Gitlab::TaskAbortedByUserError
puts_time "Quitting...".color(:red)
exit 1
end
private
def definitions
@definitions ||= {
Backup::Tasks::Database.id => Backup::Tasks::Database.new(progress: progress, options: options),
Backup::Tasks::Repositories.id => Backup::Tasks::Repositories.new(progress: progress, options: options,
server_side: backup_information[:repositories_server_side]),
Backup::Tasks::Uploads.id => Backup::Tasks::Uploads.new(progress: progress, options: options),
Backup::Tasks::Builds.id => Backup::Tasks::Builds.new(progress: progress, options: options),
Backup::Tasks::Artifacts.id => Backup::Tasks::Artifacts.new(progress: progress, options: options),
Backup::Tasks::Pages.id => Backup::Tasks::Pages.new(progress: progress, options: options),
Backup::Tasks::Lfs.id => Backup::Tasks::Lfs.new(progress: progress, options: options),
Backup::Tasks::TerraformState.id => Backup::Tasks::TerraformState.new(progress: progress, options: options),
Backup::Tasks::Registry.id => Backup::Tasks::Registry.new(progress: progress, options: options),
Backup::Tasks::Packages.id => Backup::Tasks::Packages.new(progress: progress, options: options),
Backup::Tasks::CiSecureFiles.id => Backup::Tasks::CiSecureFiles.new(progress: progress, options: options)
}.freeze
end
def run_all_create_tasks
if options.incremental?
read_backup_information
verify_backup_version
update_backup_information
end
build_backup_information
definitions.each_key do |task_name|
run_create_task(task_name)
end
write_backup_information
unless options.skippable_operations.archive
pack
upload
remove_old
end
ensure
cleanup unless options.skippable_operations.archive
remove_tmp
end
def run_all_restore_tasks
read_backup_information
verify_backup_version
definitions.each do |task_name, definition|
if !options.skip_task?(task_name) && definition.enabled?
run_restore_task(task_name)
end
end
Rake::Task['gitlab:shell:setup'].invoke
Rake::Task['cache:clear'].invoke
ensure
cleanup unless options.skippable_operations.archive
remove_tmp
end
def read_backup_information
@metadata.load!
options.update_from_backup_information!(backup_information)
end
def write_backup_information
@metadata.save!
end
def build_backup_information
return if @metadata.backup_information
backup_created_at = Time.current
backup_id = if options.backup_id.present?
File.basename(options.backup_id)
else
"#{backup_created_at.strftime('%s_%Y_%m_%d_')}#{Gitlab::VERSION}"
end
@metadata.update(
backup_id: backup_id,
db_version: ActiveRecord::Migrator.current_version.to_s,
backup_created_at: backup_created_at,
gitlab_version: Gitlab::VERSION,
tar_version: tar_version,
installation_type: Gitlab::INSTALLATION_TYPE,
skipped: options.serialize_skippables,
repositories_storages: options.repositories_storages.join(','),
repositories_paths: options.repositories_paths.join(','),
skip_repositories_paths: options.skip_repositories_paths.join(','),
repositories_server_side: options.repositories_server_side_backup
)
end
def update_backup_information
backup_created_at = Time.current
backup_id = if options.backup_id.present?
File.basename(options.backup_id)
else
"#{backup_created_at.strftime('%s_%Y_%m_%d_')}#{Gitlab::VERSION}"
end
@metadata.update(
backup_id: backup_id,
full_backup_id: full_backup_id,
db_version: ActiveRecord::Migrator.current_version.to_s,
backup_created_at: backup_created_at,
gitlab_version: Gitlab::VERSION,
tar_version: tar_version,
installation_type: Gitlab::INSTALLATION_TYPE,
skipped: options.serialize_skippables,
repositories_storages: options.repositories_storages.join(','),
repositories_paths: options.repositories_paths.join(','),
skip_repositories_paths: options.skip_repositories_paths.join(',')
)
end
def backup_information
raise Backup::Error, "#{MANIFEST_NAME} not yet loaded" unless @metadata.backup_information
@metadata.backup_information
end
def pack
Dir.chdir(backup_path) do
# create archive
puts_time "Creating backup archive: #{tar_file} ... ".color(:blue)
# Set file permissions on open to prevent chmod races.
tar_system_options = { out: [tar_file, 'w', Gitlab.config.backup.archive_permissions] }
if Kernel.system('tar', '-cf', '-', *backup_contents, tar_system_options)
puts_time "Creating backup archive: #{tar_file} ... ".color(:blue) + 'done'.color(:green)
else
puts_time "Creating archive #{tar_file} failed".color(:red)
raise Backup::Error, 'Backup failed'
end
end
end
def upload
remote_storage.upload(backup_information: backup_information)
end
def cleanup
puts_time "Deleting tar staging files ... ".color(:blue)
remove_backup_path(MANIFEST_NAME)
definitions.each do |_, definition|
remove_backup_path(definition.cleanup_path || definition.destination_path)
end
puts_time "Deleting tar staging files ... ".color(:blue) + 'done'.color(:green)
end
def remove_backup_path(path)
absolute_path = File.join(backup_path, path)
return unless File.exist?(absolute_path)
puts_time "Cleaning up #{absolute_path}"
FileUtils.rm_rf(absolute_path)
end
def remove_tmp
# delete tmp inside backups
puts_time "Deleting backups/tmp ... ".color(:blue)
FileUtils.rm_rf(File.join(backup_path, "tmp"))
puts_time "Deleting backups/tmp ... ".color(:blue) + "done".color(:green)
end
def remove_old
# delete backups
keep_time = Gitlab.config.backup.keep_time.to_i
if keep_time <= 0
puts_time "Deleting old backups ... ".color(:blue) + "[SKIPPED]".color(:cyan)
return
end
puts_time "Deleting old backups ... ".color(:blue)
removed = 0
Dir.chdir(backup_path) do
backup_file_list.each do |file|
# For backward compatibility, there are 3 names the backups can have:
# - 1495527122_gitlab_backup.tar
# - 1495527068_2017_05_23_gitlab_backup.tar
# - 1495527097_2017_05_23_9.3.0-pre_gitlab_backup.tar
matched = backup_file?(file)
next unless matched
timestamp = matched[1].to_i
next unless Time.zone.at(timestamp) < (Time.current - keep_time)
begin
FileUtils.rm(file)
removed += 1
rescue StandardError => e
puts_time "Deleting #{file} failed: #{e.message}".color(:red)
end
end
end
puts_time "Deleting old backups ... ".color(:blue) + "done. (#{removed} removed)".color(:green)
end
def verify_backup_version
Dir.chdir(backup_path) do
# restoring mismatching backups can lead to unexpected problems
if backup_information[:gitlab_version] != Gitlab::VERSION
progress.puts(<<~HEREDOC.color(:red))
GitLab version mismatch:
Your current GitLab version (#{Gitlab::VERSION}) differs from the GitLab version in the backup!
Please switch to the following version and try again:
version: #{backup_information[:gitlab_version]}
HEREDOC
progress.puts
progress.puts "Hint: git checkout v#{backup_information[:gitlab_version]}"
exit 1
end
end
end
def puts_available_timestamps
available_timestamps.each do |available_timestamp|
puts_time " " + available_timestamp
end
end
def unpack(source_backup_id)
if source_backup_id.blank? && non_tarred_backup?
puts_time "Non tarred backup found in #{backup_path}, using that"
return
end
Dir.chdir(backup_path) do
# check for existing backups in the backup dir
if backup_file_list.empty?
puts_time "No backups found in #{backup_path}"
puts_time "Please make sure that file name ends with #{FILE_NAME_SUFFIX}"
exit 1
elsif backup_file_list.many? && source_backup_id.nil?
puts_time 'Found more than one backup:'
# print list of available backups
puts_available_timestamps
if options.incremental?
puts_time 'Please specify which one you want to create an incremental backup for:'
puts_time 'rake gitlab:backup:create INCREMENTAL=true PREVIOUS_BACKUP=timestamp_of_backup'
else
puts_time 'Please specify which one you want to restore:'
puts_time 'rake gitlab:backup:restore BACKUP=timestamp_of_backup'
end
exit 1
end
tar_file = if source_backup_id.present?
File.basename(source_backup_id) + FILE_NAME_SUFFIX
else
backup_file_list.first
end
unless File.exist?(tar_file)
puts_time "The backup file #{tar_file} does not exist!"
exit 1
end
puts_time 'Unpacking backup ... '.color(:blue)
if Kernel.system(*%W[tar -xf #{tar_file}])
puts_time 'Unpacking backup ... '.color(:blue) + 'done'.color(:green)
else
puts_time 'Unpacking backup failed'.color(:red)
exit 1
end
end
end
def tar_version
tar_version, _ = Gitlab::Popen.popen(%w[tar --version])
tar_version.dup.force_encoding('locale').split("\n").first
end
def backup_file?(file)
file.match(/^(\d{10})(?:_\d{4}_\d{2}_\d{2}(_\d+\.\d+\.\d+((-|\.)(pre|rc\d))?(-ee)?)?)?_gitlab_backup\.tar$/)
end
def non_tarred_backup?
File.exist?(manifest_filepath)
end
def manifest_filepath
File.join(backup_path, MANIFEST_NAME)
end
def backup_path
Gitlab.config.backup.path
end
def backup_file_list
@backup_file_list ||= Dir.glob("*#{FILE_NAME_SUFFIX}")
end
def available_timestamps
@backup_file_list.map { |item| item.gsub("#{FILE_NAME_SUFFIX}", "") }
end
def backup_contents
[MANIFEST_NAME] + definitions.reject do |name, definition|
options.skip_task?(name) || !definition.enabled? ||
(definition.destination_optional && !File.exist?(File.join(backup_path, definition.destination_path)))
end.values.map(&:destination_path)
end
def tar_file
@tar_file ||= "#{backup_id}#{FILE_NAME_SUFFIX}"
end
def full_backup_id
full_backup_id = backup_information[:full_backup_id]
full_backup_id ||= File.basename(options.previous_backup) if options.previous_backup.present?
full_backup_id ||= backup_id
full_backup_id
end
def backup_id
# Eventually the backup ID should only be fetched from
# backup_information, but we must have a fallback so that older backups
# can still be used.
if backup_information[:backup_id].present?
backup_information[:backup_id]
elsif options.backup_id.present?
File.basename(options.backup_id)
else
"#{backup_information[:backup_created_at].strftime('%s_%Y_%m_%d_')}#{backup_information[:gitlab_version]}"
end
end
def puts_time(msg)
progress.puts "#{Time.current} -- #{msg}"
Gitlab::BackupLogger.info(message: "#{Rainbow.uncolor(msg)}")
end
end
end
Backup::Manager.prepend_mod
|