Skip to content

Simplify failover documentation

James Ramsay (ex-GitLab) requested to merge gitaly-docs-improvements into master

What does this MR do?

Automatic failover is needed for high availability and should be enabled in the default setup. This commit integrates enabling automatic failover into the Gitaly node configuration step after verifying they can be reached.

This also solves the problem of Grafana docs being buried below.

Finally, it adds a screenshot to emphasize the importance of changing the default storage.

Related issues

Closes gitaly#2584 (closed)

Author's checklist

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

  • Optional: 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.

Merge request reports