diff options
Diffstat (limited to 'doc/administration/gitaly/praefect.md')
| -rw-r--r-- | doc/administration/gitaly/praefect.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 8cf32a6aaa3..9cc93b21ae9 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -28,6 +28,9 @@ The minimum recommended configuration for a Gitaly Cluster requires: - 3 Praefect nodes - 3 Gitaly nodes (1 primary, 2 secondary) +NOTE: +[Disk requirements](index.md#disk-requirements) apply to Gitaly nodes. + You should configure an odd number of Gitaly nodes so that transactions have a tie-breaker in case one of the Gitaly nodes fails in a mutating RPC call. @@ -43,15 +46,15 @@ default value. The default value depends on the GitLab version. Network latency for Gitaly Cluster should ideally be measurable in single-digit milliseconds. Latency is particularly important for: -- Gitaly node health checks. Nodes must be able to respond within 1 second. +- Gitaly node health checks. Nodes must be able to respond 1 second or faster. - Reference transactions that enforce [strong consistency](index.md#strong-consistency). Lower latencies mean Gitaly nodes can agree on changes faster. Achieving acceptable latency between Gitaly nodes: - On physical networks generally means high bandwidth, single location connections. -- On the cloud generally means within the same region, including allowing cross availability zone replication. These links - are designed for this type of synchronization. Latency of less than 2ms should be sufficient for Gitaly Cluster. +- On the cloud generally means in the same region, including allowing cross availability zone replication. These links + are designed for this type of synchronization. Latency of less than 2 ms should be sufficient for Gitaly Cluster. If you can't provide low network latencies for replication (for example, between distant locations), consider Geo. For more information, see [Comparison to Geo](index.md#comparison-to-geo). @@ -82,7 +85,7 @@ The requirements are relatively low because the database contains only metadata - Where repositories are located. - Some queued work. -It depends on the number of repositories, but a useful minimum is 5-10 GB, similar to the main +It depends on the number of repositories, but a good minimum is 5-10 GB, similar to the main GitLab application database. ## Setup Instructions @@ -103,7 +106,7 @@ If you [installed](https://about.gitlab.com/install/) GitLab using the Omnibus G Before beginning, you should already have a working GitLab instance. [Learn how to install GitLab](https://about.gitlab.com/install/). -Provision a PostgreSQL server. We recommend using the PostgreSQL that is shipped +Provision a PostgreSQL server. You should use the PostgreSQL that is shipped with Omnibus GitLab and use it to configure the PostgreSQL database. You can use an external PostgreSQL server (version 11 or newer) but you must set it up [manually](#manual-database-setup). @@ -1453,7 +1456,7 @@ To migrate existing clusters: 1. On the Praefect nodes, configure the election strategy in `/etc/gitlab/gitlab.rb` with `praefect['failover_election_strategy'] = 'per_repository'`. - 1. Run `gitlab-ctl reconfigure && gitlab-ctl start` to reconfigure and start the Praefects. + 1. Run `gitlab-ctl reconfigure && gitlab-ctl start` to reconfigure and start the Praefect nodes. - If downtime is unacceptable: |