Skip to content
Snippets Groups Projects
Commit 9ebe012bccd4 authored by Russell Dickenson's avatar Russell Dickenson
Browse files

Merge branch 'eread/update-praefect-docs' into 'master'

Update Praefect information for Gitaly Cluster GA

Closes gitaly#3432

See merge request gitlab-org/omnibus-gitlab!4980
No related branches found
No related tags found
1 merge request!26GitLab 13.9
......@@ -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)
......
......@@ -4,5 +4,5 @@
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
......@@ -8,6 +8,5 @@
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.
......@@ -13,5 +12,3 @@
```ruby
praefect['enable'] = true
```
## Enable Gitaly Cluster
......@@ -17,6 +14,4 @@
## 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).
......@@ -22,3 +17,3 @@
### Praefect storage nodes
## Update GitLab when Gitaly Cluster is enabled
......@@ -24,6 +19,3 @@
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).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment