Skip to content

G
gitlab-ce
Commit 542cf8f3 authored by Craig Norris's avatar Craig Norris Committed by Nick Gaskill
Browse files
Options

Docs: Remove notes and general cleanup

parent 05719e1e
Hide whitespace changes
Inline Side-by-side
Showing with 334 additions and 295 deletions
doc/raketasks/backup_restore.md
View file @ 542cf8f3
...@@ -10,48 +10,41 @@ of GitLab on which it was created. The best way to migrate your repositories ...@@ -10,48 +10,41 @@ of GitLab on which it was created. The best way to migrate your repositories
from one server to another is through backup restore. from one server to another is through backup restore.
CAUTION: **Warning:** CAUTION: **Warning:**
GitLab will not backup items that are not stored on the GitLab won't back up items that aren't stored in the filesystem. If you're
filesystem. If using [object storage](../administration/object_storage.md), using [object storage](../administration/object_storage.md), be sure to enable
remember to enable backups with your object storage provider if desired. backups with your object storage provider, if desired.
## Requirements ## Requirements
In order to be able to backup and restore, you need one essential tool To be able to backup and restore, ensure that Rsync is installed on your
installed on your system. system. If you installed GitLab:
- **Rsync**: If you installed GitLab: - _Using the Omnibus package_, you're all set.
- Using the Omnibus package, you're all set. - _From source_, you need to determine if `rsync` is installed. For example:
- From source, make sure `rsync` is installed. For example:
```shell ```shell
# Debian/Ubuntu # Debian/Ubuntu
sudo apt-get install rsync sudo apt-get install rsync
# RHEL/CentOS # RHEL/CentOS
sudo yum install rsync sudo yum install rsync
``` ```
## Backup timestamp ## Backup timestamp
NOTE: **Note:**
In GitLab 9.2 the timestamp format was changed from `EPOCH_YYYY_MM_DD` to
`EPOCH_YYYY_MM_DD_GitLab_version`, for example `1493107454_2018_04_25`
would become `1493107454_2018_04_25_10.6.4-ce`.
The backup archive will be saved in `backup_path`, which is specified in the The backup archive will be saved in `backup_path`, which is specified in the
`config/gitlab.yml` file. `config/gitlab.yml` file. The filename will be `[TIMESTAMP]_gitlab_backup.tar`,
The filename will be `[TIMESTAMP]_gitlab_backup.tar`, where `TIMESTAMP` where `TIMESTAMP` identifies the time at which each backup was created, plus
identifies the time at which each backup was created, plus the GitLab version. the GitLab version. The timestamp is needed if you need to restore GitLab and
The timestamp is needed if you need to restore GitLab and multiple backups are multiple backups are available.
available.
For example, if the backup name is `1493107454_2018_04_25_10.6.4-ce_gitlab_backup.tar`, For example, if the backup name is `1493107454_2018_04_25_10.6.4-ce_gitlab_backup.tar`,
then the timestamp is `1493107454_2018_04_25_10.6.4-ce`. the timestamp is `1493107454_2018_04_25_10.6.4-ce`.
## Back up GitLab ## Back up GitLab
GitLab provides a simple command line interface to back up your whole instance. GitLab provides a command line interface to back up your entire instance,
It backs up your: including:
- Database - Database
- Attachments - Attachments
...@@ -63,47 +56,59 @@ It backs up your: ...@@ -63,47 +56,59 @@ It backs up your:
- GitLab Pages content - GitLab Pages content
CAUTION: **Warning:** CAUTION: **Warning:**
GitLab does not back up any configuration files, SSL certificates, or system files. GitLab does not back up any configuration files, SSL certificates, or system
You are highly advised to [read about storing configuration files](#storing-configuration-files). files. You are highly advised to read about [storing configuration files](#storing-configuration-files).
Use this command if you've installed GitLab with the Omnibus package: Depending on your version of GitLab, use the following command if you installed
GitLab using the Omnibus package:
```shell - GitLab 12.2 or later:
sudo gitlab-backup create
``` ```shell
sudo gitlab-backup create
```
NOTE: **Note:** - GitLab 12.1 and earlier:
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
Use this if you've installed GitLab from source: ```shell
gitlab-rake gitlab:backup:create
```
If you installed GitLab from source, use the following command:
```shell ```shell
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
``` ```
If you are running GitLab within a Docker container, you can run the backup from the host: If you're running GitLab from within a Docker container, run the backup from
the host, based on your installed version of GitLab:
```shell - GitLab 12.2 or later:
docker exec -t <container name> gitlab-backup create
``` ```shell
docker exec -t <container name> gitlab-backup create
```
NOTE: **Note:** - GitLab 12.1 and earlier:
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
If you are using the [GitLab Helm chart](https://gitlab.com/gitlab-org/charts/gitlab) on a ```shell
Kubernetes cluster, you can run the backup task using `backup-utility` script on gitlab-rake gitlab:backup:create
the GitLab task runner pod via `kubectl`. Refer to [backing up a GitLab installation](https://gitlab.com/gitlab-org/charts/gitlab/blob/master/doc/backup-restore/backup.md#backing-up-a-gitlab-installation) for more details: ```
If you're using the [GitLab Helm chart](https://gitlab.com/gitlab-org/charts/gitlab)
on a Kubernetes cluster, you can run the backup task by using `kubectl` to run the `backup-utility`
script on the GitLab task runner pod. For more details, see
[backing up a GitLab installation](https://gitlab.com/gitlab-org/charts/gitlab/blob/master/doc/backup-restore/backup.md#backing-up-a-gitlab-installation).
```shell ```shell
kubectl exec -it <gitlab task-runner pod> backup-utility kubectl exec -it <gitlab task-runner pod> backup-utility
``` ```
Similarly to the Kubernetes case, if you have scaled out your GitLab Similar to the Kubernetes case, if you have scaled out your GitLab cluster to
cluster to use multiple application servers, you should pick a use multiple application servers, you should pick a designated node (that won't
designated node (that won't be auto-scaled away) for running the be auto-scaled away) for running the backup Rake task. Because the backup Rake
backup Rake task. Because the backup Rake task is tightly coupled to task is tightly coupled to the main Rails application, this is typically a node
the main Rails application, this is typically a node on which you're on which you're also running Unicorn/Puma or Sidekiq.
also running Unicorn/Puma and/or Sidekiq.
Example output: Example output:
...@@ -136,11 +141,11 @@ Deleting old backups... [SKIPPING] ...@@ -136,11 +141,11 @@ Deleting old backups... [SKIPPING]
### Storing configuration files ### Storing configuration files
The [backup Rake task](#back-up-gitlab) GitLab provides The [backup Rake task](#back-up-gitlab) GitLab provides does _not_ store your
does **not** store your configuration files. The primary reason for this is that your configuration files. The primary reason for this is that your database contains
database contains encrypted information for two-factor authentication, the CI/CD items including encrypted information for two-factor authentication and the
'secure variables', and so on. Storing encrypted information along with its key in the CI/CD _secure variables_. Storing encrypted information in the same location
same place defeats the purpose of using encryption in the first place. as its key defeats the purpose of using encryption in the first place.
CAUTION: **Warning:** CAUTION: **Warning:**
The secrets file is essential to preserve your database encryption key. The secrets file is essential to preserve your database encryption key.
...@@ -158,30 +163,31 @@ For installation from source: ...@@ -158,30 +163,31 @@ For installation from source:
- `/home/git/gitlab/config/gitlab.yml` - `/home/git/gitlab/config/gitlab.yml`
For [Docker installations](https://docs.gitlab.com/omnibus/docker/), you must For [Docker installations](https://docs.gitlab.com/omnibus/docker/), you must
back up the volume where the configuration files are stored. If you have created back up the volume where the configuration files are stored. If you created
the GitLab container according to the documentation, it should be under the GitLab container according to the documentation, it should be in the
`/srv/gitlab/config`. `/srv/gitlab/config` directory.
For [GitLab Helm chart Installations](https://gitlab.com/gitlab-org/charts/gitlab) on a For [GitLab Helm chart installations](https://gitlab.com/gitlab-org/charts/gitlab)
Kubernetes cluster, you must follow the [Backup the secrets](https://docs.gitlab.com/charts/backup-restore/backup.html#backup-the-secrets) instructions. on a Kubernetes cluster, you must follow the
[Backup the secrets](https://docs.gitlab.com/charts/backup-restore/backup.html#backup-the-secrets)
instructions.
You may also want to back up any TLS keys and certificates, and your You may also want to back up any TLS keys and certificates, and your
[SSH host keys](https://superuser.com/questions/532040/copy-ssh-keys-from-one-server-to-another-server/532079#532079). [SSH host keys](https://superuser.com/questions/532040/copy-ssh-keys-from-one-server-to-another-server/532079#532079).
If you use Omnibus GitLab, see some additional information If you use Omnibus GitLab, review additional information to
[to backup your configuration](https://docs.gitlab.com/omnibus/settings/backups.html). [backup your configuration](https://docs.gitlab.com/omnibus/settings/backups.html).
In the unlikely event that the secrets file is lost, see the In the unlikely event that the secrets file is lost, see the
[troubleshooting section](#when-the-secrets-file-is-lost). [troubleshooting section](#when-the-secrets-file-is-lost).
### Backup options ### Backup options
The command line tool GitLab provides to backup your instance can take more options. The command line tool GitLab provides to backup your instance can accept more
options.
#### Backup strategy option #### Backup strategy option
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8728) in GitLab 8.17.
The default backup strategy is to essentially stream data from the respective The default backup strategy is to essentially stream data from the respective
data locations to the backup using the Linux command `tar` and `gzip`. This works data locations to the backup using the Linux command `tar` and `gzip`. This works
fine in most cases, but can cause problems when data is rapidly changing. fine in most cases, but can cause problems when data is rapidly changing.
...@@ -203,8 +209,7 @@ To use the `copy` strategy instead of the default streaming strategy, specify ...@@ -203,8 +209,7 @@ To use the `copy` strategy instead of the default streaming strategy, specify
sudo gitlab-backup create STRATEGY=copy sudo gitlab-backup create STRATEGY=copy
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
#### Backup filename #### Backup filename
...@@ -212,34 +217,41 @@ CAUTION: **Warning:** ...@@ -212,34 +217,41 @@ CAUTION: **Warning:**
If you use a custom backup filename, you will not be able to If you use a custom backup filename, you will not be able to
[limit the lifetime of the backups](#limit-backup-lifetime-for-local-files-prune-old-backups). [limit the lifetime of the backups](#limit-backup-lifetime-for-local-files-prune-old-backups).
By default a backup file is created according to the specification in [the Backup timestamp](#backup-timestamp) section above. You can however override the `[TIMESTAMP]` part of the filename by setting the `BACKUP` environment variable. For example: By default, a backup file is created according to the specification in the
previous [Backup timestamp](#backup-timestamp) section. You can, however,
override the `[TIMESTAMP]` portion of the filename by setting the `BACKUP`
environment variable. For example:
```shell ```shell
sudo gitlab-backup create BACKUP=dump sudo gitlab-backup create BACKUP=dump
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
The resulting file will then be `dump_gitlab_backup.tar`. This is useful for systems that make use of rsync and incremental backups, and will result in considerably faster transfer speeds. The resulting file will then be `dump_gitlab_backup.tar`. This is useful for
systems that make use of rsync and incremental backups, and will result in
considerably faster transfer speeds.
#### Rsyncable #### Rsyncable
To make sure the generated archive is intelligently transferable by rsync, the `GZIP_RSYNCABLE=yes` option can be set. This will set the `--rsyncable` option to `gzip`. This is only useful in combination with setting [the Backup filename option](#backup-filename). To ensure the generated archive is transferable by rsync, you can set the `GZIP_RSYNCABLE=yes`
option. This sets the `--rsyncable` option to `gzip`, which is useful only in
combination with setting [the Backup filename option](#backup-filename).
Note that the `--rsyncable` option in `gzip` is not guaranteed to be available on all distributions. To verify that it is available in your distribution you can run `gzip --help` or consult the man pages. Note that the `--rsyncable` option in `gzip` isn't guaranteed to be available
on all distributions. To verify that it's available in your distribution, run
`gzip --help` or consult the man pages.
```shell ```shell
sudo gitlab-backup create BACKUP=dump GZIP_RSYNCABLE=yes sudo gitlab-backup create BACKUP=dump GZIP_RSYNCABLE=yes
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
#### Excluding specific directories from the backup #### Excluding specific directories from the backup
You can choose what should be exempt from the backup up by adding the environment variable `SKIP`. You can choose what should be exempt from the backup by adding the environment
The available options are: variable `SKIP`. The available options are:
- `db` (database) - `db` (database)
- `uploads` (attachments) - `uploads` (attachments)
...@@ -252,8 +264,8 @@ The available options are: ...@@ -252,8 +264,8 @@ The available options are:
Use a comma to specify several options at the same time: Use a comma to specify several options at the same time:
All wikis will be backed up as part of the `repositories` group. Non-existent wikis All wikis will be backed up as part of the `repositories` group. Non-existent
will be skipped during a backup. wikis will be skipped during a backup.
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -261,8 +273,7 @@ For Omnibus GitLab packages: ...@@ -261,8 +273,7 @@ For Omnibus GitLab packages:
sudo gitlab-backup create SKIP=db,uploads sudo gitlab-backup create SKIP=db,uploads
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
For installations from source: For installations from source:
...@@ -317,13 +328,15 @@ sudo -u git -H GITLAB_ASSUME_YES=1 bundle exec rake gitlab:backup:restore RAILS_ ...@@ -317,13 +328,15 @@ sudo -u git -H GITLAB_ASSUME_YES=1 bundle exec rake gitlab:backup:restore RAILS_
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37158) in GitLab 13.3. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37158) in GitLab 13.3.
Repositories can be backed up concurrently to help fully utilise CPU time. The following variables Repositories can be backed up concurrently to help fully utilize CPU time. The
are available to modify the default behavior of the Rake task: following variables are available to modify the default behavior of the Rake
task:
- `GITLAB_BACKUP_MAX_CONCURRENCY` sets the maximum number of projects to backup at the same time. - `GITLAB_BACKUP_MAX_CONCURRENCY`: The maximum number of projects to back up at
Defaults to 1. the same time. Defaults to `1`.
- `GITLAB_BACKUP_MAX_STORAGE_CONCURRENCY` sets the maximum number of projects to backup at the same time on each storage. This allows the repository backups to be spread across storages. - `GITLAB_BACKUP_MAX_STORAGE_CONCURRENCY`: The maximum number of projects to
Defaults to 1. back up at the same time on each storage. This allows the repository backups
to be spread across storages. Defaults to `1`.
For example, for Omnibus GitLab installations: For example, for Omnibus GitLab installations:
...@@ -339,12 +352,11 @@ sudo -u git -H bundle exec rake gitlab:backup:create GITLAB_BACKUP_MAX_CONCURREN ...@@ -339,12 +352,11 @@ sudo -u git -H bundle exec rake gitlab:backup:create GITLAB_BACKUP_MAX_CONCURREN
#### Uploading backups to a remote (cloud) storage #### Uploading backups to a remote (cloud) storage
Starting with GitLab 7.4 you can let the backup script upload the `.tar` file it creates. You can let the backup script upload (using the [Fog library](http://fog.io/))
It uses the [Fog library](http://fog.io/) to perform the upload. the `.tar` file it creates. In the following example, we use Amazon S3 for
In the example below we use Amazon S3 for storage, but Fog also lets you use storage, but Fog also lets you use [other storage providers](http://fog.io/storage/).
[other storage providers](http://fog.io/storage/). GitLab GitLab also [imports cloud drivers](https://gitlab.com/gitlab-org/gitlab/blob/30f5b9a5b711b46f1065baf755e413ceced5646b/Gemfile#L88)
[imports cloud drivers](https://gitlab.com/gitlab-org/gitlab/blob/30f5b9a5b711b46f1065baf755e413ceced5646b/Gemfile#L88) for AWS, Google, OpenStack Swift, Rackspace, and Aliyun. A local driver is
for AWS, Google, OpenStack Swift, Rackspace, and Aliyun as well. A local driver is
[also available](#uploading-to-locally-mounted-shares). [also available](#uploading-to-locally-mounted-shares).
[Read more about using object storage with GitLab](../administration/object_storage.md). [Read more about using object storage with GitLab](../administration/object_storage.md).
...@@ -367,11 +379,12 @@ For Omnibus GitLab packages: ...@@ -367,11 +379,12 @@ For Omnibus GitLab packages:
gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket' gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect
##### Digital Ocean Spaces ##### Digital Ocean Spaces
This example can be used for a bucket in Amsterdam (AMS3). This example can be used for a bucket in Amsterdam (AMS3):
1. Add the following to `/etc/gitlab/gitlab.rb`: 1. Add the following to `/etc/gitlab/gitlab.rb`:
...@@ -386,20 +399,20 @@ This example can be used for a bucket in Amsterdam (AMS3). ...@@ -386,20 +399,20 @@ This example can be used for a bucket in Amsterdam (AMS3).
gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket' gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect
NOTE: **Note:** If you see a `400 Bad Request` error message when using Digital Ocean Spaces,
If you see `400 Bad Request` by using Digital Ocean Spaces, the cause may be the the cause may be the use of backup encryption. Because Digital Ocean Spaces
usage of backup encryption. Remove or comment the line that doesn't support encryption, remove or comment the line that contains
contains `gitlab_rails['backup_encryption']` since Digital Ocean Spaces `gitlab_rails['backup_encryption']`.
doesn't support encryption.
##### Other S3 Providers ##### Other S3 Providers
Not all S3 providers are fully-compatible with the Fog library. For example, Not all S3 providers are fully compatible with the Fog library. For example,
if you see `411 Length Required` errors after attempting to upload, you may if you see a `411 Length Required` error message after attempting to upload,
need to downgrade the `aws_signature_version` value from the default value to you may need to downgrade the `aws_signature_version` value from the default
2 [due to this issue](https://github.com/fog/fog-aws/issues/428). value to `2`, [due to this issue](https://github.com/fog/fog-aws/issues/428).
For installations from source: For installations from source:
...@@ -431,9 +444,10 @@ For installations from source: ...@@ -431,9 +444,10 @@ For installations from source:
# storage_class: 'STANDARD' # storage_class: 'STANDARD'
``` ```
1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect 1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source)
for the changes to take effect
If you are uploading your backups to S3 you will probably want to create a new If you're uploading your backups to S3, you'll probably want to create a new
IAM user with restricted access rights. To give the upload user access only for IAM user with restricted access rights. To give the upload user access only for
uploading backups create the following IAM profile, replacing `my.s3.bucket` uploading backups create the following IAM profile, replacing `my.s3.bucket`
with the name of your bucket: with the name of your bucket:
...@@ -486,16 +500,16 @@ with the name of your bucket: ...@@ -486,16 +500,16 @@ with the name of your bucket:
##### Using Google Cloud Storage ##### Using Google Cloud Storage
If you want to use Google Cloud Storage to save backups, you'll have to create To use Google Cloud Storage to save backups, you must first create an
an access key from the Google console first: access key from the Google console:
1. Go to the storage settings page <https://console.cloud.google.com/storage/settings> 1. Go to the [Google storage settings page](https://console.cloud.google.com/storage/settings).
1. Select "Interoperability" and create an access key 1. Select **Interoperability**, and then create an access key.
1. Make note of the "Access Key" and "Secret" and replace them in the 1. Make note of the **Access Key** and **Secret** and replace them in the
configurations below following configurations.
1. In the buckets advanced settings ensure the Access Control option "Set object-level 1. In the buckets advanced settings ensure the Access Control option
and bucket-level permissions" is selected **Set object-level and bucket-level permissions** is selected.
1. Make sure you already have a bucket created 1. Ensure you have already created a bucket.
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -516,7 +530,8 @@ For Omnibus GitLab packages: ...@@ -516,7 +530,8 @@ For Omnibus GitLab packages:
gitlab_rails['backup_upload_remote_directory'] = 'my.google.bucket' gitlab_rails['backup_upload_remote_directory'] = 'my.google.bucket'
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect
For installations from source: For installations from source:
...@@ -532,7 +547,8 @@ For installations from source: ...@@ -532,7 +547,8 @@ For installations from source:
remote_directory: 'my.google.bucket' remote_directory: 'my.google.bucket'
``` ```
1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect 1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source)
for the changes to take effect
##### Using Azure Blob storage ##### Using Azure Blob storage
...@@ -552,7 +568,8 @@ For Omnibus GitLab packages: ...@@ -552,7 +568,8 @@ For Omnibus GitLab packages:
gitlab_rails['backup_upload_remote_directory'] = '<AZURE BLOB CONTAINER>' gitlab_rails['backup_upload_remote_directory'] = '<AZURE BLOB CONTAINER>'
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect
For installations from source: For installations from source:
...@@ -568,13 +585,14 @@ For installations from source: ...@@ -568,13 +585,14 @@ For installations from source:
remote_directory: '<AZURE BLOB CONTAINER>' remote_directory: '<AZURE BLOB CONTAINER>'
``` ```
1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect 1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source)
for the changes to take effect
See [the table of Azure parameters](../administration/object_storage.md#azure-blob-storage) for more details. For more details, see the [table of Azure parameters](../administration/object_storage.md#azure-blob-storage).
##### Specifying a custom directory for backups ##### Specifying a custom directory for backups
Note: This option only works for remote storage. If you want to group your backups This option works only for remote storage. If you want to group your backups,
you can pass a `DIRECTORY` environment variable: you can pass a `DIRECTORY` environment variable:
```shell ```shell
...@@ -582,26 +600,25 @@ sudo gitlab-backup create DIRECTORY=daily ...@@ -582,26 +600,25 @@ sudo gitlab-backup create DIRECTORY=daily
sudo gitlab-backup create DIRECTORY=weekly sudo gitlab-backup create DIRECTORY=weekly
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
#### Uploading to locally mounted shares #### Uploading to locally mounted shares
You may also send backups to a mounted share (for example, `NFS`,`CIFS`, or `SMB`) by You may also send backups to a mounted share (for example, `NFS`,`CIFS`, or
using the Fog [`Local`](https://github.com/fog/fog-local#usage) storage provider. `SMB`) by using the Fog [`Local`](https://github.com/fog/fog-local#usage)
The directory pointed to by the `local_root` key **must** be owned by the `git` storage provider. The directory pointed to by the `local_root` key _must_ be
user **when mounted** (mounting with the `uid=` of the `git` user for `CIFS` and owned by the `git` user _when mounted_ (mounting with the `uid=` of the `git`
`SMB`) or the user that you are executing the backup tasks under (for Omnibus user for `CIFS` and `SMB`) or the user that you are executing the backup tasks
packages, this is the `git` user). as (for Omnibus packages, this is the `git` user).
The `backup_upload_remote_directory` **must** be set in addition to the The `backup_upload_remote_directory` _must_ be set in addition to the
`local_root` key. This is the sub directory inside the mounted directory that `local_root` key. This is the sub directory inside the mounted directory that
backups will be copied to, and will be created if it does not exist. If the backups will be copied to, and will be created if it does not exist. If the
directory that you want to copy the tarballs to is the root of your mounted directory that you want to copy the tarballs to is the root of your mounted
directory, just use `.` instead. directory, use `.` instead.
NOTE: **Note:** Because file system performance may affect GitLab's overall performance,
Since file system performance may affect GitLab's overall performance, we do not recommend using EFS for storage. See the [relevant documentation](../administration/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details. [GitLab doesn't recommend using EFS for storage](../administration/nfs.md#avoid-using-awss-elastic-file-system-efs).
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -618,7 +635,8 @@ For Omnibus GitLab packages: ...@@ -618,7 +635,8 @@ For Omnibus GitLab packages:
gitlab_rails['backup_upload_remote_directory'] = 'gitlab_backups' gitlab_rails['backup_upload_remote_directory'] = 'gitlab_backups'
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect.
For installations from source: For installations from source:
...@@ -636,14 +654,16 @@ For installations from source: ...@@ -636,14 +654,16 @@ For installations from source:
remote_directory: 'gitlab_backups' remote_directory: 'gitlab_backups'
``` ```
1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect. 1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source)
for the changes to take effect.
#### Backup archive permissions #### Backup archive permissions
The backup archives created by GitLab (`1393513186_2014_02_27_gitlab_backup.tar`) The backup archives created by GitLab (`1393513186_2014_02_27_gitlab_backup.tar`)
will have owner/group `git`/`git` and 0600 permissions by default. will have owner/group `git`/`git` and 0600 permissions by default. This is
This is meant to avoid other system users reading GitLab's data. meant to avoid other system users reading GitLab's data. If you need the backup
If you need the backup archives to have different permissions you can use the 'archive_permissions' setting. archives to have different permissions, you can use the `archive_permissions`
setting.
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -653,7 +673,8 @@ For Omnibus GitLab packages: ...@@ -653,7 +673,8 @@ For Omnibus GitLab packages:
gitlab_rails['backup_archive_permissions'] = 0644 # Makes the backup archives world-readable gitlab_rails['backup_archive_permissions'] = 0644 # Makes the backup archives world-readable
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect.
For installations from source: For installations from source:
...@@ -664,7 +685,8 @@ For installations from source: ...@@ -664,7 +685,8 @@ For installations from source:
archive_permissions: 0644 # Makes the backup archives world-readable archive_permissions: 0644 # Makes the backup archives world-readable
``` ```
1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect. 1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source)
for the changes to take effect.
#### Configuring cron to make daily backups #### Configuring cron to make daily backups
...@@ -689,8 +711,7 @@ For Omnibus GitLab packages: ...@@ -689,8 +711,7 @@ For Omnibus GitLab packages:
0 2 * * * /opt/gitlab/bin/gitlab-backup create CRON=1 0 2 * * * /opt/gitlab/bin/gitlab-backup create CRON=1
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
For installations from source: For installations from source:
...@@ -707,26 +728,25 @@ For installations from source: ...@@ -707,26 +728,25 @@ For installations from source:
0 2 * * * cd /home/git/gitlab && PATH=/usr/local/bin:/usr/bin:/bin bundle exec rake gitlab:backup:create RAILS_ENV=production CRON=1 0 2 * * * cd /home/git/gitlab && PATH=/usr/local/bin:/usr/bin:/bin bundle exec rake gitlab:backup:create RAILS_ENV=production CRON=1
``` ```
NOTE: **Note:** The `CRON=1` environment setting directs the backup script to hide all progress
The `CRON=1` environment setting tells the backup script to suppress all progress output if there are no errors. output if there aren't any errors. This is recommended to reduce cron spam.
This is recommended to reduce cron spam.
### Limit backup lifetime for local files (prune old backups) ### Limit backup lifetime for local files (prune old backups)
CAUTION: **Warning:** CAUTION: **Warning:**
This will not work if you have used a [custom filename](#backup-filename) The process described in this section will not work if you used a [custom filename](#backup-filename)
for your backups. for your backups.
NOTE: **Note:** To prevent regular backups from using all your disk space, you may want to set a limited lifetime
This configuration option only manages local files. GitLab does not automatically for backups. The next time the backup task runs, backups older than the `backup_keep_time` are
prune old files stored in a third-party [object storage](#uploading-backups-to-a-remote-cloud-storage) pruned.
because the user may not have permission to list and delete files. It is
This configuration option manages only local files. GitLab doesn't prune old
files stored in a third-party [object storage](#uploading-backups-to-a-remote-cloud-storage)
because the user may not have permission to list and delete files. It's
recommended that you configure the appropriate retention policy for your object recommended that you configure the appropriate retention policy for your object
storage (for example, [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html)). storage (for example, [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html)).
You may want to set a limited lifetime for backups to prevent regular
backups using all your disk space. The next time the backup task is run, backups older than the `backup_keep_time` will be pruned.
For Omnibus GitLab packages: For Omnibus GitLab packages:
1. Edit `/etc/gitlab/gitlab.rb`: 1. Edit `/etc/gitlab/gitlab.rb`:
...@@ -736,7 +756,8 @@ For Omnibus GitLab packages: ...@@ -736,7 +756,8 @@ For Omnibus GitLab packages:
gitlab_rails['backup_keep_time'] = 604800 gitlab_rails['backup_keep_time'] = 604800
``` ```
1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect.
For installations from source: For installations from source:
...@@ -748,61 +769,64 @@ For installations from source: ...@@ -748,61 +769,64 @@ For installations from source:
keep_time: 604800 keep_time: 604800
``` ```
1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect. 1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source)
for the changes to take effect.
## Restore GitLab ## Restore GitLab
GitLab provides a simple command line interface to restore your whole installation, GitLab provides a command line interface to restore your entire installation,
and is flexible enough to fit your needs. and is flexible enough to fit your needs.
The [restore prerequisites section](#restore-prerequisites) includes crucial The [restore prerequisites section](#restore-prerequisites) includes crucial
information. Make sure to read and test the whole restore process at least once information. Be sure to read and test the complete restore process at least
before attempting to perform it in a production environment. once before attempting to perform it in a production environment.
You can only restore a backup to **exactly the same version and type (CE/EE)** of You can restore a backup only to _the exact same version and type (CE/EE)_ of
GitLab that you created it on, for example CE 9.1.0. GitLab that you created it on (for example CE 9.1.0).
If your backup is a different version than the current installation, you will If your backup is a different version than the current installation, you'll
need to [downgrade your GitLab installation](https://docs.gitlab.com/omnibus/update/README.html#downgrade) need to [downgrade your GitLab installation](https://docs.gitlab.com/omnibus/update/README.html#downgrade)
before restoring the backup. before restoring the backup.
### Restore prerequisites ### Restore prerequisites
You need to have a working GitLab installation before you can perform You need to have a working GitLab installation before you can perform a
a restore. This is mainly because the system user performing the restore. This is because the system user performing the restore actions (`git`)
restore actions (`git`) is usually not allowed to create or delete is usually not allowed to create or delete the SQL database needed to import
the SQL database it needs to import data into (`gitlabhq_production`). data into (`gitlabhq_production`). All existing data will be either erased
All existing data will be either erased (SQL) or moved to a separate (SQL) or moved to a separate directory (such as repositories and uploads).
directory (repositories, uploads).
To restore a backup, you will also need to restore `/etc/gitlab/gitlab-secrets.json` To restore a backup, you'll also need to restore `/etc/gitlab/gitlab-secrets.json`
(for Omnibus packages) or `/home/git/gitlab/.secret` (for installations (for Omnibus packages) or `/home/git/gitlab/.secret` (for installations from
from source). This file contains the database encryption key, source). This file contains the database encryption key,
[CI/CD variables](../ci/variables/README.md#gitlab-cicd-environment-variables), and [CI/CD variables](../ci/variables/README.md#gitlab-cicd-environment-variables), and
variables used for [two-factor authentication](../user/profile/account/two_factor_authentication.md). variables used for [two-factor authentication](../user/profile/account/two_factor_authentication.md).
If you fail to restore this encryption key file along with the application data If you fail to restore this encryption key file along with the application data
backup, users with two-factor authentication enabled and GitLab Runner will backup, users with two-factor authentication enabled and GitLab Runner will
lose access to your GitLab server. lose access to your GitLab server.
You may also want to restore any TLS keys, certificates, or [SSH host keys](https://superuser.com/questions/532040/copy-ssh-keys-from-one-server-to-another-server/532079#532079). You may also want to restore any TLS keys, certificates, or
[SSH host keys](https://superuser.com/questions/532040/copy-ssh-keys-from-one-server-to-another-server/532079#532079).
Starting with GitLab 12.9 if an untarred backup (like the ones made with Starting with GitLab 12.9, if an untarred backup (like the ones made with
`SKIP=tar`) is found, and no backup is chosen with `BACKUP=<timestamp>`, the `SKIP=tar`) is found, and no backup is chosen with `BACKUP=<timestamp>`, the
untarred backup is used. untarred backup is used.
Depending on your case, you might want to run the restore command with one or Depending on your case, you might want to run the restore command with one or
more of the following options: more of the following options:
- `BACKUP=timestamp_of_backup` - Required if more than one backup exists. - `BACKUP=timestamp_of_backup`: Required if more than one backup exists.
Read what the [backup timestamp is about](#backup-timestamp). Read what the [backup timestamp is about](#backup-timestamp).
- `force=yes` - Does not ask if the authorized_keys file should get regenerated and assumes 'yes' for warning that database tables will be removed, enabling the "Write to authorized_keys file" setting, and updating LDAP providers. - `force=yes`: Doesn't ask if the authorized_keys file should get regenerated,
and assumes 'yes' for warning that database tables will be removed,
enabling the "Write to authorized_keys file" setting, and updating LDAP
providers.
If you are restoring into directories that are mount points, you will need to make If you're restoring into directories that are mount points, you must ensure these directories are
sure these directories are empty before attempting a restore. Otherwise GitLab empty before attempting a restore. Otherwise, GitLab attempts to move these directories before
will attempt to move these directories before restoring the new data and this restoring the new data, which causes an error.
would cause an error.
Read more on [configuring NFS mounts](../administration/nfs.md) Read more about [configuring NFS mounts](../administration/nfs.md)
### Restore for installation from source ### Restore for installation from source
...@@ -845,7 +869,7 @@ Restoring repositories: ...@@ -845,7 +869,7 @@ Restoring repositories:
Deleting tmp directories...[DONE] Deleting tmp directories...[DONE]
``` ```
Next, restore `/home/git/gitlab/.secret` if necessary as mentioned above. Next, restore `/home/git/gitlab/.secret` if necessary, as previously mentioned.
Restart GitLab: Restart GitLab:
...@@ -862,7 +886,7 @@ This procedure assumes that: ...@@ -862,7 +886,7 @@ This procedure assumes that:
- You have run `sudo gitlab-ctl reconfigure` at least once. - You have run `sudo gitlab-ctl reconfigure` at least once.
- GitLab is running. If not, start it using `sudo gitlab-ctl start`. - GitLab is running. If not, start it using `sudo gitlab-ctl start`.
First make sure your backup tar file is in the backup directory described in the First ensure your backup tar file is in the backup directory described in the
`gitlab.rb` configuration `gitlab_rails['backup_path']`. The default is `gitlab.rb` configuration `gitlab_rails['backup_path']`. The default is
`/var/opt/gitlab/backups`. It needs to be owned by the `git` user. `/var/opt/gitlab/backups`. It needs to be owned by the `git` user.
...@@ -890,15 +914,16 @@ restore: ...@@ -890,15 +914,16 @@ restore:
sudo gitlab-backup restore BACKUP=11493107454_2018_04_25_10.6.4-ce sudo gitlab-backup restore BACKUP=11493107454_2018_04_25_10.6.4-ce
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:restore`.
CAUTION: **Warning:** CAUTION: **Warning:**
`gitlab-rake gitlab:backup:restore` does not set the right file system permissions on your Registry directory. `gitlab-rake gitlab:backup:restore` doesn't set the correct file system
This is a [known issue](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62759). On GitLab 12.2 or newer, you can permissions on your Registry directory. This is a [known issue](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62759).
use `gitlab-backup restore` to avoid this issue. On GitLab 12.2 or later, you can use `gitlab-backup restore` to avoid this
issue.
Next, restore `/etc/gitlab/gitlab-secrets.json` if necessary as mentioned above. Next, restore `/etc/gitlab/gitlab-secrets.json` if necessary, as previously
mentioned.
Reconfigure, restart and check GitLab: Reconfigure, restart and check GitLab:
...@@ -908,29 +933,31 @@ sudo gitlab-ctl restart ...@@ -908,29 +933,31 @@ sudo gitlab-ctl restart
sudo gitlab-rake gitlab:check SANITIZE=true sudo gitlab-rake gitlab:check SANITIZE=true
``` ```
If there is a GitLab version mismatch between your backup tar file and the installed If there's a GitLab version mismatch between your backup tar file and the
version of GitLab, the restore command will abort with an error. Install the installed version of GitLab, the restore command aborts with an error
[correct GitLab version](https://packages.gitlab.com/gitlab/) and try again. message. Install the [correct GitLab version](https://packages.gitlab.com/gitlab/),
and then try again.
NOTE: **Note:** There is a [known issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3470)
There is currently a [known issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3470) for restore not working for restore not working with `pgbouncer`. To work around the issue, the Rails
with `pgbouncer`. In order to workaround the issue, the Rails node will need to bypass `pgbouncer` and connect node must bypass `pgbouncer` and connect directly to the primary
directly to the primary database node. This can be done by setting `gitlab_rails['db_host']` and `gitlab_rails['port']` database node. You can do this by setting `gitlab_rails['db_host']` and
to connect to the primary database node and [reconfiguring GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). `gitlab_rails['port']` to connect to the primary database node and
[reconfiguring GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure).
### Restore for Docker image and GitLab Helm chart installations ### Restore for Docker image and GitLab Helm chart installations
For GitLab installations using the Docker image or the GitLab Helm chart on For GitLab installations using the Docker image or the GitLab Helm chart on a
a Kubernetes cluster, the restore task expects the restore directories to be empty. Kubernetes cluster, the restore task expects the restore directories to be
However, with Docker and Kubernetes volume mounts, some system level directories empty. However, with Docker and Kubernetes volume mounts, some system level
may be created at the volume roots, like `lost+found` directory found in Linux directories may be created at the volume roots, such as the `lost+found`
operating systems. These directories are usually owned by `root`, which can directory found in Linux operating systems. These directories are usually owned
cause access permission errors since the restore Rake task runs as `git` user. by `root`, which can cause access permission errors since the restore Rake task
So, to restore a GitLab installation, users have to confirm the restore target runs as the `git` user. To restore a GitLab installation, users have to confirm
directories are empty. the restore target directories are empty.
For both these installation types, the backup tarball has to be available in the For both these installation types, the backup tarball has to be available in
backup location (default location is `/var/opt/gitlab/backups`). the backup location (default location is `/var/opt/gitlab/backups`).
For Docker installations, the restore task can be run from host: For Docker installations, the restore task can be run from host:
...@@ -953,43 +980,43 @@ docker restart <name of container> ...@@ -953,43 +980,43 @@ docker restart <name of container>
docker exec -it <name of container> gitlab-rake gitlab:check SANITIZE=true docker exec -it <name of container> gitlab-rake gitlab:check SANITIZE=true
``` ```
NOTE: **Note:** Users of GitLab 12.1 and earlier should use the command `gitlab-rake gitlab:backup:create` instead.
For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:restore`.
CAUTION: **Warning:** CAUTION: **Warning:**
`gitlab-rake gitlab:backup:restore` does not set the right file system permissions on your Registry directory. `gitlab-rake gitlab:backup:restore` doesn't set the correct file system
This is a [known issue](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62759). On GitLab 12.2 or newer, you can permissions on your Registry directory. This is a [known issue](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62759).
use `gitlab-backup restore` to avoid this issue. On GitLab 12.2 or later, you can use `gitlab-backup restore` to avoid this
issue.
The GitLab Helm chart uses a different process, documented in The GitLab Helm chart uses a different process, documented in
[restoring a GitLab Helm chart installation](https://gitlab.com/gitlab-org/charts/gitlab/blob/master/doc/backup-restore/restore.md). [restoring a GitLab Helm chart installation](https://gitlab.com/gitlab-org/charts/gitlab/blob/master/doc/backup-restore/restore.md).
### Restoring only one or a few project(s) or group(s) from a backup ### Restoring only one or a few project(s) or group(s) from a backup
While the Rake task used to restore a GitLab instance doesn't support Although the Rake task used to restore a GitLab instance doesn't support
restoring a single project or group, you can use a workaround by restoring a single project or group, you can use a workaround by restoring
restoring your backup to a separate, temporary GitLab instance, and your backup to a separate, temporary GitLab instance, and then export your
export your project or group from there: project or group from there:
1. [Install a new GitLab](../install/README.md) instance at the same version as 1. [Install a new GitLab](../install/README.md) instance at the same version as
the backed-up instance from which you want to restore. the backed-up instance from which you want to restore.
1. [Restore the backup](#restore-gitlab) into this new instance and 1. [Restore the backup](#restore-gitlab) into this new instance, then
export your [project](../user/project/settings/import_export.md) export your [project](../user/project/settings/import_export.md)
or [group](../user/group/settings/import_export.md). Make sure to or [group](../user/group/settings/import_export.md). Be sure to read the
read the **Important Notes** on either export feature's documentation **Important Notes** on either export feature's documentation to understand
to understand what will be exported and what not. what is and isn't exported.
1. Once the export is complete, go to the old instance and import it. 1. After the export is complete, go to the old instance and then import it.
1. After importing only the project(s) or group(s) that you wanted is complete, 1. After importing the projects or groups that you wanted is complete, you may
you may delete the new, temporary GitLab instance. delete the new, temporary GitLab instance.
NOTE: **Note:**
A feature request to provide direct restore of individual projects or groups A feature request to provide direct restore of individual projects or groups
is being discussed in [issue #17517](https://gitlab.com/gitlab-org/gitlab/-/issues/17517). is being discussed in [issue #17517](https://gitlab.com/gitlab-org/gitlab/-/issues/17517).
## Alternative backup strategies ## Alternative backup strategies
If your GitLab server contains a lot of Git repository data you may find the GitLab backup script to be too slow. If your GitLab server contains a lot of Git repository data, you may find the
In this case you can consider using filesystem snapshots as part of your backup strategy. GitLab backup script to be too slow. In this case you can consider using
filesystem snapshots as part of your backup strategy.
Example: Amazon EBS Example: Amazon EBS
...@@ -1006,29 +1033,33 @@ Example: LVM snapshots + rsync ...@@ -1006,29 +1033,33 @@ Example: LVM snapshots + rsync
> Now we can have a longer running rsync job which will create a consistent replica on the remote server. > Now we can have a longer running rsync job which will create a consistent replica on the remote server.
> The replica includes all repositories, uploads and PostgreSQL data. > The replica includes all repositories, uploads and PostgreSQL data.
If you are running GitLab on a virtualized server you can possibly also create VM snapshots of the entire GitLab server. If you're running GitLab on a virtualized server, you can possibly also create
It is not uncommon however for a VM snapshot to require you to power down the server, so this approach is probably of limited practical use. VM snapshots of the entire GitLab server. It's not uncommon however for a VM
snapshot to require you to power down the server, which limits this solution's
practical use.
## Additional notes ## Additional notes
This documentation is for GitLab Community and Enterprise Edition. We backup This documentation is for GitLab Community and Enterprise Edition. We back up
GitLab.com and make sure your data is secure, but you can't use these methods GitLab.com and ensure your data is secure. You can't, however, use these
to export / backup your data yourself from GitLab.com. methods to export or back up your data yourself from GitLab.com.
Issues are stored in the database. They can't be stored in Git itself. Issues are stored in the database, and can't be stored in Git itself.
To migrate your repositories from one server to another with an up-to-date version of To migrate your repositories from one server to another with an up-to-date
GitLab, you can use the [import Rake task](import.md) to do a mass import of the version of GitLab, use the [import Rake task](import.md) to do a mass import of
repository. Note that if you do an import Rake task, rather than a backup restore, you the repository. If you do an import Rake task rather than a backup restore,
will have all your repositories, but not any other data. you get all of your repositories, but no other data.
## Troubleshooting ## Troubleshooting
The following are possible problems you might encounter with possible solutions. The following are possible problems you might encounter, along with potential
solutions.
### Restoring database backup using Omnibus packages outputs warnings ### Restoring database backup using Omnibus packages outputs warnings
If you are using backup restore procedures you might encounter the following warnings: If you're using backup restore procedures, you may encounter the following
warning messages:
```plaintext ```plaintext
psql:/var/opt/gitlab/backups/db/database.sql:22: ERROR: must be owner of extension plpgsql psql:/var/opt/gitlab/backups/db/database.sql:22: ERROR: must be owner of extension plpgsql
...@@ -1036,22 +1067,31 @@ psql:/var/opt/gitlab/backups/db/database.sql:2931: WARNING: no privileges could ...@@ -1036,22 +1067,31 @@ psql:/var/opt/gitlab/backups/db/database.sql:2931: WARNING: no privileges could
psql:/var/opt/gitlab/backups/db/database.sql:2933: WARNING: no privileges were granted for "public" (two occurrences) psql:/var/opt/gitlab/backups/db/database.sql:2933: WARNING: no privileges were granted for "public" (two occurrences)
``` ```
Be advised that, backup is successfully restored in spite of these warnings. Be advised that the backup is successfully restored in spite of these warning
messages.
The Rake task runs this as the `gitlab` user which does not have the superuser access to the database. When restore is initiated it will also run as `gitlab` user but it will also try to alter the objects it does not have access to. The Rake task runs this as the `gitlab` user, which doesn't have superuser
Those objects have no influence on the database backup/restore but they give this annoying warning. access to the database. When restore is initiated, it also runs as the `gitlab`
user, but it also tries to alter the objects it doesn't have access to.
Those objects have no influence on the database backup or restore, but display
a warning message.
For more information see these PostgreSQL issue tracker questions about [not being a superuser](https://www.postgresql.org/message-id/201110220712.30886.adrian.klaver@gmail.com), [having different owners](https://www.postgresql.org/message-id/2039.1177339749@sss.pgh.pa.us), and on stack overflow, about [resulting errors](https://stackoverflow.com/questions/4368789/error-must-be-owner-of-language-plpgsql). For more information, see:
- PostgreSQL issue tracker:
- [Not being a superuser](https://www.postgresql.org/message-id/201110220712.30886.adrian.klaver@gmail.com).
- [Having different owners](https://www.postgresql.org/message-id/2039.1177339749@sss.pgh.pa.us).
- Stack Overflow: [Resulting errors](https://stackoverflow.com/questions/4368789/error-must-be-owner-of-language-plpgsql).
### When the secrets file is lost ### When the secrets file is lost
If you have failed to [back up the secrets file](#storing-configuration-files), you'll If you didn't [back up the secrets file](#storing-configuration-files), you
need to perform a number of steps to get GitLab working properly again. must complete several steps to get GitLab working properly again.
The secrets file is responsible for storing the encryption key for several The secrets file is responsible for storing the encryption key for the columns
columns containing sensitive information. If the key is lost, GitLab will be that contain required, sensitive information. If the key is lost, GitLab can't
unable to decrypt those columns. This will break a wide range of functionality, decrypt those columns, preventing access to the following items:
including (but not restricted to):
- [CI/CD variables](../ci/variables/README.md) - [CI/CD variables](../ci/variables/README.md)
- [Kubernetes / GCP integration](../user/project/clusters/index.md) - [Kubernetes / GCP integration](../user/project/clusters/index.md)
...@@ -1061,38 +1101,40 @@ including (but not restricted to): ...@@ -1061,38 +1101,40 @@ including (but not restricted to):
- [Project mirroring](../user/project/repository/repository_mirroring.md) - [Project mirroring](../user/project/repository/repository_mirroring.md)
- [Web hooks](../user/project/integrations/webhooks.md) - [Web hooks](../user/project/integrations/webhooks.md)
In cases like CI/CD variables and runner authentication, you might In cases like CI/CD variables and runner authentication, you can experience
experience some unexpected behavior such as: unexpected behaviors, such as:
- Stuck jobs. - Stuck jobs.
- 500 errors. - 500 errors.
In this case, you are required to reset all the tokens for CI/CD variables In this case, you must reset all the tokens for CI/CD variables and
and runner authentication, which is described in more detail below. After runner authentication, which is described in more detail in the following
resetting the tokens, you should be able to visit your project and the jobs sections. After resetting the tokens, you should be able to visit your project
will have started running again. Use the information in the following sections at your own risk. and the jobs will have started running again.
Use the information in the following sections at your own risk.
#### Check for undecryptable values #### Check for undecryptable values
You can check whether you have undecryptable values in the database using You can determine if you have undecryptable values in the database by using the
the [Secrets Doctor Rake task](../administration/raketasks/doctor.md). [Secrets Doctor Rake task](../administration/raketasks/doctor.md).
#### Take a backup #### Take a backup
You will need to directly modify GitLab data to work around your lost secrets file. You must directly modify GitLab data to work around your lost secrets file.
CAUTION: **Warning:** CAUTION: **Warning:**
Make sure you've taken a backup beforehand, particularly a full database backup. Be sure to create a full database backup before attempting any changes.
#### Disable user two-factor authentication (2FA) #### Disable user two-factor authentication (2FA)
Users with 2FA enabled will not be able to log into GitLab. In that case, Users with 2FA enabled can't sign in to GitLab. In that case, you must
you need to [disable 2FA for everyone](../security/two_factor_authentication.md#disabling-2fa-for-everyone) [disable 2FA for everyone](../security/two_factor_authentication.md#disabling-2fa-for-everyone),
and then users will have to reactivate 2FA from scratch. after which users must reactivate 2FA.
#### Reset CI/CD variables #### Reset CI/CD variables
1. Enter the DB console: 1. Enter the database console:
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -1106,14 +1148,14 @@ and then users will have to reactivate 2FA from scratch. ...@@ -1106,14 +1148,14 @@ and then users will have to reactivate 2FA from scratch.
sudo -u git -H bundle exec rails dbconsole -e production sudo -u git -H bundle exec rails dbconsole -e production
``` ```
1. Check the `ci_group_variables` and `ci_variables` tables: 1. Examine the `ci_group_variables` and `ci_variables` tables:
```sql ```sql
SELECT * FROM public."ci_group_variables"; SELECT * FROM public."ci_group_variables";
SELECT * FROM public."ci_variables"; SELECT * FROM public."ci_variables";
``` ```
Those are the variables that you need to delete. These are the variables that you need to delete.
1. Drop the table: 1. Drop the table:
...@@ -1122,12 +1164,11 @@ and then users will have to reactivate 2FA from scratch. ...@@ -1122,12 +1164,11 @@ and then users will have to reactivate 2FA from scratch.
DELETE FROM ci_variables; DELETE FROM ci_variables;
``` ```
1. You may need to reconfigure or restart GitLab for the changes to take You may need to reconfigure or restart GitLab for the changes to take effect.
effect.
#### Reset runner registration tokens #### Reset runner registration tokens
1. Enter the DB console: 1. Enter the database console:
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -1141,11 +1182,11 @@ and then users will have to reactivate 2FA from scratch. ...@@ -1141,11 +1182,11 @@ and then users will have to reactivate 2FA from scratch.
sudo -u git -H bundle exec rails dbconsole -e production sudo -u git -H bundle exec rails dbconsole -e production
``` ```
1. Clear all the tokens for projects, groups, and the whole instance: 1. Clear all tokens for projects, groups, and the entire instance:
CAUTION: **Caution:** CAUTION: **Caution:**
The last UPDATE operation will stop the runners being able to pick up The final `UPDATE` operation stops the runners from being able to pick
new jobs. You must register new runners. up new jobs. You must register new runners.
```sql ```sql
-- Clear project tokens -- Clear project tokens
...@@ -1160,7 +1201,7 @@ and then users will have to reactivate 2FA from scratch. ...@@ -1160,7 +1201,7 @@ and then users will have to reactivate 2FA from scratch.
#### Reset pending pipeline jobs #### Reset pending pipeline jobs
1. Enter the DB console: 1. Enter the database console:
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -1181,19 +1222,18 @@ and then users will have to reactivate 2FA from scratch. ...@@ -1181,19 +1222,18 @@ and then users will have to reactivate 2FA from scratch.
UPDATE ci_builds SET token = null, token_encrypted = null; UPDATE ci_builds SET token = null, token_encrypted = null;
``` ```
A similar strategy can be employed for the remaining features - by removing the A similar strategy can be employed for the remaining features. By removing the
data that cannot be decrypted, GitLab can be brought back into working order, data that can't be decrypted, GitLab can be returned to operation, and the
and the lost data can be manually replaced. lost data can be manually replaced.
#### Fix project integrations #### Fix project integrations
If you've lost your secrets, the If you've lost your secrets, the [projects' integrations settings pages](../user/project/integrations/index.md)
[projects' integrations settings pages](../user/project/integrations/index.md) are probably displaying `500` error messages.
are probably generating 500 errors.
The fix is to truncate the `web_hooks` table: The fix is to truncate the `web_hooks` table:
1. Enter the DB console: 1. Enter the database console:
For Omnibus GitLab packages: For Omnibus GitLab packages:
...@@ -1207,7 +1247,7 @@ The fix is to truncate the `web_hooks` table: ...@@ -1207,7 +1247,7 @@ The fix is to truncate the `web_hooks` table:
sudo -u git -H bundle exec rails dbconsole -e production sudo -u git -H bundle exec rails dbconsole -e production
``` ```
1. Truncate the table 1. Truncate the table:
```sql ```sql
-- truncate web_hooks table -- truncate web_hooks table
...@@ -1216,11 +1256,11 @@ The fix is to truncate the `web_hooks` table: ...@@ -1216,11 +1256,11 @@ The fix is to truncate the `web_hooks` table:
### Container Registry push failures after restoring from a backup ### Container Registry push failures after restoring from a backup
If you use the [Container Registry](../user/packages/container_registry/index.md), you If you use the [Container Registry](../user/packages/container_registry/index.md),
may see pushes to the registry fail after restoring your backup on an Omnibus pushes to the registry may fail after restoring your backup on an Omnibus GitLab
GitLab instance after restoring the registry data. instance after restoring the registry data.
These failures will mention permission issues in the registry logs, like: These failures mention permission issues in the registry logs, similar to:
```plaintext ```plaintext
level=error level=error
...@@ -1230,9 +1270,9 @@ err.detail="filesystem: mkdir /var/opt/gitlab/gitlab-rails/shared/registry/docke ...@@ -1230,9 +1270,9 @@ err.detail="filesystem: mkdir /var/opt/gitlab/gitlab-rails/shared/registry/docke
err.message="unknown error" err.message="unknown error"
``` ```
This is caused by the restore being run as the unprivileged user `git` which was This issue is caused by the restore running as the unprivileged user `git`,
unable to assign the correct ownership to the registry files during the restore which is unable to assign the correct ownership to the registry files during
([issue 62759](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62759 "Incorrect permissions on registry filesystem after restore")). the restore process ([issue 62759](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62759 "Incorrect permissions on registry filesystem after restore")).
To get your registry working again: To get your registry working again:
...@@ -1240,14 +1280,12 @@ To get your registry working again: ...@@ -1240,14 +1280,12 @@ To get your registry working again:
sudo chown -R registry:registry /var/opt/gitlab/gitlab-rails/shared/registry/docker sudo chown -R registry:registry /var/opt/gitlab/gitlab-rails/shared/registry/docker
``` ```
NOTE: **Note:** If you changed the default filesystem location for the registry, run `chown`
If you have changed the default filesystem location for the registry, you will against your custom location, instead of `/var/opt/gitlab/gitlab-rails/shared/registry/docker`.
want to run the `chown` against your custom location instead of
`/var/opt/gitlab/gitlab-rails/shared/registry/docker`.
### Backup fails to complete with Gzip error ### Backup fails to complete with Gzip error
While running the backup, you may receive a Gzip error: When running the backup, you may receive a Gzip error message:
```shell ```shell
sudo /opt/gitlab/bin/gitlab-backup create sudo /opt/gitlab/bin/gitlab-backup create
...@@ -1259,7 +1297,8 @@ gzip: stdout: Input/output error ...@@ -1259,7 +1297,8 @@ gzip: stdout: Input/output error
Backup failed Backup failed
``` ```
If this happens, check the following: If this happens, examine the following:
1. Confirm there is sufficient disk space for the Gzip operation. - Confirm there is sufficient disk space for the Gzip operation.
1. If NFS is being used, check if the mount option `timeout` is set. The default is `600`, and changing this to smaller values have resulted in this error. - If NFS is being used, check if the mount option `timeout` is set. The
default is `600`, and changing this to smaller values results in this error.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7