| type | stage | group | info |
|---|---|---|---|
reference, concepts |
Systems |
Distribution |
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 |
The GitLab Reference Architectures have been designed and tested by the GitLab Quality and Support teams to provide recommended deployments at scale.
Depending on your workflow, the following recommended reference architectures may need to be adapted accordingly. Your workload is influenced by factors including how active your users are, how much automation you use, mirroring, and repository/change size. Additionally, the displayed memory values are provided by GCP machine types. For different cloud vendors, attempt to select options that best match the provided architecture.
The following reference architectures, where the GitLab package is used, are available:
- Up to 1,000 users
- Up to 2,000 users
- Up to 3,000 users
- Up to 5,000 users
- Up to 10,000 users
- Up to 25,000 users
- Up to 50,000 users
The following Cloud Native Hybrid reference architectures, where select recommended components can be run in Kubernetes, are available:
- Up to 2,000 users
- Up to 3,000 users
- Up to 5,000 users
- Up to 10,000 users
- Up to 25,000 users
- Up to 50,000 users
The first choice to consider is whether a Self Managed approach is correct for you and your requirements.
Running any application in production is complex, and the same applies for GitLab. While we aim to make this as smooth as possible, there are still the general complexities. This depends on the design chosen, but typically you'll need to manage all aspects such as hardware, operating systems, networking, storage, security, GitLab itself, and more. This includes both the initial setup of the environment and the longer term maintenance.
As such, it's recommended that you have a working knowledge of running and maintaining applications in production when deciding on going down this route. If you aren't in this position, our Professional Services team offers implementation services, but for those who want a more managed solution long term, it's recommended to instead explore our other offerings such as GitLab SaaS or GitLab Dedicated.
The Reference Architectures are designed to strike a balance between two important factors--performance and resilience.
While they are designed to make it easier to set up GitLab at scale, it can still be a challenge to know which one meets your requirements.
As a general guide, the more performant and/or resilient you want your environment to be, the more complex it is.
This section explains the designs you can choose from. It begins with the least complexity, goes to the most, and ends with a decision tree.
For environments serving 2,000 or fewer users, we generally recommend a standalone approach by deploying a non-highly available single or multi-node environment. With this approach, you can employ strategies such as automated backups for recovery to provide a good level of RPO / RTO while avoiding the complexities that come with HA.
*[RTO]: Recovery time objective *[RPO]: Recovery point objective
With standalone setups, especially single node environments, there are various options available for installation and management including the ability to deploy directly via select cloud provider marketplaces that reduce the complexity a little further.
High Availability ensures every component in the GitLab setup can handle failures through various mechanisms. However, to achieve this is complex and the environments required can be sizable.
For environments serving 3,000 or more users we generally recommend that a HA strategy is used as at this level outages have a bigger impact against more users. All the architectures in this range have HA built in by design for this reason.
As mentioned above, achieving HA does come at a cost. The environment requirements are sizable as each component needs to be multiplied, which comes with additional actual and maintenance costs.
For a lot of our customers with fewer than 3,000 users, we've found a backup strategy is sufficient and even preferable. While this does have a slower recovery time, it also means you have a much smaller architecture and less maintenance costs as a result.
In general then, we'd only recommend you employ HA in the following scenarios:
- When you have 3,000 or more users.
- When GitLab being down would critically impact your workflow.
If you still need to have HA for a lower number of users, this can be achieved with an adjusted 3K architecture.
Zero Downtime Upgrades are available for standard Reference Architecture environments with HA (Cloud Native Hybrid is not supported). This allows for an environment to stay up during an upgrade, but the process is more complex as a result and has some limitations as detailed in the documentation.
When going through this process it's worth noting that there may still be brief moments of downtime when the HA mechanisms take effect.
In most cases the downtime required for doing an upgrade shouldn't be substantial, so this is only recommended if it's a key requirement for you.
As an additional layer of HA resilience you can deploy select components in Kubernetes, known as a Cloud Native Hybrid Reference Architecture.
This is an alternative and more advanced setup compared to a standard Reference Architecture. Running services in Kubernetes is well known to be complex. This setup is only recommended if you have strong working knowledge and experience in Kubernetes.
With GitLab Geo you can have both distributed environments in different regions and a full Disaster Recovery (DR) setup in place. With this setup you would have 2 or more separate environments, with one being a primary that gets replicated to the others. In the rare event the primary site went down completely you could fail over to one of the other environments.
This is an advanced and complex setup and should only be undertaken if you have DR as a key requirement. Decisions then on how each environment are configured would also need to be taken, such as if each environment itself would be the full size and / or have HA.
For all the previously described strategies, you can run select GitLab components on equivalent cloud provider services such as the PostgreSQL database or Redis.
For more information, see the recommended cloud providers and services.
Below you can find the above guidance in the form of a decision tree. It's recommended you read through the above guidance in full first before though.
%%{init: { 'theme': 'base' } }%%
graph TD
L1A(<b>What Reference Architecture should I use?</b>)
L2A(3,000 users or more?)
L2B(2,000 users or less?)
L3A("<a href=#do-you-need-high-availability-ha>Do you need HA?</a><br>(or Zero-Downtime Upgrades)")
L3B[Do you have experience with<br/>and want additional resilience<br/>with select components in Kubernetes?]
L4A><b>Recommendation</b><br><br>3K architecture with HA<br>and supported reductions]
L4B><b>Recommendation</b><br><br>Architecture closest to user<br>count with HA]
L4C><b>Recommendation</b><br><br>Cloud Native Hybrid architecture<br>closest to user count]
L4D>"<b>Recommendation</b><br><br>Standalone 1K or 2K<br/>architecture with Backups"]
L1A --> L2A
L1A --> L2B
L2A -->|Yes| L3B
L3B -->|Yes| L4C
L3B -->|No| L4B
L2B --> L3A
L3A -->|Yes| L4A
L3A -->|No| L4D
L5A("<a href=#gitlab-geo-cross-regional-distribution-disaster--recovery>Do you need cross regional distribution or disaster recovery?"</a>) --> |Yes| L6A><b>Additional Recommendation</b><br><br> GitLab Geo]
L4A -.- L5A
L4B -.- L5A
L4C -.- L5A
L4D -.- L5A
classDef default fill:#FCA326
linkStyle default fill:none,stroke:#7759C2
Before implementing a reference architecture, refer to the following requirements and guidance.
These reference architectures were built and tested on Google Cloud Platform (GCP) using the Intel Xeon E5 v3 (Haswell) CPU platform as a lowest common denominator baseline (Sysbench benchmark).
Newer, similarly-sized CPUs are supported and may have improved performance as a result. For Linux package environments, ARM-based equivalents are also supported.
NOTE: Any "burstable" instance types are not recommended due to inconsistent performance.
As a general guidance, GitLab should run on most infrastructure such as reputable Cloud Providers (AWS, GCP, Azure) and their services, or self managed (ESXi) that meet both:
- The specifications detailed in each reference architecture.
- Any requirements in this section.
However, this does not constitute a guarantee for every potential permutation.
See Recommended cloud providers and services for more information.
These reference architectures have been designed and tested for standard GitLab setups with good headroom in mind to cover most scenarios.
However, additional workloads can multiply the impact of operations by triggering follow-up actions. You may need to adjust the suggested specifications to compensate if you use, for example:
- Security software on the nodes.
- Hundreds of concurrent CI jobs for large repositories.
- Custom scripts that run at high frequency.
- Integrations in many large projects.
- Server hooks.
- System hooks.
As a general rule, you should have robust monitoring in place to measure the impact of any additional workloads to inform any changes needed to be made.
Swap is not recommended in the reference architectures. It's a failsafe that impacts performance greatly. The reference architectures are designed to have memory headroom to avoid needing swap.
The relevant reference architectures were tested with repositories of varying sizes that follow best practices.
However, large repositories or monorepos (several gigabytes or more) can significantly impact the performance of Git and in turn the environment itself if best practices aren't being followed such as not storing binary or blob files in LFS.
Repositories are at the core of any environment and the consequences can be wide-ranging when they are not optimized. Some examples of this impact include:
- Git packing operations taking longer and consuming high CPU and memory resources.
- Git checkouts taking longer that affect both users and CI/CD pipelines alike.
As such, large repositories come with notable cost and typically require more resources to handle, (significantly more in some cases). You should review large repositories to ensure they maintain good health and reduce their size wherever possible.
NOTE: If best practices aren't followed and large repositories are present on the environment, increased Gitaly specs may be required to ensure stable performance.
Refer to the Managing large repositories documentation for more information and guidance.
Praefect requires its own database server and that to achieve full High Availability, a third-party PostgreSQL database solution is required.
We hope to offer a built-in solution for these restrictions in the future. In the meantime, a non-HA PostgreSQL server can be set up using the Linux package as the specifications reflect. Refer to the following issues for more information:
NOTE: The following lists are non-exhaustive. Generally, other cloud providers not listed here likely work with the same specs, but this hasn't been validated. Additionally, when it comes to other cloud provider services not listed here, it's advised to be cautious as each implementation can be notably different and should be tested thoroughly before production use.
Through testing and real life usage, the Reference Architectures are validated and supported on the following cloud providers:
| Reference Architecture | GCP | AWS | Azure | Bare Metal |
|---|---|---|---|---|
| Linux package | 🟢 | 🟢 | 🟡1 | 🟢 |
| Cloud Native Hybrid | 🟢 | 🟢 |
- We only recommend smaller setups (up to 2k) at this time on Azure due to performance issues at larger scales. See the Recommendation Notes for Azure section for more info.
Additionally, the following cloud provider services are validated and supported for use as part of the Reference Architectures:
| Cloud Service | GCP | AWS | Bare Metal |
|---|---|---|---|
| Object Storage | 🟢 Cloud Storage | 🟢 S3 | 🟢 MinIO |
| Database | 🟢 Cloud SQL | 🟢 RDS | |
| Redis | 🟢 Memorystore | 🟢 ElastiCache |
When selecting to use an external database service, it should run a standard, performant, and supported version.
If you choose to use a third party external service:
- Note that the HA Linux package PostgreSQL setup encompasses PostgreSQL, PgBouncer and Consul. All of these components would no longer be required when using a third party external service.
- The number of nodes required to achieve HA may differ depending on the service compared to the Linux package and doesn't need to match accordingly.
- However, if Database Load Balancing via Read Replicas is desired for further improved performance it's recommended to follow the node count for the Reference Architecture.
- If GitLab Geo is to be used the service will need to support Cross Region replication
Several database cloud provider services are known not to support the above or have been found to have other issues and aren't recommended:
- Amazon Aurora is incompatible and not supported. See 14.4.0 for more details.
- Azure Database for PostgreSQL Single Server is not supported for use due to notable performance / stability issues or missing functionality. See Recommendation Notes for Azure for more details.
- Google AlloyDB and Amazon RDS Multi-AZ DB cluster have not been tested and are not recommended. Both solutions are specifically not expected to work with GitLab Geo.
- Amazon RDS Multi-AZ DB instance is a separate product and is supported.
Due to performance issues that we found with several key Azure services, we only recommend smaller architectures (up to 2k) to be deployed to Azure. For larger architectures, we recommend using another cloud provider.
In addition to the above, you should be aware of the additional specific guidance for Azure:
- Azure Database for PostgreSQL Single Server is not supported for use due to notable performance / stability issues or missing functionality.
- A new service, Azure Database for PostgreSQL Flexible Server has been released. Internal testing has shown that it does look to perform as expected, but this hasn't been validated in production, so generally isn't recommended at this time. Additionally, as it's a new service, you may find that it's missing some functionality depending on your requirements.
- Only standard Postgres authentication is supported at this time with this service. Microsoft Azure Active Directory (Azure AD) is not compatible.
- Azure Blob Storage has been found to have performance limits that can impact production use at certain times. However, this has only been seen in our largest architectures (25k+) so far.
As a general guideline, the further away you move from the reference architectures, the harder it is to get support for it. With any deviation, you're introducing a layer of complexity that adds challenges to finding out where potential issues might lie.
The reference architectures use the official Linux packages or Helm Charts to install and configure the various components. The components are installed on separate machines (virtualized or bare metal), with machine hardware requirements listed in the "Configuration" column and equivalent VM standard sizes listed in GCP/AWS/Azure columns of each available reference architecture.
Running components on Docker (including Docker Compose) with the same specs should be fine, as Docker is well known in terms of support.
However, it is still an additional layer and may still add some support complexities, such as not being able to run strace easily in containers.
While we endeavour to try and have a good range of support for GitLab environment designs, there are certain approaches we know definitively not to work, and as a result are not supported. Those approaches are detailed in the following sections.
Running stateful components in Kubernetes, such as Gitaly Cluster, is not supported.
Gitaly Cluster is only supported to be run on VMs as Git itself doesn't match well with the Kubernetes design and attempting to run it can lead to significant and complex issues. Refer to epic 6127 for more information.
This also applies to other third-party stateful components such as Postgres and Redis, but you can explore other third-party solutions for those components if desired such as supported Cloud Provider services unless called out specifically as unsupported.
As a general guidance, only stateless components of GitLab can be run in Autoscaling groups, namely GitLab Rails and Sidekiq.
Other components that have state, such as Gitaly, are not supported in this fashion (for more information, see issue 2997).
This also applies to other third-party stateful components such as Postgres and Redis, but you can explore other third-party solutions for those components if desired such as supported Cloud Provider services unless called out specifically as unsupported.
Deploying one GitLab environment over multiple data centers is not supported due to potential split brain edge cases if a data center were to go down. For example, several components of the GitLab setup, namely Consul, Redis Sentinel and Praefect require an odd number quorum to function correctly and splitting over multiple data centers can impact this notably.
For deploying GitLab over multiple data centers or regions we offer GitLab Geo as a comprehensive solution.
The Quality Engineering team does regular smoke and performance tests for the reference architectures to ensure they remain compliant.
The Quality Department has a focus on measuring and improving the performance of GitLab, as well as creating and validating reference architectures that self-managed customers can rely on as performant configurations.
For more information, see our handbook page.
Testing occurs against all reference architectures and cloud providers in an automated and ad-hoc fashion. This is done by two tools:
- The GitLab Environment Toolkit for building the environments.
- The GitLab Performance Tool for performance testing.
Network latency on the test environments between components on all Cloud Providers were measured at <5 ms. This is shared as an observation and not as an implicit recommendation.
We aim to have a "test smart" approach where architectures tested have a good range that can also apply to others. Testing focuses on a 10k Linux package installation on GCP as the testing has shown this is a good bellwether for the other architectures and cloud providers as well as Cloud Native Hybrids.
The Standard Reference Architectures are designed to be platform-agnostic, with everything being run on VMs through the Linux package. While testing occurs primarily on GCP, ad-hoc testing has shown that they perform similarly on hardware with equivalent specs on other Cloud Providers or if run on premises (bare-metal).
Testing on these reference architectures is performed with the GitLab Performance Tool at specific coded workloads, and the throughputs used for testing are calculated based on sample customer data. Select the reference architecture that matches your scale.
Each endpoint type is tested with the following number of requests per second (RPS) per 1,000 users:
- API: 20 RPS
- Web: 2 RPS
- Git (Pull): 2 RPS
- Git (Push): 0.4 RPS (rounded to the nearest integer)
NOTE: Read our blog post on how our QA team leverages GitLab performance testing tool.
Testing is done publicly, and all results are shared.
The following table details the testing done against the reference architectures along with the frequency and results. Additional testing is continuously evaluated, and the table is updated accordingly.
<style> table.test-coverage td { border-top: 1px solid #dbdbdb; border-left: 1px solid #dbdbdb; border-right: 1px solid #dbdbdb; border-bottom: 1px solid #dbdbdb; } table.test-coverage th { border-top: 1px solid #dbdbdb; border-left: 1px solid #dbdbdb; border-right: 1px solid #dbdbdb; border-bottom: 1px solid #dbdbdb; } </style>| Reference Architecture |
GCP (* also proxy for Bare-Metal) | AWS | Azure | |||
|---|---|---|---|---|---|---|
| Linux package | Cloud Native Hybrid | Linux package | Cloud Native Hybrid | Linux package | ||
| 1k | Weekly | |||||
| 2k | Weekly | Planned | ||||
| 3k | Weekly | Weekly | ||||
| 5k | Weekly | |||||
| 10k | Daily | Weekly | Weekly | Weekly | ||
| 25k | Weekly | |||||
| 50k | Weekly | |||||
As a starting point, the following table details initial costs for the different reference architectures across GCP, AWS, and Azure through the Linux package.
NOTE: Due to the nature of Cloud Native Hybrid, it's not possible to give a static cost calculation. Bare-metal costs are also not included here as it varies widely depending on each configuration.
| Reference Architecture |
GCP | AWS | Azure |
|---|---|---|---|
| Linux package | Linux package | Linux package | |
| 1k | Calculated cost | Calculated cost | Calculated cost |
| 2k | Calculated cost | Calculated cost | Calculated cost |
| 3k | Calculated cost | Calculated cost | Calculated cost |
| 5k | Calculated cost | Calculated cost | Calculated cost |
| 10k | Calculated cost | Calculated cost | Calculated cost |
| 25k | Calculated cost | Calculated cost | Calculate cost |
| 50k | Calculated cost | Calculated cost | Calculated cost |
Maintaining a Reference Architecture environment is generally the same as any other GitLab environment is generally covered in other sections of this documentation.
In this section you'll find links to documentation for relevant areas as well as any specific Reference Architecture notes.
Upgrades for a Reference Architecture environment is the same as any other GitLab environment. The main Upgrade GitLab section has detailed steps on how to approach this.
Zero-downtime upgrades are also available.
NOTE: You should upgrade a Reference Architecture in the same order as you created it.
Scaling a GitLab environment is designed to be as seamless as possible.
In terms of the Reference Architectures, you would look to the next size and adjust accordingly. Most setups would only need vertical scaling, but there are some specific areas that can be adjusted depending on the setup:
- If you're scaling from a non-HA environment to an HA environment, various components are recommended to be deployed in their HA forms:
- Redis to multi-node Redis w/ Redis Sentinel
- Postgres to multi-node Postgres w/ Consul + PgBouncer
- Gitaly to Gitaly Cluster w/ Praefect
- From 10k users and higher, Redis is recommended to be split into multiple HA servers as it's single threaded.
Conversely, if you have robust metrics in place that show the environment is over-provisioned, you can apply the same process for scaling downwards. You should take an iterative approach when scaling downwards, however, to ensure there are no issues.
To monitor your GitLab environment, you can use the tools bundled with GitLab, but it's also possible to use third-party options if desired.