Skip to content

Rename Praefect High Availability to Gitaly Cluster

James Ramsay (ex-GitLab) requested to merge gitaly-ha-naming into master

What does this MR do?

High Availability is property of a system, and is confusing when used as the name of a feature. Particularly it is confusing given there are multiple aspects to making a GitLab instance HA.

Additionally, the work we are doing on Gitaly and Praefect is not exclusively for High Availability. A clustered configuration will provide performance improvements in the future.

  • Removes Beta warning in preparation for GA in 13.0

Summary of a few names considered.

Name Mutually Exclusive Collectively Exhaustive Few Words Ubiquitous language
Gitaly High Availability High availability is used to refer to the configuration of lots of aspects of the GitLab application. Gitaly is also the name of a component. It does not not capture all use cases, like performance Short High Availability is ubiquitous
Praefect Would refer to both a component and a feature Covers performance, availability etc Short No one knows what Praefect is
Gitaly Cluster Refers to a feature specific to Gitaly. Gitaly is also the name of a component. Covers performance, availability etc Short Clusters is a well understood term for the configuration that the feature enables

Related issues

gitlab-com/Product#1160 (closed)

Author's checklist (required)

When applicable:

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.
Edited by 🤖 GitLab Bot 🤖

Merge request reports