Skip to content

Clarify repository data moves for Gitaly Cluster

What does this MR do?

The approaches to copy/move repository data using tar, rsync, etc. will not work for Gitaly Cluster targets/destinations because they only go to a single host and because they bypass Praefect.

Data cannot be copied onto a single or all the nodes manually and be expected to work (or at least the behavior of doing this remains unclear from the perspective of Praefect lacking knowledge of what occurred behind it).

This change attempts to make more explicit on what approaches would work for Gitaly Cluster (only backup and restore) and what will not.

Related issues

Customer ticket: https://gitlab.zendesk.com/agent/tickets/259094

Author's checklist

If you are 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.

Review 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 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.
    • 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.
  • Ensure a release milestone is set.

Merge request reports