Skip to content

Docs - Add missing Docker restore commands

Anton Smith requested to merge docs/add-missing-docker-restore-commands into master

What does this MR do?

Our Docker restore documentation https://docs.gitlab.com/ee/raketasks/backup_restore.html#restore-for-docker-image-and-gitlab-helm-chart-installations doesn't mention that we need to stop processes that may connect to the database before we actually perform the restore.

These steps are already in our Omnibus instructions https://docs.gitlab.com/ee/raketasks/backup_restore.html#restore-for-omnibus-gitlab-installations, so we should include them in our Docker instructions.

The purpose of this MR is to help prevent users running into #36405 (closed), which can be caused if Unicorn/Puma/Sidekiq are not shut down before a restore, according to #36405 (comment 301954869) and #36405 (comment 359208008)

I've tested these commands and they work as intended.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Anton Smith

Merge request reports