2020-06-03 11:08:05 -04:00
---
2022-07-04 17:09:58 -04:00
stage: Systems
2020-06-03 11:08:05 -04:00
group: Gitaly
2022-09-21 17:13:33 -04:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-06-03 11:08:05 -04:00
---
2021-03-29 02:09:07 -04:00
# Gitaly and Gitaly Cluster **(FREE SELF)**
2017-03-17 07:19:38 -04:00
2021-03-22 23:09:04 -04:00
[Gitaly ](https://gitlab.com/gitlab-org/gitaly ) provides high-level RPC access to Git repositories.
It is used by GitLab to read and write Git data.
2017-03-17 07:19:38 -04:00
2021-09-21 08:11:06 -04:00
Gitaly is present in every GitLab installation and coordinates Git repository
storage and retrieval. Gitaly can be:
2022-02-22 01:16:10 -05:00
- A background service operating on a single instance Omnibus GitLab (all of
2021-09-21 08:11:06 -04:00
GitLab on one machine).
- Separated onto its own instance and configured in a full cluster configuration,
depending on scaling and availability requirements.
2021-03-22 23:09:04 -04:00
Gitaly implements a client-server architecture:
2020-05-28 23:08:11 -04:00
2021-03-22 23:09:04 -04:00
- A Gitaly server is any node that runs Gitaly itself.
2021-10-04 20:12:25 -04:00
- A Gitaly client is any node that runs a process that makes requests of the Gitaly server. Gitaly clients are also known as _Gitaly consumers_ and include:
- [GitLab Rails application ](https://gitlab.com/gitlab-org/gitlab )
- [GitLab Shell ](https://gitlab.com/gitlab-org/gitlab-shell )
- [GitLab Workhorse ](https://gitlab.com/gitlab-org/gitlab-workhorse )
- [GitLab Elasticsearch Indexer ](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer )
2020-06-03 11:08:05 -04:00
2021-07-07 08:08:23 -04:00
Gitaly manages only Git repository access for GitLab. Other types of GitLab data aren't accessed
using Gitaly.
GitLab accesses [repositories ](../../user/project/repository/index.md ) through the configured
[repository storages ](../repository_storage_paths.md ). Each new repository is stored on one of the
repository storages based on their
[configured weights ](../repository_storage_paths.md#configure-where-new-repositories-are-stored ). Each
repository storage is either:
- A Gitaly storage with direct access to repositories using [storage paths ](../repository_storage_paths.md ),
where each repository is stored on a single Gitaly node. All requests are routed to this node.
2021-07-20 08:10:29 -04:00
- A [virtual storage ](#virtual-storage ) provided by [Gitaly Cluster ](#gitaly-cluster ), where each
repository can be stored on multiple Gitaly nodes for fault tolerance. In a Gitaly Cluster:
2021-07-07 08:08:23 -04:00
- Read requests are distributed between multiple Gitaly nodes, which can improve performance.
- Write requests are broadcast to repository replicas.
2022-03-21 11:08:37 -04:00
## Before deploying Gitaly Cluster
2021-07-07 08:08:23 -04:00
2022-03-21 11:08:37 -04:00
Gitaly Cluster provides the benefits of fault tolerance, but comes with additional complexity of setup and management.
Before deploying Gitaly Cluster, please review:
2021-09-21 08:11:06 -04:00
2022-03-21 11:08:37 -04:00
- Existing [known issues ](#known-issues ).
2021-09-30 14:11:31 -04:00
- [Snapshot limitations ](#snapshot-backup-and-recovery-limitations ).
2022-03-21 11:08:37 -04:00
- [Configuration guidance ](configure_gitaly.md ) and [Repository storage options ](../repository_storage_paths.md ) to make
sure that Gitaly Cluster is the best setup for you.
2021-09-21 08:11:06 -04:00
2022-03-21 11:08:37 -04:00
If you have:
2021-09-21 08:11:06 -04:00
2022-03-21 11:08:37 -04:00
- Not yet migrated to Gitaly Cluster and want to continue using NFS, remain on the service you are using. NFS is
2022-04-18 20:08:51 -04:00
supported in 14.x releases but is [deprecated ](../../update/deprecations.md#nfs-for-git-repository-storage ).
2022-05-04 20:09:01 -04:00
Support for storing Git repository data on NFS is scheduled to end for all versions of GitLab on November 22, 2022.
2022-03-21 11:08:37 -04:00
- Not yet migrated to Gitaly Cluster but want to migrate away from NFS, you have two options:
- A sharded Gitaly instance.
- Gitaly Cluster.
2021-09-21 08:11:06 -04:00
2022-03-21 11:08:37 -04:00
Contact your Technical Account Manager or customer support if you have any questions.
2021-09-21 08:11:06 -04:00
2021-09-30 14:11:31 -04:00
### Known issues
The following table outlines current known issues impacting the use of Gitaly Cluster. For
the current status of these issues, please refer to the referenced issues and epics.
| Issue | Summary | How to avoid |
|:--------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------|
2022-08-17 05:11:44 -04:00
| Gitaly Cluster + Geo - Issues retrying failed syncs | If Gitaly Cluster is used on a Geo secondary site, repositories that have failed to sync could continue to fail when Geo tries to resync them. Recovering from this state requires assistance from support to run manual steps. | No known solution prior to GitLab 15.0. In GitLab 15.0 to 15.2, enable the [`gitaly_praefect_generated_replica_paths` feature flag ](#praefect-generated-replica-paths-gitlab-150-and-later ). In GitLab 15.3, the feature flag is enabled by default. |
2022-07-18 23:08:49 -04:00
| Praefect unable to insert data into the database due to migrations not being applied after an upgrade | If the database is not kept up to date with completed migrations, then the Praefect node is unable to perform normal operation. | Make sure the Praefect database is up and running with all migrations completed (For example: `/opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml sql-migrate-status` should show a list of all applied migrations). Consider [requesting upgrade assistance ](https://about.gitlab.com/support/scheduling-upgrade-assistance/ ) so your upgrade plan can be reviewed by support. |
2022-08-30 20:12:33 -04:00
| Restoring a Gitaly Cluster node from a snapshot in a running cluster | Because the Gitaly Cluster runs with consistent state, introducing a single node that is behind will result in the cluster not being able to reconcile the nodes data and other nodes data | Don't restore a single Gitaly Cluster node from a backup snapshot. If you must restore from backup, it's best to [shut down GitLab ](../read_only_gitlab.md#shut-down-the-gitlab-ui ), snapshot all Gitaly Cluster nodes at the same time and take a database dump of the Praefect database. |
2021-09-30 14:11:31 -04:00
### Snapshot backup and recovery limitations
2022-03-21 11:08:37 -04:00
Gitaly Cluster does not support snapshot backups. Snapshot backups can cause issues where the Praefect database becomes
out of sync with the disk storage. Because of how Praefect rebuilds the replication metadata of Gitaly disk information
during a restore, we recommend using the [official backup and restore Rake tasks ](../../raketasks/backup_restore.md ).
2021-09-30 14:11:31 -04:00
2022-08-16 02:10:05 -04:00
The [incremental backup method ](../../raketasks/backup_gitlab.md#incremental-repository-backups )
can be used to speed up Gitaly Cluster backups.
2022-03-21 11:08:37 -04:00
2022-08-16 02:10:05 -04:00
If you are unable to use either method, please contact customer support for restoration help.
2021-09-30 14:11:31 -04:00
### What to do if you are on Gitaly Cluster experiencing an issue or limitation
Please contact customer support for immediate help in restoration or recovery.
2021-09-21 08:11:06 -04:00
2022-08-15 02:12:42 -04:00
## Directly accessing repositories
GitLab doesn't advise directly accessing Gitaly repositories stored on disk with a Git client or any other tool,
because Gitaly is being continuously improved and changed. These improvements may invalidate
your assumptions, resulting in performance degradation, instability, and even data loss. For example:
- Gitaly has optimizations such as the [`info/refs` advertisement cache ](https://gitlab.com/gitlab-org/gitaly/blob/master/doc/design_diskcache.md ),
that rely on Gitaly controlling and monitoring access to repositories by using the official gRPC
interface.
- [Gitaly Cluster ](#gitaly-cluster ) has optimizations, such as fault tolerance and
[distributed reads ](#distributed-reads ), that depend on the gRPC interface and database
to determine repository state.
WARNING:
Accessing Git repositories directly is done at your own risk and is not supported.
2021-07-07 08:08:23 -04:00
## Gitaly
The following shows GitLab set up to use direct access to Gitaly:
In this example:
- Each repository is stored on one of three Gitaly storages: `storage-1` , `storage-2` , or
`storage-3` .
- Each storage is serviced by a Gitaly node.
- The three Gitaly nodes store data on their file systems.
### Gitaly architecture
2021-03-22 23:09:04 -04:00
The following illustrates the Gitaly client-server architecture:
```mermaid
flowchart TD
subgraph Gitaly clients
A[GitLab Rails]
B[GitLab Workhorse]
C[GitLab Shell]
D[...]
end
subgraph Gitaly
E[Git integration]
end
F[Local filesystem]
A -- gRPC --> Gitaly
B -- gRPC--> Gitaly
C -- gRPC --> Gitaly
D -- gRPC --> Gitaly
E --> F
```
2021-07-07 08:08:23 -04:00
### Configure Gitaly
2019-09-18 10:02:45 -04:00
2021-03-22 23:09:04 -04:00
Gitaly comes pre-configured with Omnibus GitLab, which is a configuration
[suitable for up to 1000 users ](../reference_architectures/1k_users.md ). For:
2019-09-18 10:02:45 -04:00
2021-03-22 23:09:04 -04:00
- Omnibus GitLab installations for up to 2000 users, see [specific Gitaly configuration instructions ](../reference_architectures/2k_users.md#configure-gitaly ).
2021-04-26 23:09:56 -04:00
- Source installations or custom Gitaly installations, see [Configure Gitaly ](configure_gitaly.md ).
2019-09-18 10:02:45 -04:00
2021-09-19 20:11:24 -04:00
GitLab installations for more than 2000 active users performing daily Git write operation may be
best suited by using Gitaly Cluster.
2021-04-08 23:09:05 -04:00
2022-08-15 02:12:42 -04:00
### Backing up repositories
When backing up or syncing repositories using tools other than GitLab, you must [prevent writes ](../../raketasks/backup_restore.md#prevent-writes-and-copy-the-git-repository-data )
while copying repository data.
2021-03-22 23:09:04 -04:00
## Gitaly Cluster
2017-03-17 07:19:38 -04:00
2021-07-07 08:08:23 -04:00
Git storage is provided through the Gitaly service in GitLab, and is essential to the operation of
GitLab. When the number of users, repositories, and activity grows, it is important to scale Gitaly
appropriately by:
- Increasing the available CPU and memory resources available to Git before
resource exhaustion degrades Git, Gitaly, and GitLab application performance.
- Increasing available storage before storage limits are reached causing write
operations to fail.
- Removing single points of failure to improve fault tolerance. Git should be
considered mission critical if a service degradation would prevent you from
deploying changes to production.
Gitaly can be run in a clustered configuration to:
- Scale the Gitaly service.
- Increase fault tolerance.
In this configuration, every Git repository can be stored on multiple Gitaly nodes in the cluster.
2021-03-29 02:09:07 -04:00
Using a Gitaly Cluster increases fault tolerance by:
- Replicating write operations to warm standby Gitaly nodes.
- Detecting Gitaly node failures.
- Automatically routing Git requests to an available Gitaly node.
NOTE:
Technical support for Gitaly clusters is limited to GitLab Premium and Ultimate
customers.
2021-07-07 08:08:23 -04:00
The following shows GitLab set up to access `storage-1` , a virtual storage provided by Gitaly
Cluster:
In this example:
- Repositories are stored on a virtual storage called `storage-1` .
- Three Gitaly nodes provide `storage-1` access: `gitaly-1` , `gitaly-2` , and `gitaly-3` .
- The three Gitaly nodes share data in three separate hashed storage locations.
2022-02-22 01:16:10 -05:00
- The [replication factor ](#replication-factor ) is `3` . Three copies are maintained
2021-07-07 08:08:23 -04:00
of each repository.
2021-09-19 20:11:24 -04:00
The availability objectives for Gitaly clusters assuming a single node failure are:
2021-03-29 02:09:07 -04:00
- **Recovery Point Objective (RPO):** Less than 1 minute.
Writes are replicated asynchronously. Any writes that have not been replicated
to the newly promoted primary are lost.
2021-11-21 22:13:57 -05:00
[Strong consistency ](#strong-consistency ) prevents loss in some circumstances.
2021-03-29 02:09:07 -04:00
- **Recovery Time Objective (RTO):** Less than 10 seconds.
Outages are detected by a health check run by each Praefect node every
second. Failover requires ten consecutive failed health checks on each
Praefect node.
2021-07-30 14:09:08 -04:00
Faster outage detection, to improve this speed to less than 1 second,
is tracked [in this issue ](https://gitlab.com/gitlab-org/gitaly/-/issues/2608 ).
2021-03-29 02:09:07 -04:00
2021-09-19 20:11:24 -04:00
WARNING:
If complete cluster failure occurs, disaster recovery plans should be executed. These can affect the
RPO and RTO discussed above.
2022-05-26 05:08:11 -04:00
### Comparison to Geo
Gitaly Cluster and [Geo ](../geo/index.md ) both provide redundancy. However the redundancy of:
- Gitaly Cluster provides fault tolerance for data storage and is invisible to the user. Users are
not aware when Gitaly Cluster is used.
- Geo provides [replication ](../geo/index.md ) and [disaster recovery ](../geo/disaster_recovery/index.md ) for
an entire instance of GitLab. Users know when they are using Geo for
[replication ](../geo/index.md ). Geo [replicates multiple data types ](../geo/replication/datatypes.md#limitations-on-replicationverification ),
including Git data.
The following table outlines the major differences between Gitaly Cluster and Geo:
| Tool | Nodes | Locations | Latency tolerance | Failover | Consistency | Provides redundancy for |
|:---------------|:---------|:----------|:------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------|:--------------------------------------|:------------------------|
| Gitaly Cluster | Multiple | Single | [Less than 1 second, ideally single-digit milliseconds ](praefect.md#network-latency-and-connectivity ) | [Automatic ](praefect.md#automatic-failover-and-primary-election-strategies ) | [Strong ](index.md#strong-consistency ) | Data storage in Git |
| Geo | Multiple | Multiple | Up to one minute | [Manual ](../geo/disaster_recovery/index.md ) | Eventual | Entire GitLab instance |
For more information, see:
- Geo [use cases ](../geo/index.md#use-cases ).
- Geo [architecture ](../geo/index.md#architecture ).
2021-07-20 08:10:29 -04:00
### Virtual storage
Virtual storage makes it viable to have a single repository storage in GitLab to simplify repository
management.
2021-03-29 02:09:07 -04:00
2021-07-20 08:10:29 -04:00
Virtual storage with Gitaly Cluster can usually replace direct Gitaly storage configurations.
However, this is at the expense of additional storage space needed to store each repository on multiple
Gitaly nodes. The benefit of using Gitaly Cluster virtual storage over direct Gitaly storage is:
2021-03-29 02:09:07 -04:00
2021-07-20 08:10:29 -04:00
- Improved fault tolerance, because each Gitaly node has a copy of every repository.
- Improved resource utilization, reducing the need for over-provisioning for shard-specific peak
loads, because read loads are distributed across Gitaly nodes.
- Manual rebalancing for performance is not required, because read loads are distributed across
Gitaly nodes.
- Simpler management, because all Gitaly nodes are identical.
The number of repository replicas can be configured using a
[replication factor ](#replication-factor ).
It can
be uneconomical to have the same replication factor for all repositories.
2021-07-30 14:09:08 -04:00
To provide greater flexibility for extremely large GitLab instances,
variable replication factor is tracked in [this issue ](https://gitlab.com/groups/gitlab-org/-/epics/3372 ).
2021-07-20 08:10:29 -04:00
As with normal Gitaly storages, virtual storages can be sharded.
2021-03-29 02:09:07 -04:00
2022-05-12 23:08:13 -04:00
### Storage layout
WARNING:
The storage layout is an internal detail of Gitaly Cluster and is not guaranteed to remain stable between releases.
The information here is only for informational purposes and to help with debugging. Performing changes in the
repositories directly on the disk is not supported and may lead to breakage or the changes being overwritten.
Gitaly Cluster's virtual storages provide an abstraction that looks like a single storage but actually consists of
multiple physical storages. Gitaly Cluster has to replicate each operation to each physical storage. Operations
may succeed on some of the physical storages but fail on others.
Partially applied operations can cause problems with other operations and leave the system in a state it can't recover from.
To avoid these types of problems, each operation should either fully apply or not apply at all. This property of operations is called
[atomicity ](https://en.wikipedia.org/wiki/Atomicity_(database_systems )).
GitLab controls the storage layout on the repository storages. GitLab instructs the repository storage where to create,
delete, and move repositories. These operations create atomicity issues when they are being applied to multiple physical storages.
For example:
- GitLab deletes a repository while one of its replicas is unavailable.
- GitLab later recreates the repository.
As a result, the stale replica that was unavailable at the time of deletion may cause conflicts and prevent
recreation of the repository.
These atomicity issues have caused multiple problems in the past with:
- Geo syncing to a secondary site with Gitaly Cluster.
- Backup restoration.
- Repository moves between repository storages.
Gitaly Cluster provides atomicity for these operations by storing repositories on the disk in a special layout that prevents
conflicts that could occur due to partially applied operations.
#### Client-generated replica paths
Repositories are stored in the storages at the relative path determined by the [Gitaly client ](#gitaly-architecture ). These paths can be
identified by them not beginning with the `@cluster` prefix. The relative paths
follow the [hashed storage ](../repository_storage_types.md#hashed-storage ) schema.
#### Praefect-generated replica paths (GitLab 15.0 and later)
2022-08-12 05:11:48 -04:00
> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4218) in GitLab 15.0 [with a flag](../feature_flags.md) named `gitaly_praefect_generated_replica_paths`. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitaly/-/issues/4218) in GitLab 15.2.
> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4809) in GitLab 15.3.
2022-05-12 23:08:13 -04:00
FLAG:
2022-08-12 05:11:48 -04:00
On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag ](../feature_flags.md ) named `gitaly_praefect_generated_replica_paths` . On GitLab.com, this feature is available but can be configured by GitLab.com administrators only.
2022-05-12 23:08:13 -04:00
When Gitaly Cluster creates a repository, it assigns the repository a unique and permanent ID called the _repository ID_ . The repository ID is
internal to Gitaly Cluster and doesn't relate to any IDs elsewhere in GitLab. If a repository is removed from Gitaly Cluster and later moved
back, the repository is assigned a new repository ID and is a different repository from Gitaly Cluster's perspective. The sequence of repository IDs
always increases, but there may be gaps in the sequence.
The repository ID is used to derive a unique storage path called _replica path_ for each repository on the cluster. The replicas of
a repository are all stored at the same replica path on the storages. The replica path is distinct from the _relative path_ :
- The relative path is a name the Gitaly client uses to identify a repository, together with its virtual storage, that is unique to them.
- The replica path is the actual physical path in the physical storages.
Praefect translates the repositories in the RPCs from the virtual `(virtual storage, relative path)` identifier into physical repository
`(storage, replica_path)` identifier when handling the client requests.
The format of the replica path for:
- Object pools is `@cluster/pools/<xx>/<xx>/<repository ID>` . Object pools are stored in a different directory than other repositories.
They must be identifiable by Gitaly to avoid pruning them as part of housekeeping. Pruning object pools can cause data loss in the linked
repositories.
- Other repositories is `@cluster/repositories/<xx>/<xx>/<repository ID>`
For example, `@cluster/repositories/6f/96/54771` .
The last component of the replica path, `54771` , is the repository ID. This can be used to identify the repository on the disk.
`<xx>/<xx>` are the first four hex digits of the SHA256 hash of the string representation of the repository ID. This is used to balance
the repositories evenly into subdirectories to avoid overly large directories that might cause problems on some file
systems. In this case, `54771` hashes to `6f960ab01689464e768366d3315b3d3b2c28f38761a58a70110554eb04d582f7` so the
first four digits are `6f` and `96` .
#### Identify repositories on disk
Use the [`praefect metadata` ](troubleshooting.md#view-repository-metadata ) subcommand to:
- Retrieve a repository's virtual storage and relative path from the metadata store. After you have the hashed storage path, you can use the Rails
console to retrieve the project path.
- Find where a repository is stored in the cluster with either:
- The virtual storage and relative path.
- The repository ID.
2022-05-22 20:08:37 -04:00
The repository on disk also contains the project path in the Git configuration file. The configuration
file can be used to determine the project path even if the repository's metadata has been deleted.
Follow the [instructions in hashed storage's documentation ](../repository_storage_types.md#from-hashed-path-to-project-name ).
2022-05-12 23:08:13 -04:00
#### Atomicity of operations
Gitaly Cluster uses the PostgreSQL metadata store with the storage layout to ensure atomicity of repository creation,
deletion, and move operations. The disk operations can't be atomically applied across multiple storages. However, PostgreSQL guarantees
the atomicity of the metadata operations. Gitaly Cluster models the operations in a manner that the failing operations always leave
the metadata consistent. The disks may contain stale state even after successful operations. This is expected and the leftover state
2022-05-20 11:09:10 -04:00
won't interfere with future operations but may use up disk space unnecessarily until a clean up is performed.
2022-05-12 23:08:13 -04:00
There is on-going work on a [background crawler ](https://gitlab.com/gitlab-org/gitaly/-/issues/3719 ) that cleans up the leftover
repositories from the storages.
##### Repository creations
When creating repositories, Praefect:
1. Reserves a repository ID from PostgreSQL. This is atomic and no two creations receive the same ID.
1. Creates replicas on the Gitaly storages in the replica path derived from the repository ID.
1. Creates metadata records after the repository is successfully created on disk.
Even if two concurrent operations create the same repository, they'd be stored in different directories on the storages and not
conflict. The first to complete creates the metadata record and the other operation fails with an "already exists" error.
The failing creation leaves leftover repositories on the storages. There is on-going work on a
[background crawler ](https://gitlab.com/gitlab-org/gitaly/-/issues/3719 ) that clean up the leftover repositories from the storages.
The repository IDs are generated from the `repositories_repository_id_seq` in PostgreSQL. In the above example, the failing operation took
one repository ID without successfully creating a repository with it. Failed repository creations are expected lead to gaps in the repository IDs.
##### Repository deletions
A repository is deleted by removing its metadata record. The repository ceases to logically exist as soon as the metadata record is deleted.
PostgreSQL guarantees the atomicity of the removal and a concurrent delete fails with a "not found" error. After successfully deleting
the metadata record, Praefect attempts to remove the replicas from the storages. This may fail and leave leftover state in the storages.
The leftover state is eventually cleaned up.
##### Repository moves
Unlike Gitaly, Gitaly Cluster doesn't move the repositories in the storages but only virtually moves the repository by updating the
relative path of the repository in the metadata store.
2021-03-29 02:09:07 -04:00
### Moving beyond NFS
2022-05-03 23:08:09 -04:00
Engineering support for NFS for Git repositories is deprecated. Technical support is planned to be unavailable starting
2022-06-09 05:09:12 -04:00
November 22, 2022. Please see our [statement of support ](https://about.gitlab.com/support/statement-of-support/#gitaly-and-nfs )
2022-05-03 23:08:09 -04:00
for more details.
2021-03-29 02:09:07 -04:00
[Network File System (NFS) ](https://en.wikipedia.org/wiki/Network_File_System )
is not well suited to Git workloads which are CPU and IOPS sensitive.
Specifically:
2022-02-22 01:16:10 -05:00
- Git is sensitive to file system latency. Some operations require many
2021-03-29 02:09:07 -04:00
read operations. Operations that are fast on block storage can become an order of
magnitude slower. This significantly impacts GitLab application performance.
- NFS performance optimizations that prevent the performance gap between
block storage and NFS being even wider are vulnerable to race conditions. We have observed
[data inconsistencies ](https://gitlab.com/gitlab-org/gitaly/-/issues/2589 )
in production environments caused by simultaneous writes to different NFS
clients. Data corruption is not an acceptable risk.
Gitaly Cluster is purpose built to provide reliable, high performance, fault
tolerant Git storage.
Further reading:
- Blog post: [The road to Gitaly v1.0 (aka, why GitLab doesn't require NFS for storing Git data anymore) ](https://about.gitlab.com/blog/2018/09/12/the-road-to-gitaly-1-0/ )
- Blog post: [How we spent two weeks hunting an NFS bug in the Linux kernel ](https://about.gitlab.com/blog/2018/11/14/how-we-spent-two-weeks-hunting-an-nfs-bug/ )
2021-07-20 08:10:29 -04:00
### Components
2021-03-29 02:09:07 -04:00
Gitaly Cluster consists of multiple components:
- [Load balancer ](praefect.md#load-balancer ) for distributing requests and providing fault-tolerant access to
Praefect nodes.
- [Praefect ](praefect.md#praefect ) nodes for managing the cluster and routing requests to Gitaly nodes.
2021-07-07 08:08:23 -04:00
- [PostgreSQL database ](praefect.md#postgresql ) for persisting cluster metadata and [PgBouncer ](praefect.md#use-pgbouncer ),
2021-03-29 02:09:07 -04:00
recommended for pooling Praefect's database connections.
- Gitaly nodes to provide repository storage and Git access.
### Architecture
Praefect is a router and transaction manager for Gitaly, and a required
component for running a Gitaly Cluster.
For more information, see [Gitaly High Availability (HA) Design ](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/design_ha.md ).
2021-07-20 08:10:29 -04:00
### Features
Gitaly Cluster provides the following features:
- [Distributed reads ](#distributed-reads ) among Gitaly nodes.
- [Strong consistency ](#strong-consistency ) of the secondary replicas.
- [Replication factor ](#replication-factor ) of repositories for increased redundancy.
- [Automatic failover ](praefect.md#automatic-failover-and-primary-election-strategies ) from the
primary Gitaly node to secondary Gitaly nodes.
2021-12-07 07:10:33 -05:00
- Reporting of possible [data loss ](recovery.md#check-for-data-loss ) if replication queue isn't empty.
2021-07-20 08:10:29 -04:00
Follow the [Gitaly Cluster epic ](https://gitlab.com/groups/gitlab-org/-/epics/1489 ) for improvements
including [horizontally distributing reads ](https://gitlab.com/groups/gitlab-org/-/epics/2013 ).
#### Distributed reads
2022-02-03 10:12:41 -05:00
> - Introduced in GitLab 13.1 in [beta](../../policy/alpha-beta-support.md#beta-features) with feature flag `gitaly_distributed_reads` set to disabled.
2021-07-20 08:10:29 -04:00
> - [Made generally available and enabled by default](https://gitlab.com/gitlab-org/gitaly/-/issues/2951) in GitLab 13.3.
> - [Disabled by default](https://gitlab.com/gitlab-org/gitaly/-/issues/3178) in GitLab 13.5.
> - [Enabled by default](https://gitlab.com/gitlab-org/gitaly/-/issues/3334) in GitLab 13.8.
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitaly/-/issues/3383) in GitLab 13.11.
Gitaly Cluster supports distribution of read operations across Gitaly nodes that are configured for
the [virtual storage ](#virtual-storage ).
All RPCs marked with the `ACCESSOR` option are redirected to an up to date and healthy Gitaly node.
For example, [`GetBlob` ](https://gitlab.com/gitlab-org/gitaly/-/blob/v12.10.6/proto/blob.proto#L16 ).
_Up to date_ in this context means that:
- There is no replication operations scheduled for this Gitaly node.
- The last replication operation is in _completed_ state.
The primary node is chosen to serve the request if:
- There are no up to date nodes.
- Any other error occurs during node selection.
2022-05-05 02:08:22 -04:00
You can [monitor distribution of reads ](monitoring.md#monitor-gitaly-cluster ) using Prometheus.
2021-07-20 08:10:29 -04:00
#### Strong consistency
2022-02-03 10:12:41 -05:00
> - Introduced in GitLab 13.1 in [alpha](../../policy/alpha-beta-support.md#alpha-features), disabled by default.
> - Entered [beta](../../policy/alpha-beta-support.md#beta-features) in GitLab 13.2, disabled by default.
2021-07-20 08:10:29 -04:00
> - In GitLab 13.3, disabled unless primary-wins voting strategy is disabled.
> - From GitLab 13.4, enabled by default.
> - From GitLab 13.5, you must use Git v2.28.0 or higher on Gitaly nodes to enable strong consistency.
2021-11-21 22:13:57 -05:00
> - From GitLab 13.6, primary-wins voting strategy and the `gitaly_reference_transactions_primary_wins` feature flag was removed.
> - From GitLab 14.0, [Gitaly Cluster only supports strong consistency](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/3575), and the `gitaly_reference_transactions` feature flag was removed.
2021-07-20 08:10:29 -04:00
2021-11-24 01:12:53 -05:00
Gitaly Cluster provides strong consistency by writing changes synchronously to all healthy, up-to-date replicas. If a
replica is outdated or unhealthy at the time of the transaction, the write is asynchronously replicated to it.
2021-07-20 08:10:29 -04:00
2021-11-24 01:12:53 -05:00
If strong consistency is unavailable, Gitaly Cluster guarantees eventual consistency. In this case. Gitaly Cluster
replicates all writes to secondary Gitaly nodes after the write to the primary Gitaly node has occurred.
2021-07-20 08:10:29 -04:00
2021-11-24 01:12:53 -05:00
Strong consistency:
- Is the primary replication method in GitLab 14.0 and later. A subset of operations still use replication jobs
(eventual consistency) instead of strong consistency. Refer to the
[strong consistency epic ](https://gitlab.com/groups/gitlab-org/-/epics/1189 ) for more information.
- Must be configured in GitLab versions 13.1 to 13.12. For configuration information, refer to either:
- Documentation on your GitLab instance at `/help` .
- The [13.12 documentation ](https://docs.gitlab.com/13.12/ee/administration/gitaly/praefect.html#strong-consistency ).
- Is unavailable in GitLab 13.0 and earlier.
2022-05-05 02:08:22 -04:00
For more information on monitoring strong consistency, see the Gitaly Cluster [Prometheus metrics documentation ](monitoring.md#monitor-gitaly-cluster ).
2021-07-20 08:10:29 -04:00
#### Replication factor
Replication factor is the number of copies Gitaly Cluster maintains of a given repository. A higher
replication factor:
- Offers better redundancy and distribution of read workload.
- Results in higher storage cost.
By default, Gitaly Cluster replicates repositories to every storage in a
[virtual storage ](#virtual-storage ).
For configuration information, see [Configure replication factor ](praefect.md#configure-replication-factor ).
2021-03-29 02:09:07 -04:00
### Configure Gitaly Cluster
For more information on configuring Gitaly Cluster, see [Configure Gitaly Cluster ](praefect.md ).
2019-09-24 11:06:34 -04:00
2022-06-10 14:09:28 -04:00
### Upgrade Gitaly Cluster
To upgrade a Gitaly Cluster, follow the documentation for
[zero downtime upgrades ](../../update/zero_downtime.md#gitaly-or-gitaly-cluster ).
2022-07-07 20:09:36 -04:00
### Downgrade Gitaly Cluster to a previous version
2022-07-21 11:09:12 -04:00
If you need to roll back a Gitaly Cluster to an earlier version, some Praefect database migrations may need to be reverted.
2022-07-07 20:09:36 -04:00
2022-07-21 11:09:12 -04:00
To downgrade a Gitaly Cluster (assuming multiple Praefect nodes):
2022-07-07 20:09:36 -04:00
1. Stop the Praefect service on all Praefect nodes:
```shell
gitlab-ctl stop praefect
```
1. Downgrade the GitLab package to the older version on one of the Praefect nodes.
1. On the downgraded node, check the state of Praefect migrations:
```shell
/opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml sql-migrate-status
```
1. Count the number of migrations with `unknown migration` in the `APPLIED` column.
1. On a Praefect node that has **not** been downgraded, perform a dry run of the rollback to validate which migrations to revert. `<CT_UNKNOWN>`
is the number of unknown migrations reported by the downgraded node.
```shell
/opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml sql-migrate < CT_UNKNOWN >
```
1. If the results look correct, run the same command with the `-f` option to revert the migrations:
```shell
/opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml sql-migrate -f < CT_UNKNOWN >
```
1. Downgrade the GitLab package on the remaining Praefect nodes and start the Praefect service again:
```shell
gitlab-ctl start praefect
```
2022-08-15 02:12:42 -04:00
### Migrate to Gitaly Cluster
2021-09-19 20:11:24 -04:00
2022-06-15 05:09:28 -04:00
WARNING:
Some [known issues ](#known-issues ) exist in Gitaly Cluster. Review the following information before you continue.
Before migrating to Gitaly Cluster:
- Review [Before deploying Gitaly Cluster ](#before-deploying-gitaly-cluster ).
- Upgrade to the latest possible version of GitLab, to take advantage of improvements and bug fixes.
To migrate to Gitaly Cluster:
2021-08-16 02:09:08 -04:00
1. Create the required storage. Refer to
2022-05-26 05:08:11 -04:00
[repository storage recommendations ](praefect.md#repository-storage-recommendations ).
2022-09-15 14:10:36 -04:00
1. Create and configure [Gitaly Cluster ](praefect.md ).
2022-09-01 20:11:46 -04:00
1. Configure the existing Gitaly instance [to use TPC ](praefect.md#use-tcp-for-existing-gitlab-instances ), if not already configured that way.
2021-08-16 02:09:08 -04:00
1. [Move the repositories ](../operations/moving_repositories.md#move-repositories ). To migrate to
Gitaly Cluster, existing repositories stored outside Gitaly Cluster must be moved. There is no
automatic migration but the moves can be scheduled with the GitLab API.
2022-06-15 05:09:28 -04:00
Even if you don't use the `default` repository storage, you must ensure it is configured.
2021-11-21 22:13:57 -05:00
[Read more about this limitation ](configure_gitaly.md#gitlab-requires-a-default-repository-storage ).
2022-08-15 02:12:42 -04:00
### Migrate off Gitaly Cluster
2021-09-28 11:11:30 -04:00
2022-03-21 11:08:37 -04:00
If the limitations and tradeoffs of Gitaly Cluster are found to be not suitable for your environment, you can Migrate
off Gitaly Cluster to a sharded Gitaly instance:
2021-09-28 11:11:30 -04:00
2022-03-21 11:08:37 -04:00
1. Create and configure a new [Gitaly server ](configure_gitaly.md#run-gitaly-on-its-own-server ).
1. [Move the repositories ](../operations/moving_repositories.md#move-repositories ) to the newly created storage. You can
move them by shard or by group, which gives you the opportunity to spread them over multiple Gitaly servers.
2021-09-28 11:11:30 -04:00
2020-07-01 11:08:45 -04:00
## Direct access to Git in GitLab
2019-12-17 07:08:11 -05:00
2020-07-01 11:08:45 -04:00
Direct access to Git uses code in GitLab known as the "Rugged patches".
2019-12-17 07:08:11 -05:00
2021-03-22 23:09:04 -04:00
Before Gitaly existed, what are now Gitaly clients accessed Git repositories directly, either:
2019-12-17 07:08:11 -05:00
2021-03-22 23:09:04 -04:00
- On a local disk in the case of a single-machine Omnibus GitLab installation.
2020-07-01 11:08:45 -04:00
- Using NFS in the case of a horizontally-scaled GitLab installation.
2021-03-22 23:09:04 -04:00
In addition to running plain `git` commands, GitLab used a Ruby library called
2019-12-17 07:08:11 -05:00
[Rugged ](https://github.com/libgit2/rugged ). Rugged is a wrapper around
2020-07-01 11:08:45 -04:00
[libgit2 ](https://libgit2.org/ ), a stand-alone implementation of Git in the form of a C library.
Over time it became clear that Rugged, particularly in combination with
[Unicorn ](https://yhbt.net/unicorn/ ), is extremely efficient. Because `libgit2` is a library and
not an external process, there was very little overhead between:
- GitLab application code that tried to look up data in Git repositories.
- The Git implementation itself.
2021-03-22 23:09:04 -04:00
Because the combination of Rugged and Unicorn was so efficient, the GitLab application code ended up
with lots of duplicate Git object lookups. For example, looking up the default branch commit a dozen
times in one request. We could write inefficient code without poor performance.
2020-07-01 11:08:45 -04:00
When we migrated these Git lookups to Gitaly calls, we suddenly had a much higher fixed cost per Git
lookup. Even when Gitaly is able to re-use an already-running `git` process (for example, to look up
a commit), you still have:
- The cost of a network roundtrip to Gitaly.
2021-01-27 19:09:33 -05:00
- Inside Gitaly, a write/read roundtrip on the Unix pipes that connect Gitaly to the `git` process.
2020-07-01 11:08:45 -04:00
Using GitLab.com to measure, we reduced the number of Gitaly calls per request until the loss of
Rugged's efficiency was no longer felt. It also helped that we run Gitaly itself directly on the Git
2021-03-22 23:09:04 -04:00
file servers, rather than by using NFS mounts. This gave us a speed boost that counteracted the
negative effect of not using Rugged anymore.
2020-07-01 11:08:45 -04:00
Unfortunately, other deployments of GitLab could not remove NFS like we did on GitLab.com, and they
got the worst of both worlds:
- The slowness of NFS.
- The increased inherent overhead of Gitaly.
The code removed from GitLab during the Gitaly migration project affected these deployments. As a
performance workaround for these NFS-based deployments, we re-introduced some of the old Rugged
code. This re-introduced code is informally referred to as the "Rugged patches".
2022-08-18 23:12:19 -04:00
### Automatic detection
> Automatic detection for Rugged [disabled](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95445) in GitLab 15.3.
FLAG:
On self-managed GitLab, by default automatic detection of whether Rugged should be used (per storage) is not available.
To make it available, ask an administrator to [disable the feature flag ](../../administration/feature_flags.md ) named
`skip_rugged_auto_detect` .
2020-07-01 11:08:45 -04:00
The Ruby methods that perform direct Git access are behind
[feature flags ](../../development/gitaly.md#legacy-rugged-code ), disabled by default. It wasn't
convenient to set feature flags to get the best performance, so we added an automatic mechanism that
enables direct Git access.
When GitLab calls a function that has a "Rugged patch", it performs two checks:
- Is the feature flag for this patch set in the database? If so, the feature flag setting controls
2020-12-15 22:09:46 -05:00
the GitLab use of "Rugged patch" code.
2021-01-18 01:10:43 -05:00
- If the feature flag is not set, GitLab tries accessing the file system underneath the
2020-11-18 10:09:08 -05:00
Gitaly server directly. If it can, it uses the "Rugged patch":
2020-09-07 23:08:31 -04:00
- If using Puma and [thread count ](../../install/requirements.md#puma-threads ) is set
to `1` .
2020-07-01 11:08:45 -04:00
2020-09-07 23:08:31 -04:00
The result of these checks is cached.
2020-07-01 11:08:45 -04:00
2021-01-18 01:10:43 -05:00
To see if GitLab can access the repository file system directly, we use the following heuristic:
2020-07-01 11:08:45 -04:00
2021-01-18 01:10:43 -05:00
- Gitaly ensures that the file system has a metadata file in its root with a UUID in it.
2021-01-27 19:09:33 -05:00
- Gitaly reports this UUID to GitLab by using the `ServerInfo` RPC.
2020-07-01 11:08:45 -04:00
- GitLab Rails tries to read the metadata file directly. If it exists, and if the UUID's match,
assume we have direct access.
2022-08-18 23:12:19 -04:00
Direct Git access is:
2022-08-16 14:12:52 -04:00
2022-08-18 23:12:19 -04:00
- [Disabled ](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95445 ) by default in GitLab 15.3 and later for
compatibility with [Praefect-generated replica paths ](#praefect-generated-replica-paths-gitlab-150-and-later ). It
can be enabled if Rugged [feature flags ](../../development/gitaly.md#legacy-rugged-code ) are enabled.
- Enabled by default in GitLab 15.2 and earlier because it fills in the correct repository paths in the GitLab
configuration file `config/gitlab.yml` . This satisfies the UUID check.
2020-07-01 11:08:45 -04:00
### Transition to Gitaly Cluster
For the sake of removing complexity, we must remove direct Git access in GitLab. However, we can't
remove it as long some GitLab installations require Git repositories on NFS.
There are two facets to our efforts to remove direct Git access in GitLab:
- Reduce the number of inefficient Gitaly queries made by GitLab.
- Persuade administrators of fault-tolerant or horizontally-scaled GitLab instances to migrate off
NFS.
The second facet presents the only real solution. For this, we developed
2021-03-29 02:09:07 -04:00
[Gitaly Cluster ](#gitaly-cluster ).
2019-12-17 07:08:11 -05:00
2021-03-22 20:09:09 -04:00
## NFS deprecation notice
2021-06-20 23:10:27 -04:00
Engineering support for NFS for Git repositories is deprecated. Technical support is planned to be
2022-05-04 20:09:01 -04:00
unavailable beginning November 22, 2022. For further information, please see our [NFS Deprecation ](../nfs.md#gitaly-and-nfs-deprecation ) documentation.
