diff options
Diffstat (limited to 'doc/raketasks/backup_restore.md')
| -rw-r--r-- | doc/raketasks/backup_restore.md | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md index 30cd0f8f511..cef52cc61d7 100644 --- a/doc/raketasks/backup_restore.md +++ b/doc/raketasks/backup_restore.md @@ -434,7 +434,7 @@ gitlab_rails['backup_upload_storage_options'] = { ###### SSE-KMS To enable SSE-KMS, you'll need the [KMS key via its Amazon Resource Name (ARN) -in the `arn:aws:kms:region:acct-id:key/key-id` format](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html). Under the `backup_upload_storage_options` config setting, set: +in the `arn:aws:kms:region:acct-id:key/key-id` format](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html). Under the `backup_upload_storage_options` configuration setting, set: - `server_side_encryption` to `aws:kms`. - `server_side_encryption_kms_key_id` to the ARN of the key. @@ -1191,7 +1191,7 @@ has a longer discussion explaining the potential problems. To prevent writes to the Git repository data, there are two possible approaches: -- Use [maintenance mode](../administration/maintenance_mode/index.md) **(PREMIUM SELF)** to place GitLab in a read-only state. +- Use [maintenance mode](../administration/maintenance_mode/index.md) to place GitLab in a read-only state. - Create explicit downtime by stopping all Gitaly services before backing up the repositories: ```shell @@ -1354,15 +1354,13 @@ To prepare the new server: ```shell sudo rm -f /var/opt/gitlab/redis/dump.rdb - sudo chown <your-linux-username> /var/opt/gitlab/redis - sudo mkdir /var/opt/gitlab/backups - sudo chown <your-linux-username> /var/opt/gitlab/backups + sudo chown <your-linux-username> /var/opt/gitlab/redis /var/opt/gitlab/backups ``` ### Prepare and transfer content from the old server 1. Ensure you have an up-to-date system-level backup or snapshot of the old server. -1. Enable [maintenance mode](../administration/maintenance_mode/index.md) **(PREMIUM SELF)**, +1. Enable [maintenance mode](../administration/maintenance_mode/index.md), if supported by your GitLab edition. 1. Block new CI/CD jobs from starting: 1. Edit `/etc/gitlab/gitlab.rb`, and set the following: @@ -1461,11 +1459,11 @@ To prepare the new server: 1. On the top bar, select **Menu > Admin**. 1. On the left sidebar, select **Monitoring > Background Jobs**. 1. Under the Sidekiq dashboard, verify that the numbers - match with what was shown on the old server. + match with what was shown on the old server. 1. While still under the Sidekiq dashboard, select **Cron** and then **Enable All** to re-enable periodic background jobs. 1. Test that read-only operations on the GitLab instance work as expected. For example, browse through project repository files, merge requests, and issues. -1. Disable [Maintenance Mode](../administration/maintenance_mode/index.md) **(PREMIUM SELF)**, if previously enabled. +1. Disable [Maintenance Mode](../administration/maintenance_mode/index.md), if previously enabled. 1. Test that the GitLab instance is working as expected. 1. If applicable, re-enable [incoming email](../administration/incoming_email.md) and test it is working as expected. 1. Update your DNS or load balancer to point at the new server. @@ -1856,3 +1854,22 @@ To enable it: ```ruby Feature.enable(:gitaly_backup) ``` + +### Incremental repository backups + +> Introduced in GitLab 14.9 [with a flag](../administration/feature_flags.md) named `incremental_repository_backup`. Disabled by default. + +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `incremental_repository_backup`. +On GitLab.com, this feature is not available. +This feature is not ready for production use. + +Incremental backups can be faster than full backups because they only pack changes since the last backup into the backup +bundle for each repository. Because incremental backups require access to the previous backup, you can't use incremental +backups with tar files. + +To create an incremental backup, run: + +```shell +sudo gitlab-backup create SKIP=tar INCREMENTAL=yes +``` |