Skip to content

Commit 7c96cf6

Browse files
Robert Marshallmkozonogl
andcommitted
Merge branch 'mk/update-backup-restore-doc-links' into 'master'
Update backup and restore doc links See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7195 Merged-by: Robert Marshall <[email protected]> Approved-by: Robert Marshall <[email protected]> Approved-by: Achilleas Pipinellis <[email protected]> Co-authored-by: Mike Kozono <[email protected]>
2 parents 5b7532f + 6706fbf commit 7c96cf6

File tree

6 files changed

+21
-19
lines changed

6 files changed

+21
-19
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,15 +208,15 @@ See [doc/settings/backups.md](doc/settings/backups.md#creating-an-application-ba
208208

209209
### Restoring an application backup
210210

211-
See [backup restore documentation](https://docs.gitlab.com/ee/raketasks/backup_restore.html#omnibus-installations).
211+
See [restore documentation](https://docs.gitlab.com/ee/administration/backup_restore/restore_gitlab.html#restore-for-linux-package-installations).
212212

213213
### Backup and restore using non-packaged database
214214

215215
If you are using non-packaged database see [documentation on using non-packaged database](doc/settings/database.md#using-a-non-packaged-postgresql-database-management-server).
216216

217217
### Upload backups to remote (cloud) storage
218218

219-
For details check [backup restore document of GitLab CE](https://gitlab.com/gitlab-org/gitlab-foss/blob/966f68b33e1f15f08e383ec68346ed1bd690b59b/doc/raketasks/backup_restore.md#upload-backups-to-remote-cloud-storage).
219+
For details check [backup documentation](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#upload-backups-to-a-remote-cloud-storage).
220220

221221
## Invoking Rake tasks
222222

doc/jihu_edition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ To update EE to JH:
6464

6565
- If you installed GitLab using a deb/rpm package:
6666

67-
1. Take a [backup](https://docs.gitlab.com/ee/raketasks/backup_restore.html#back-up-gitlab).
67+
1. Take a [backup](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html).
6868
1. Find the currently installed GitLab version:
6969

7070
**For Debian/Ubuntu**

doc/settings/backups.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Your machines SSH host keys are stored in a separate location at `/etc/ssh/`. Be
6767
> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5102) in GitLab 13.12.
6868
6969
GitLab configuration backups can be pruned using the same `backup_keep_time` setting that is
70-
[used for the GitLab application backups](https://docs.gitlab.com/ee/raketasks/backup_restore.html#limit-backup-lifetime-for-local-files-prune-old-backups)
70+
[used for the GitLab application backups](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#limit-backup-lifetime-for-local-files-prune-old-backups)
7171

7272
To make use of this setting, edit `/etc/gitlab/gitlab.rb`:
7373

@@ -105,7 +105,7 @@ lost/leaked/stolen together with the keys needed to decrypt it.
105105
## Creating an application backup
106106

107107
To create a backup of your repositories and GitLab metadata, follow the
108-
[backup create documentation](https://docs.gitlab.com/ee/raketasks/backup_restore.html).
108+
[backup create documentation](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html).
109109

110110
Backup create will store a tar file in `/var/opt/gitlab/backups`.
111111

@@ -120,7 +120,7 @@ gitlab_rails['backup_path'] = '/mnt/backups'
120120
## Creating backups for GitLab instances in Docker containers
121121

122122
WARNING:
123-
The backup command requires [additional parameters](https://docs.gitlab.com/ee/raketasks/backup_restore.html#backup-and-restore-for-installations-using-pgbouncer)
123+
The backup command requires [additional parameters](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#back-up-and-restore-for-installations-using-pgbouncer)
124124
when your installation is using PgBouncer, for either performance reasons or when using it with a Patroni cluster.
125125

126126
Backups can be scheduled on the host by prepending `docker exec -t <your container name>` to the commands.
@@ -152,15 +152,15 @@ To persist these backups outside the container, mount volumes in the following d
152152

153153
## Restoring an application backup
154154

155-
See [backup restore documentation](https://docs.gitlab.com/ee/raketasks/backup_restore.html#restore-for-omnibus-installations).
155+
See [restore documentation](https://docs.gitlab.com/ee/administration/backup_restore/restore_gitlab.html).
156156

157157
## Backup and restore using non-packaged database
158158

159159
If you are using non-packaged database see [documentation on using non-packaged database](database.md#using-a-non-packaged-postgresql-database-management-server).
160160

161161
## Upload backups to remote (cloud) storage
162162

163-
For details check [backup restore document](https://docs.gitlab.com/ee/raketasks/backup_restore.html#uploading-backups-to-a-remote-cloud-storage).
163+
For details check [backup documentation](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#upload-backups-to-a-remote-cloud-storage).
164164

165165
## Manually manage backup directory
166166

doc/settings/database.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -719,7 +719,9 @@ both the root and intermediate certificates.
719719

720720
### Backup and restore a non-packaged PostgreSQL database
721721

722-
When using the [Rake backup create and restore task](https://docs.gitlab.com/ee/raketasks/backup_restore.html#create-a-backup-of-the-gitlab-system), GitLab will
722+
When using the [backup](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#backup-command)
723+
and [restore](https://docs.gitlab.com/ee/administration/backup_restore/restore_gitlab.html#restore-for-linux-package-installations)
724+
commands, GitLab will
723725
attempt to use the packaged `pg_dump` command to create a database backup file
724726
and the packaged `psql` command to restore a backup. This will only work if
725727
they are the correct versions. Check the versions of the packaged `pg_dump` and
@@ -730,7 +732,7 @@ they are the correct versions. Check the versions of the packaged `pg_dump` and
730732
/opt/gitlab/embedded/bin/psql --version
731733
```
732734

733-
If these versions are different from your non-packaged external PostgreSQL, you may encounter the following error output when attempting to run a [Rake backup create task](https://docs.gitlab.com/ee/raketasks/backup_restore.html#create-a-backup-of-the-gitlab-system):
735+
If these versions are different from your non-packaged external PostgreSQL, you may encounter the following error output when attempting to run the [backup command](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#backup-command).
734736

735737
```plaintext
736738
Dumping PostgreSQL database gitlabhq_production ... pg_dump: error: server version: 13.3; pg_dump version: 12.6
@@ -762,8 +764,8 @@ these steps, using the correct path to the location you installed the new tools:
762764
They should now be the same as your non-packaged external PostgreSQL.
763765

764766
After this is done, ensure that the backup and restore tasks are using the
765-
correct executables by running both the [backup](https://docs.gitlab.com/ee/raketasks/backup_restore.html#create-a-backup-of-the-gitlab-system) and
766-
[restore](https://docs.gitlab.com/ee/raketasks/backup_restore.html#restore-a-previously-created-backup) tasks.
767+
correct executables by running both the [backup](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#backup-command) and
768+
[restore](https://docs.gitlab.com/ee/administration/backup_restore/restore_gitlab.html#restore-for-linux-package-installations) commands.
767769

768770
### Upgrade a non-packaged PostgreSQL database
769771

@@ -784,7 +786,7 @@ Before proceeding with the upgrade, note the following:
784786
The Linux package is tested for compatibility with the major releases of PostgreSQL that it ships with.
785787
- When using GitLab backup or restore, you _must_ keep the same version of GitLab.
786788
If you plan to upgrade to a later GitLab version as well, upgrade PostgreSQL first.
787-
- The [backup and restore Rake task](https://docs.gitlab.com/ee/raketasks/backup_restore.html#create-a-backup-of-the-gitlab-system)
789+
- The [backup and restore commands](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#backup-command)
788790
can be used to back up and restore the database to a later version of PostgreSQL.
789791
- If a PostgreSQL version is specified with `postgresql['version']` that doesn't ship
790792
with that Linux package release, the
@@ -816,7 +818,7 @@ The following example demonstrates upgrading from a database host running Postgr
816818
```
817819

818820
WARNING:
819-
The backup command requires [additional parameters](https://docs.gitlab.com/ee/raketasks/backup_restore.html#backup-and-restore-for-installations-using-pgbouncer)
821+
The backup command requires [additional parameters](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#back-up-and-restore-for-installations-using-pgbouncer)
820822
when your installation is using PgBouncer.
821823

822824
1. Run the backup Rake task using the SKIP options to back up only the database.
@@ -838,14 +840,14 @@ when your installation is using PgBouncer.
838840
```
839841
840842
WARNING:
841-
The backup command requires [additional parameters](https://docs.gitlab.com/ee/raketasks/backup_restore.html#backup-and-restore-for-installations-using-pgbouncer)
843+
The backup command requires [additional parameters](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#back-up-and-restore-for-installations-using-pgbouncer)
842844
when your installation is using PgBouncer.
843845
844846
1. Restore the database using the database backup file created earlier, and be
845847
sure to answer **no** when asked "This task will now rebuild the authorized_keys file":
846848
847849
```shell
848-
# Use the backup timestamp https://docs.gitlab.com/ee/raketasks/backup_restore.html#backup-timestamp
850+
# Use the backup timestamp https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#backup-timestamp
849851
sudo gitlab-backup restore BACKUP=<backup-timestamp>
850852
```
851853

doc/update/convert_to_omnibus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To convert your installation to using the Linux package:
2424

2525
1. [Install GitLab using a Linux package](https://about.gitlab.com/install/).
2626
1. Copy the backup file to the directory `/var/opt/gitlab/backups/` of the new server.
27-
1. Restore the backup in the new installation ([detailed instructions](https://docs.gitlab.com/ee/raketasks/backup_restore.html#restore-for-omnibus-gitlab-installations)):
27+
1. Restore the backup in the new installation ([detailed instructions](https://docs.gitlab.com/ee/administration/backup_restore/restore_gitlab.html#restore-for-linux-package-installations)):
2828

2929
```shell
3030
# This command will overwrite the contents of your GitLab database!

files/gitlab-config-template/gitlab.rb.template

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ external_url 'GENERATED_EXTERNAL_URL'
606606
# gitlab_rails['backup_path'] = "/var/opt/gitlab/backups"
607607
# gitlab_rails['backup_gitaly_backup_path'] = "/opt/gitlab/embedded/bin/gitaly-backup"
608608

609-
###! Docs: https://docs.gitlab.com/ee/raketasks/backup_restore.html#backup-archive-permissions
609+
###! Docs: https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#backup-archive-permissions
610610
# gitlab_rails['backup_archive_permissions'] = 0644
611611

612612
# gitlab_rails['backup_pg_schema'] = 'public'
@@ -644,7 +644,7 @@ external_url 'GENERATED_EXTERNAL_URL'
644644
# gitlab_rails['backup_storage_class'] = 'STANDARD'
645645

646646
###! Skip parts of the backup. Comma separated.
647-
###! Docs: https://docs.gitlab.com/ee/raketasks/backup_restore.html#excluding-specific-directories-from-the-backup
647+
###! Docs: https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#excluding-specific-directories-from-the-backup
648648
#gitlab_rails['env'] = {
649649
# "SKIP" => "db,uploads,repositories,builds,artifacts,lfs,registry,pages"
650650
#}

0 commit comments

Comments
 (0)