doc/praefect: Replication factor recommendations
What does this MR do and why?
Describe in detail what your merge request does and why.
doc/praefect: Replication factor recommendations
The default replication factor replicates repositories to every storage in the Gitaly Cluster deployment. This is problematic for large deployments because replica repositories put additional pressure on the primary repository during replication events.
This change updates replication factor documentation to recommend setting the configuration explicitly instead of relying on the default for large deployments.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Before | After |
---|---|
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
changed milestone to %16.1
added devopssystems groupgitaly maintenancerefactor sectioncore platform typemaintenance + 1 deleted label
assigned to @justintobler
- A deleted user
added documentation label
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/administration/gitaly/praefect.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerEdited by Ghost User-
mentioned in issue gitaly#5155
added docs-only label
- Resolved by Evan Read
This change updates replication factor configuration recommendations for large Gitaly Cluster deployments and stems from in discussion in gitaly#5155.
@eread Would you mind giving this a look?
requested review from @eread
- Resolved by Evan Read
enabled an automatic merge when the pipeline for 4e93a340 succeeds
Hi
@eread
,GitLab Bot has added the Technical Writing label because a Technical Writer has approved or merged this MR.
This message was generated automatically. You're welcome to improve it.
added Technical Writing label
mentioned in commit a7c52052
mentioned in merge request !121467 (merged)
added workflowstaging-canary label