GitLab wird am Donnerstag, den 27. Januar, zwischen 08:00 und 12:00 Uhr wegen wichtigen Wartungsarbeiten nicht zur Verfügung stehen.

backup_restore.md 31.7 KB
Newer Older
1
# Backing up and restoring GitLab
Marin Jankovski's avatar
Marin Jankovski committed
2

3
4
![backup banner](backup_hrz.png)

5
6
An application data backup creates an archive file that contains the database,
all repositories and all attachments.
7

8
9
You can only restore a backup to **exactly the same version and type (CE/EE)**
of GitLab on which it was created. The best way to migrate your repositories
10
from one server to another is through backup restore.
11

12
## Requirements
13

14
15
In order to be able to backup and restore, you need two essential tools
installed on your system.
16

17
### Rsync
18

19
If you installed GitLab:
20

21
22
-   Using the Omnibus package, you're all set.
-   From source, make sure `rsync` is installed:
23

24
25
26
    ```sh
    # Debian/Ubuntu
    sudo apt-get install rsync
27

28
29
30
    # RHEL/CentOS
    sudo yum install rsync
    ```
31

32
### Tar
33
34
35
36
37

Backup and restore tasks use `tar` under the hood to create and extract
archives. Ensure you have version 1.30 or above of `tar` available in your
system. To check the version, run:

38
```sh
39
40
41
tar --version
```

42
## Backup timestamp
43

44
NOTE: **Note:**
45
In GitLab 9.2 the timestamp format was changed from `EPOCH_YYYY_MM_DD` to
46
47
`EPOCH_YYYY_MM_DD_GitLab_version`, for example `1493107454_2018_04_25`
would become `1493107454_2018_04_25_10.6.4-ce`.
48
49
50
51
52
53
54
55

The backup archive will be saved in `backup_path`, which is specified in the
`config/gitlab.yml` file.
The filename will be `[TIMESTAMP]_gitlab_backup.tar`, where `TIMESTAMP`
identifies the time at which each backup was created, plus the GitLab version.
The timestamp is needed if you need to restore GitLab and multiple backups are
available.

56
57
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`.
58

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
## Creating a backup of the GitLab system

GitLab provides a simple command line interface to backup your whole instance.
It backs up your:

- Database
- Attachments
- Git repositories data
- CI/CD job output logs
- CI/CD job artifacts
- LFS objects
- Container Registry images
- GitLab Pages content

CAUTION: **Warning:**
GitLab does not back up any configuration files, SSL certificates, or system files.
You are highly advised to [read about storing configuration files](#storing-configuration-files).
76

77
Use this command if you've installed GitLab with the Omnibus package:
78

79
```sh
80
sudo gitlab-rake gitlab:backup:create
81
```
82

83
Use this if you've installed GitLab from source:
84

85
```sh
Ben Bodenmiller's avatar
Ben Bodenmiller committed
86
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
87
```
88

89
If you are running GitLab within a Docker container, you can run the backup from the host:
90

91
```sh
92
docker exec -t <container name> gitlab-rake gitlab:backup:create
93
```
94

95
96
97
If you are using the [GitLab helm chart](https://gitlab.com/charts/gitlab) on a
Kubernetes cluster, you can run the backup task using `backup-utility` script on
the gitlab task runner pod via `kubectl`. Refer to [backing up a GitLab installation](https://gitlab.com/charts/gitlab/blob/master/doc/backup-restore/backup.md#backing-up-a-gitlab-installation) for more details:
98

99
```sh
100
kubectl exec -it <gitlab task-runner pod> backup-utility
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
Example output:

```
Dumping database tables:
- Dumping table events... [DONE]
- Dumping table issues... [DONE]
- Dumping table keys... [DONE]
- Dumping table merge_requests... [DONE]
- Dumping table milestones... [DONE]
- Dumping table namespaces... [DONE]
- Dumping table notes... [DONE]
- Dumping table projects... [DONE]
- Dumping table protected_branches... [DONE]
- Dumping table schema_migrations... [DONE]
- Dumping table services... [DONE]
- Dumping table snippets... [DONE]
- Dumping table taggings... [DONE]
- Dumping table tags... [DONE]
- Dumping table users... [DONE]
- Dumping table users_projects... [DONE]
- Dumping table web_hooks... [DONE]
- Dumping table wikis... [DONE]
Dumping repositories:
- Dumping repository abcd... [DONE]
Creating backup archive: $TIMESTAMP_gitlab_backup.tar [DONE]
Deleting tmp directories...[DONE]
Deleting old backups... [SKIPPING]
```

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
## Storing configuration files

A backup performed by the [raketask GitLab provides](#creating-a-backup-of-the-gitlab-system)
does **not** store your configuration files. The primary reason for this is that your
database contains encrypted information for two-factor authentication, the CI/CD
'secure variables', etc. Storing encrypted information along with its key in the
same place defeats the purpose of using encryption in the first place.

CAUTION: **Warning:**
The secrets file is essential to preserve your database encryption key.

At the very **minimum**, you must backup:

For Omnibus:

- `/etc/gitlab/gitlab-secrets.json`
- `/etc/gitlab/gitlab.rb`

For installation from source:

- `/home/git/gitlab/config/secrets.yml`
- `/home/git/gitlab/config/gitlab.yml`

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
the GitLab container according to the documentation, it should be under
`/srv/gitlab/config`.

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).

If you use Omnibus GitLab, see some additional information
[to backup your configuration](https://docs.gitlab.com/omnibus/settings/backups.html).

In the unlikely event that the secrets file is lost, see the
[troubleshooting section](#when-the-secrets-file-is-lost).

## Backup options

The command line tool GitLab provides to backup your instance can take more options.

173
### Backup strategy option
174

175
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8728) in GitLab 8.17.
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

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
fine in most cases, but can cause problems when data is rapidly changing.

When data changes while `tar` is reading it, the error `file changed as we read
it` may occur, and will cause the backup process to fail. To combat this, 8.17
introduces a new backup strategy called `copy`. The strategy copies data files
to a temporary location before calling `tar` and `gzip`, avoiding the error.

A side-effect is that the backup process with take up to an additional 1X disk
space. The process does its best to clean up the temporary files at each stage
so the problem doesn't compound, but it could be a considerable change for large
installations. This is why the `copy` strategy is not the default in 8.17.

To use the `copy` strategy instead of the default streaming strategy, specify
192
193
194
195
196
`STRATEGY=copy` in the Rake task command. For example:

```sh
sudo gitlab-rake gitlab:backup:create STRATEGY=copy
```
197

198
199
200
201
202
203
204
205
206
207
### Backup filename

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:

```sh
sudo gitlab-rake gitlab:backup:create BACKUP=dump
```

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.

208
209
### Rsyncable

210
211
212
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).

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.
213
214
215
216

```sh
sudo gitlab-rake gitlab:backup:create BACKUP=dump GZIP_RSYNCABLE=yes
```
217

218
### Excluding specific directories from the backup
219

220
You can choose what should be exempt from the backup up by adding the environment variable `SKIP`.
221
222
The available options are:

223
224
225
226
227
228
229
230
- `db` (database)
- `uploads` (attachments)
- `repositories` (Git repositories data)
- `builds` (CI job output logs)
- `artifacts` (CI job artifacts)
- `lfs` (LFS objects)
- `registry` (Container Registry images)
- `pages` (Pages content)
231
232
233

Use a comma to specify several options at the same time:

234
235
236
All wikis will be backed up as part of the `repositories` group. Non-existent wikis
will be skipped during a backup.

237
238
239
For Omnibus GitLab packages:

```sh
240
sudo gitlab-rake gitlab:backup:create SKIP=db,uploads
241
242
243
```

For installations from source:
244

245
```sh
246
247
248
sudo -u git -H bundle exec rake gitlab:backup:create SKIP=db,uploads RAILS_ENV=production
```

249
### Uploading backups to a remote (cloud) storage
250

251
252
Starting with GitLab 7.4 you can let the backup script upload the '.tar' file it creates.
It uses the [Fog library](http://fog.io/) to perform the upload.
253
254
255
In the example below we use Amazon S3 for storage, but Fog also lets you use
[other storage providers](http://fog.io/storage/). GitLab
[imports cloud drivers](https://gitlab.com/gitlab-org/gitlab-ce/blob/30f5b9a5b711b46f1065baf755e413ceced5646b/Gemfile#L88)
256
for AWS, Google, OpenStack Swift, Rackspace and Aliyun as well. A local driver is
257
[also available](#uploading-to-locally-mounted-shares).
258

259
#### Using Amazon S3
260

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
For Omnibus GitLab packages:

1. Add the following to `/etc/gitlab/gitlab.rb`:

    ```ruby
    gitlab_rails['backup_upload_connection'] = {
      'provider' => 'AWS',
      'region' => 'eu-west-1',
      'aws_access_key_id' => 'AKIAKIAKI',
      'aws_secret_access_key' => 'secret123'
      # If using an IAM Profile, don't configure aws_access_key_id & aws_secret_access_key
      # 'use_iam_profile' => true
    }
    gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
    ```

1. [Reconfigure GitLab] for the changes to take effect
278

279
#### Digital Ocean Spaces
280

281
This example can be used for a bucket in Amsterdam (AMS3).
282

283
1. Add the following to `/etc/gitlab/gitlab.rb`:
284
285
286
287
288
289
290
291
292
293
294
295
296
297

    ```ruby
    gitlab_rails['backup_upload_connection'] = {
      'provider' => 'AWS',
      'region' => 'ams3',
      'aws_access_key_id' => 'AKIAKIAKI',
      'aws_secret_access_key' => 'secret123',
      'endpoint'              => 'https://ams3.digitaloceanspaces.com'
    }
    gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
    ```

1. [Reconfigure GitLab] for the changes to take effect

298
NOTE: **Note:**
299
300
301
302
303
If you see `400 Bad Request` by using Digital Ocean Spaces, the cause may be the
usage of backup encryption. Remove or comment the line that
contains `gitlab_rails['backup_encryption']` since Digital Ocean Spaces
doesn't support encryption.

304
305
306
307
308
309
310
#### Other S3 Providers

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
need to downgrade the `aws_signature_version` value from the default value to
2 [due to this issue](https://github.com/fog/fog-aws/issues/428).

311
---
312

313
314
For installations from source:

315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
1. Edit `home/git/gitlab/config/gitlab.yml`:

    ```yaml
      backup:
        # snip
        upload:
          # Fog storage connection settings, see http://fog.io/storage/ .
          connection:
            provider: AWS
            region: eu-west-1
            aws_access_key_id: AKIAKIAKI
            aws_secret_access_key: 'secret123'
            # If using an IAM Profile, leave aws_access_key_id & aws_secret_access_key empty
            # ie. aws_access_key_id: ''
            # use_iam_profile: 'true'
          # The remote 'directory' to store your backups. For S3, this would be the bucket name.
          remote_directory: 'my.s3.bucket'
          # Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for backups, this is optional
          # encryption: 'AES256'
334
335
336
337
338
          # Turns on AWS Server-Side Encryption with Amazon Customer-Provided Encryption Keys for backups, this is optional
          #   This should be set to the base64-encoded encryption key for Amazon S3 to use to encrypt or decrypt your data.
          #   'encryption' must also be set in order for this to have any effect.
          #   To avoid storing the key on disk, the key can also be specified via the `GITLAB_BACKUP_ENCRYPTION_KEY` environment variable.
          # encryption_key: '<base64 key>'
339
340
341
342
343
          # Specifies Amazon S3 storage class to use for backups, this is optional
          # storage_class: 'STANDARD'
    ```

1. [Restart GitLab] for the changes to take effect
344
345
346

If you are uploading your backups to S3 you will probably want to create a new
IAM user with restricted access rights. To give the upload user access only for
347
uploading backups create the following IAM profile, replacing `my.s3.bucket`
348
349
350
351
with the name of your bucket:

```json
{
352
  "Version": "2012-10-17",
353
354
  "Statement": [
    {
355
      "Sid": "Stmt1412062044000",
356
357
358
359
360
361
362
      "Effect": "Allow",
      "Action": [
        "s3:AbortMultipartUpload",
        "s3:GetBucketAcl",
        "s3:GetBucketLocation",
        "s3:GetObject",
        "s3:GetObjectAcl",
363
        "s3:ListBucketMultipartUploads",
364
365
366
367
368
369
        "s3:PutObject",
        "s3:PutObjectAcl"
      ],
      "Resource": [
        "arn:aws:s3:::my.s3.bucket/*"
      ]
370
    },
371
    {
372
      "Sid": "Stmt1412062097000",
373
374
      "Effect": "Allow",
      "Action": [
375
376
        "s3:GetBucketLocation",
        "s3:ListAllMyBuckets"
377
378
379
380
      ],
      "Resource": [
        "*"
      ]
381
    },
382
    {
383
      "Sid": "Stmt1412062128000",
384
385
386
387
388
389
390
391
392
393
394
395
      "Effect": "Allow",
      "Action": [
        "s3:ListBucket"
      ],
      "Resource": [
        "arn:aws:s3:::my.s3.bucket"
      ]
    }
  ]
}
```

396
397
398
399
400
#### Using Google Cloud Storage

If you want to use Google Cloud Storage to save backups, you'll have to create
an access key from the Google console first:

401
1. Go to the storage settings page <https://console.cloud.google.com/storage/settings>
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
1. Select "Interoperability" and create an access key
1. Make note of the "Access Key" and "Secret" and replace them in the
   configurations below
1. Make sure you already have a bucket created

For Omnibus GitLab packages:

1. Edit `/etc/gitlab/gitlab.rb`:

    ```ruby
    gitlab_rails['backup_upload_connection'] = {
      'provider' => 'Google',
      'google_storage_access_key_id' => 'Access Key',
      'google_storage_secret_access_key' => 'Secret'
    }
    gitlab_rails['backup_upload_remote_directory'] = 'my.google.bucket'
    ```

1. [Reconfigure GitLab] for the changes to take effect

---

For installations from source:

1. Edit `home/git/gitlab/config/gitlab.yml`:

    ```yaml
      backup:
        upload:
          connection:
            provider: 'Google'
            google_storage_access_key_id: 'Access Key'
            google_storage_secret_access_key: 'Secret'
          remote_directory: 'my.google.bucket'
    ```

1. [Restart GitLab] for the changes to take effect

440
441
442
443
444
445
446
447
448
449
#### Specifying a custom directory for backups

Note: This option only works for remote storage. If you want to group your backups
you can pass a `DIRECTORY` environment variable:

```
sudo gitlab-rake gitlab:backup:create DIRECTORY=daily
sudo gitlab-rake gitlab:backup:create DIRECTORY=weekly
```

450
451
452
### Uploading to locally mounted shares

You may also send backups to a mounted share (`NFS` / `CIFS` / `SMB` / etc.) by
453
using the Fog [`Local`](https://github.com/fog/fog-local#usage) storage provider.
454
455
456
457
458
459
460
461
462
463
464
The directory pointed to by the `local_root` key **must** be owned by the `git`
user **when mounted** (mounting with the `uid=` of the `git` user for `CIFS` and
`SMB`) or the user that you are executing the backup tasks under (for omnibus
packages, this is the `git` user).

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
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, just use `.` instead.

465
NOTE: **Note:** Since file system performance may affect GitLab's overall performance, we do not recommend using EFS for storage. See the [relevant documentation](../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details.
466

467
For Omnibus GitLab packages:
468

469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
1. Edit `/etc/gitlab/gitlab.rb`:

    ```ruby
    gitlab_rails['backup_upload_connection'] = {
      :provider => 'Local',
      :local_root => '/mnt/backups'
    }

    # The directory inside the mounted folder to copy backups to
    # Use '.' to store them in the root directory
    gitlab_rails['backup_upload_remote_directory'] = 'gitlab_backups'
    ```

1. [Reconfigure GitLab] for the changes to take effect.

---
485
486
487

For installations from source:

488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
1. Edit `home/git/gitlab/config/gitlab.yml`:

    ```yaml
    backup:
      upload:
        # Fog storage connection settings, see http://fog.io/storage/ .
        connection:
          provider: Local
          local_root: '/mnt/backups'
        # The directory inside the mounted folder to copy backups to
        # Use '.' to store them in the root directory
        remote_directory: 'gitlab_backups'
    ```

1. [Restart GitLab] for the changes to take effect.
503

504
### Backup archive permissions
505

506
507
The backup archives created by GitLab (`1393513186_2014_02_27_gitlab_backup.tar`)
will have owner/group git:git and 0600 permissions by default.
508
509
510
This is meant to avoid other system users reading GitLab's data.
If you need the backup archives to have different permissions you can use the 'archive_permissions' setting.

511
For Omnibus GitLab packages:
512

513
1. Edit `/etc/gitlab/gitlab.rb`:
514

515
516
517
518
519
520
521
522
523
    ```ruby
    gitlab_rails['backup_archive_permissions'] = 0644 # Makes the backup archives world-readable
    ```

1. [Reconfigure GitLab] for the changes to take effect.

---

For installations from source:
524

525
1. Edit `/home/git/gitlab/config/gitlab.yml`:
526

527
528
529
530
    ```yaml
    backup:
      archive_permissions: 0644 # Makes the backup archives world-readable
    ```
531

532
1. [Restart GitLab] for the changes to take effect.
533

534
535
### Configuring cron to make daily backups

536
NOTE: **Note:**
537
538
539
The following cron jobs do not [backup your GitLab configuration files](#storing-configuration-files)
or [SSH host keys](https://superuser.com/questions/532040/copy-ssh-keys-from-one-server-to-another-server/532079#532079).

540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
For Omnibus GitLab packages:

1. Edit `/etc/gitlab/gitlab.rb`:

    ```ruby
    ## Limit backup lifetime to 7 days - 604800 seconds
    gitlab_rails['backup_keep_time'] = 604800
    ```

1. [Reconfigure GitLab] for the changes to take effect.

Note that the `backup_keep_time` configuration option only manages local
files. GitLab does not automatically prune old files stored in a third-party
object storage (e.g., AWS S3) because the user may not have permission to list
and delete files. We recommend that you configure the appropriate retention
policy for your object storage. For example, you can configure [the S3 backup
policy as described here](http://stackoverflow.com/questions/37553070/gitlab-omnibus-delete-backup-from-amazon-s3).
557
558
559

To schedule a cron job that backs up your repositories and GitLab metadata, use the root user:

560
```sh
561
562
563
564
565
566
567
568
569
570
571
sudo su -
crontab -e
```

There, add the following line to schedule the backup for everyday at 2 AM:

```
0 2 * * * /opt/gitlab/bin/gitlab-rake gitlab:backup:create CRON=1
```

You may also want to set a limited lifetime for backups to prevent regular
572
backups using all your disk space.
573

574
---
575

576
577
578
For installations from source:

1. Edit `home/git/gitlab/config/gitlab.yml`:
579

580
581
582
583
584
    ```yaml
    backup:
      ## Limit backup lifetime to 7 days - 604800 seconds
      keep_time: 604800
    ```
585

586
587
588
1. [Restart GitLab] for the changes to take effect.

```sh
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
sudo -u git crontab -e # Edit the crontab for the git user
```

Add the following lines at the bottom:

```
# Create a full backup of the GitLab repositories and SQL database every day at 4am
0 4 * * * cd /home/git/gitlab && PATH=/usr/local/bin:/usr/bin:/bin bundle exec rake gitlab:backup:create RAILS_ENV=production CRON=1
```

The `CRON=1` environment setting tells the backup script to suppress all progress output if there are no errors.
This is recommended to reduce cron spam.

## Restore

604
GitLab provides a simple command line interface to restore your whole installation,
605
606
607
608
609
610
and is flexible enough to fit your needs.

The [restore prerequisites section](#restore-prerequisites) includes crucial
information. Make sure to read and test the whole restore process at least once
before attempting to perform it in a production environment.

611
You can only restore a backup to **exactly the same version and type (CE/EE)** of
612
GitLab that you created it on, for example CE 9.1.0.
613
614

### Restore prerequisites
615
616
617
618
619
620
621
622

You need to have a working GitLab installation before you can perform
a restore. This is mainly because the system user performing the
restore actions ('git') is usually not allowed to create or delete
the SQL database it needs to import data into ('gitlabhq_production').
All existing data will be either erased (SQL) or moved to a separate
directory (repositories, uploads).

623
624
625
To restore a backup, you will also need to restore `/etc/gitlab/gitlab-secrets.json`
(for Omnibus packages) or `/home/git/gitlab/.secret` (for installations
from source). This file contains the database encryption key,
626
627
[CI/CD variables](../ci/variables/README.md#variables), and
variables used for [two-factor authentication](../user/profile/account/two_factor_authentication.md).
628
629
630
631
If you fail to restore this encryption key file along with the application data
backup, users with two-factor authentication enabled and GitLab Runners will
lose access to your GitLab server.

Davin Walker's avatar
Davin Walker committed
632
633
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).

634
635
636
637
638
Depending on your case, you might want to run the restore command with one or
more of the following options:

- `BACKUP=timestamp_of_backup` - Required if more than one backup exists.
  Read what the [backup timestamp is about](#backup-timestamp).
639
- `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.
640

641
642
643
644
645
646
647
If you are restoring into directories that are mountpoints you will need to make
sure these directories are empty before attempting a restore. Otherwise GitLab
will attempt to move these directories before restoring the new data and this
would cause an error.

Read more on [configuring NFS mounts](../administration/high_availability/nfs.md)

648
### Restore for installation from source
649

Valery Sizov's avatar
Valery Sizov committed
650
```
651
652
653
# Stop processes that are connected to the database
sudo service gitlab stop

654
bundle exec rake gitlab:backup:restore RAILS_ENV=production
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
```

Example output:

```
Unpacking backup... [DONE]
Restoring database tables:
-- create_table("events", {:force=>true})
   -> 0.2231s
[...]
- Loading fixture events...[DONE]
- Loading fixture issues...[DONE]
- Loading fixture keys...[SKIPPING]
- Loading fixture merge_requests...[DONE]
- Loading fixture milestones...[DONE]
- Loading fixture namespaces...[DONE]
- Loading fixture notes...[DONE]
- Loading fixture projects...[DONE]
- Loading fixture protected_branches...[SKIPPING]
- Loading fixture schema_migrations...[DONE]
- Loading fixture services...[SKIPPING]
- Loading fixture snippets...[SKIPPING]
- Loading fixture taggings...[SKIPPING]
- Loading fixture tags...[SKIPPING]
- Loading fixture users...[DONE]
- Loading fixture users_projects...[DONE]
- Loading fixture web_hooks...[SKIPPING]
- Loading fixture wikis...[SKIPPING]
Restoring repositories:
- Restoring repository abcd... [DONE]
685
- Object pool 1 ...
686
687
Deleting tmp directories...[DONE]
```
688

689
690
691
692
693
694
695
696
Next, restore `/home/git/gitlab/.secret` if necessary as mentioned above.

Restart GitLab:

```shell
sudo service gitlab restart
```

697
### Restore for Omnibus GitLab installations
Valery Sizov's avatar
Valery Sizov committed
698

699
This procedure assumes that:
Valery Sizov's avatar
Valery Sizov committed
700

701
- You have installed the **exact same version and type (CE/EE)** of GitLab
702
  Omnibus with which the backup was created.
703
- You have run `sudo gitlab-ctl reconfigure` at least once.
704
705
706
707
- 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
`gitlab.rb` configuration `gitlab_rails['backup_path']`. The default is
708
`/var/opt/gitlab/backups`. It needs to be owned by the `git` user.
Valery Sizov's avatar
Valery Sizov committed
709
710

```shell
711
sudo cp 11493107454_2018_04_25_10.6.4-ce_gitlab_backup.tar /var/opt/gitlab/backups/
Craig Fisher's avatar
Craig Fisher committed
712
sudo chown git.git /var/opt/gitlab/backups/11493107454_2018_04_25_10.6.4-ce_gitlab_backup.tar
Valery Sizov's avatar
Valery Sizov committed
713
714
```

715
716
Stop the processes that are connected to the database.  Leave the rest of GitLab
running:
Valery Sizov's avatar
Valery Sizov committed
717
718
719
720

```shell
sudo gitlab-ctl stop unicorn
sudo gitlab-ctl stop sidekiq
721
722
723
# Verify
sudo gitlab-ctl status
```
Valery Sizov's avatar
Valery Sizov committed
724

725
726
727
728
Next, restore the backup, specifying the timestamp of the backup you wish to
restore:

```shell
Valery Sizov's avatar
Valery Sizov committed
729
# This command will overwrite the contents of your GitLab database!
730
sudo gitlab-rake gitlab:backup:restore BACKUP=1493107454_2018_04_25_10.6.4-ce
731
```
Valery Sizov's avatar
Valery Sizov committed
732

733
734
Next, restore `/etc/gitlab/gitlab-secrets.json` if necessary as mentioned above.

735
Restart and check GitLab:
Valery Sizov's avatar
Valery Sizov committed
736

737
```shell
738
sudo gitlab-ctl restart
Valery Sizov's avatar
Valery Sizov committed
739
740
741
742
sudo gitlab-rake gitlab:check SANITIZE=true
```

If there is a GitLab version mismatch between your backup tar file and the installed
743
version of GitLab, the restore command will abort with an error. Install the
744
[correct GitLab version](https://packages.gitlab.com/gitlab/) and try again.
Valery Sizov's avatar
Valery Sizov committed
745

746
### Restore for Docker image and GitLab helm chart installations
747

748
749
For GitLab installations using the Docker image or the GitLab helm chart on
a Kubernetes cluster, the restore task expects the restore directories to be empty.
750
751
752
753
754
755
756
757
758
759
However, with docker and Kubernetes volume mounts, some system level directories
may be created at the volume roots, like `lost+found` directory found in Linux
operating systems. These directories are usually owned by `root`, which can
cause access permission errors since the restore rake task runs as `git` user.
So, to restore a GitLab installation, users have to confirm the restore target
directories are empty.

For both these installation types, the backup tarball has to be available in the
backup location (default location is `/var/opt/gitlab/backups`).

760
For docker installations, the restore task can be run from host:
761

762
```sh
763
764
765
docker exec -it <name of container> gitlab-rake gitlab:backup:restore
```

766
767
The GitLab helm chart uses a different process, documented in
[restoring a GitLab helm chart installation](https://gitlab.com/charts/gitlab/blob/master/doc/backup-restore/restore.md).
768

Jacob Vosmaer's avatar
Jacob Vosmaer committed
769
770
771
772
773
## 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.
In this case you can consider using filesystem snapshots as part of your backup strategy.

774
Example: Amazon EBS
Jacob Vosmaer's avatar
Jacob Vosmaer committed
775
776
777
778
779
780

> A GitLab server using omnibus-gitlab hosted on Amazon AWS.
> An EBS drive containing an ext4 filesystem is mounted at `/var/opt/gitlab`.
> In this case you could make an application backup by taking an EBS snapshot.
> The backup includes all repositories, uploads and Postgres data.

781
Example: LVM snapshots + rsync
Jacob Vosmaer's avatar
Jacob Vosmaer committed
782
783

> A GitLab server using omnibus-gitlab, with an LVM logical volume mounted at `/var/opt/gitlab`.
784
> Replicating the `/var/opt/gitlab` directory using rsync would not be reliable because too many files would change while rsync is running.
Jacob Vosmaer's avatar
Jacob Vosmaer committed
785
> Instead of rsync-ing `/var/opt/gitlab`, we create a temporary LVM snapshot, which we mount as a read-only filesystem at `/mnt/gitlab_backup`.
786
> Now we can have a longer running rsync job which will create a consistent replica on the remote server.
Jacob Vosmaer's avatar
Jacob Vosmaer committed
787
788
789
790
> The replica includes all repositories, uploads and Postgres data.

If you are running GitLab on a virtualized server you can possibly also create VM snapshots of the entire GitLab server.
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.
791

792
793
794
795
796
797
798
799
800
801
802
803
804
## Additional notes

This documentation is for GitLab Community and Enterprise Edition. We backup
GitLab.com and make sure your data is secure, but you can't use these methods
to export / backup your data yourself from GitLab.com.

Issues are stored in the database. They can't be stored in Git itself.

To migrate your repositories from one server to another with an up-to-date version of
GitLab, you can use the [import rake task](import.md) to do a mass import of the
repository. Note that if you do an import rake task, rather than a backup restore, you
will have all your repositories, but not any other data.

805
806
807
808
809
810
811
## Troubleshooting

### Restoring database backup using omnibus packages outputs warnings
If you are using backup restore procedures you might encounter the following warnings:

```
psql:/var/opt/gitlab/backups/db/database.sql:22: ERROR:  must be owner of extension plpgsql
812
813
psql:/var/opt/gitlab/backups/db/database.sql:2931: WARNING:  no privileges could be revoked for "public" (two occurrences)
psql:/var/opt/gitlab/backups/db/database.sql:2933: WARNING:  no privileges were granted for "public" (two occurrences)
814
815
816
817
818
819
820
821
```

Be advised that, backup is successfully restored in spite of these warnings.

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.
Those objects have no influence on the database backup/restore but they give this annoying warning.

For more information see similar questions on postgresql issue tracker[here](http://www.postgresql.org/message-id/201110220712.30886.adrian.klaver@gmail.com) and [here](http://www.postgresql.org/message-id/2039.1177339749@sss.pgh.pa.us) as well as [stack overflow](http://stackoverflow.com/questions/4368789/error-must-be-owner-of-language-plpgsql).
822

823
824
825
826
827
828
### When the secrets file is lost

If you have failed to [back up the secrets file](#storing-configuration-files),
then users with 2FA enabled will not be able to log into GitLab. In that case,
you need to [disable 2FA for everyone](../security/two_factor_authentication.md#disabling-2fa-for-everyone).

829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
The secrets file is also responsible for storing the encryption key for several
columns containing sensitive information. If the key is lost, GitLab will be
unable to decrypt those columns. This will break a wide range of functionality,
including (but not restricted to):

* [CI/CD variables](../ci/variables/README.md)
* [Kubernetes / GCP integration](../user/project/clusters/index.md)
* [Custom Pages domains](../user/project/pages/getting_started_part_three.md)
* [Project error tracking](../user/project/operations/error_tracking.md)
* [Runner authentication](../ci/runners/README.md)
* [Project mirroring](../workflow/repository_mirroring.md)
* [Web hooks](../user/project/integrations/webhooks.md)

In the case of CI/CD, variables, you might experience some weird behavior, like
stuck jobs or 500 errors. In that case, you can try removing  contents of the
`ci_group_variables` and `ci_project_variables` tables from the database.
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863

CAUTION: **Warning:**
Use the following commands at your own risk, and make sure you've taken a
backup beforehand.

1.  Enter the Rails console:

    For Omnibus GitLab packages:

    ```sh
    sudo gitlab-rails dbconsole
    ```

    For installations from source:

    ```sh
    sudo -u git -H bundle exec rails dbconsole RAILS_ENV=production
    ```

864
1.  Check the `ci_group_variables` and `ci_variables` tables:
865
866

    ```sql
867
    SELECT * FROM public."ci_group_variables";
868
869
870
871
872
873
874
875
    SELECT * FROM public."ci_variables";
    ```

    Those are the variables that you need to delete.

1.  Drop the table:

    ```sql
876
    DELETE FROM ci_group_variables;
877
878
879
880
881
882
883
884
885
    DELETE FROM ci_variables;
    ```

1. You may need to reconfigure or restart GitLab for the changes to take
   effect.

You should now be able to visit your project, and the jobs will start
running again.

886
887
888
889
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,
and the lost data can be manually replaced.

890
891
[reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source