Skip to content

Add comment about omitting tail of backup filename on restore

James Reed requested to merge jr-omit-filename-tail into master

What does this MR do?

This MR adds a comment to the Omnibus restore command, to clarify that tail end of the specified backup file that is being restored needs to be omitted. This is already mentioned in the Docker restore section, but should also be visible in the Omnibus restoration section.

Related issues

  • A Premium customer encountered issues when trying to perform a restoration on an GitLab Omnibus installation, where specifying the full file name in the restoration command results in an error such as:

    The backup file 1683927138_2023_05_12_15.11.3-ee_gitlab_backup.tar_gitlab_backup.tar does not exist!

    This will occur if the full filename is specified instead of just 1683927138_2023_05_12_15.11.3-ee in this example.

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by James Reed

Merge request reports