Skip to content

Docs: Migrate Gitaly chart to external Gitaly service

Anton Smith requested to merge docs/migrate-gitaly-subchart-to-ext-gitaly into master

What does this MR do?

We recommend in our docs that customers should not use the Gitaly chart in a production environment.

We should add some docs that instruct how to migrate from the Gitaly chart to an external Gitaly service.


Why backup/restore as documented in this MR instead of using the repository storage moves API?

The repository storage moves API requires that all Gitaly servers are visible to each other. This is a problem because the underlying Gitaly pod in the Chart is only accessible within the cluster.

To keep things simple, I have opted for the backup/restore approach but it does mean there will be downtime.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Jason Plum

Merge request reports