# HG changeset patch # User Evan Read <eread@gitlab.com> # Date 1613101057 0 # Fri Feb 12 03:37:37 2021 +0000 # Node ID 622cc17a1167d4cf7dfec09eede1a2aa92910acf # Parent 8ca70871e3371dbad3f902ba19aa6b41a5300550 Update Praefect information for Gitaly Cluster GA diff --git a/doc/settings/README.md b/doc/settings/README.md --- a/doc/settings/README.md +++ b/doc/settings/README.md @@ -11,6 +11,7 @@ - [Configuration options](configuration.md) - [Database](database.md) - [Environment variables](environment-variables.md) +- [Gitaly Cluster](praefect.md) - [`gitlab.yml`](gitlab.yml.md) - [Grafana](grafana.md) - [LDAP](ldap.md) diff --git a/doc/settings/praefect.md b/doc/settings/praefect.md --- a/doc/settings/praefect.md +++ b/doc/settings/praefect.md @@ -4,26 +4,18 @@ info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers --- -# Praefect +# Gitaly Cluster -Praefect is a manager aiming to maintain replicas for each repository. Praefect -is in active development. The goal is to achieve a highly available storage cluster, -but this is not the case yet, so it is recommended to run Praefect on a different node -than the Gitaly nodes. +[Gitaly Cluster](https://docs.gitlab.com/ee/administration/gitaly/praefect.html) provides +fault-tolerant storage for repositories. It uses Praefect as a router and transaction manager for +Gitaly. -```ruby -praefect['enable'] = true -``` +## Enable Gitaly Cluster -## Praefect settings - -Praefect must be [enabled in GitLab](https://docs.gitlab.com/ee/administration/gitaly/praefect.html#enable-the-daemon) -before it can be used. +By default, Gitaly Cluster is not enabled. For information on enabling Gitaly Cluster, see +the Gitaly Cluster [setup instructions](https://docs.gitlab.com/ee/administration/gitaly/praefect.html#setup-instructions). -### Praefect storage nodes +## Update GitLab when Gitaly Cluster is enabled -Praefect needs one or more Gitaly servers to store the Git data on. These -Gitaly servers are considered Praefect `storage_nodes` -(`praefect['storage_nodes']`). These storage nodes should be private to -Praefect, meaning they should not be listed in `git_data_dirs` in your -`gitlab.rb`. +For information on updating GitLab with Gitaly Cluster enabled, see the +[specific instructions](../update/README.md#gitaly-cluster).