Skip to content

Add warning that one cannot skip tar creation if using object storage

Caleb Cooper requested to merge calebcooper-no-skip-tar-object-storage into master

What does this MR do and why?

The gitlab-backup create SKIP=tar function, which should skip the step of creating a tar file for backups, prevents a successful transfer of files to object storage as the object storage copy function only looks for the created tar file.

This merge request adds a warning to inform readers that if they use object storage, they will not be able to use the SKIP=tar feature of the backup tool.

Open issue for this: #222492.

Screenshots or screen recordings

Error when no tar file is found:

2022-06-01 13:44:23 -0400 -- Uploading backup archive to remote storage example-bucket-backups ... 
rake aborted!
Errno::ENOENT: No such file or directory @ rb_sysopen - /var/opt/gitlab/backups/1654105419_2022_06_01_15.0.0-ee_gitlab_backup.tar
/opt/gitlab/embedded/service/gitlab-rails/lib/backup/manager.rb:564:in `initialize'
/opt/gitlab/embedded/service/gitlab-rails/lib/backup/manager.rb:564:in `open'
/opt/gitlab/embedded/service/gitlab-rails/lib/backup/manager.rb:564:in `create_attributes'
/opt/gitlab/embedded/service/gitlab-rails/lib/backup/manager.rb:310:in `upload'
/opt/gitlab/embedded/service/gitlab-rails/lib/backup/manager.rb:60:in `create'
/opt/gitlab/embedded/service/gitlab-rails/lib/tasks/gitlab/backup.rake:12:in `block (3 levels) in <top (required)>'
/opt/gitlab/embedded/bin/bundle:23:in `load'
/opt/gitlab/embedded/bin/bundle:23:in `<main>'
Tasks: TOP => gitlab:backup:create
(See full trace by running task with --trace)

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Enable object storage for backups: https://docs.gitlab.com/ee/raketasks/backup_restore.html#uploading-backups-to-a-remote-cloud-storage
  2. Attempt to create backup without tarring: https://docs.gitlab.com/ee/raketasks/backup_restore.html#skipping-tar-creation

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Caleb Cooper

Merge request reports