Reference architecture: Up to 20 RPS or 1,000 users

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

This reference architecture targets a peak load of 20 requests per second (RPS). Based on real data, this load typically corresponds to up to 1,000 users, which includes both manual and automated interactions.

For a full list of reference architectures, see available reference architectures.

• Target Load: API: 20 RPS, Web: 2 RPS, Git (Pull): 2 RPS, Git (Push): 1 RPS
• High Availability: No. For a high availability environment, follow a modified 3K reference architecture.
• Cost calculator template: For more information, see cost calculator templates.
• Cloud Native Hybrid: No. For a cloud native hybrid environment, you can follow a modified hybrid reference architecture.
• Unsure which Reference Architecture to use? For more information, see deciding which architecture to start with.

Footnotes:

1. For GCP, the closest and equivalent standard machine type has been selected that matches the recommended requirement of 8 vCPU and 16 GB of RAM. A custom machine type can also be used if desired.

The following diagram shows that while GitLab can be installed on a single server, it is internally composed of multiple services. When an instance scales, these services are separated and independently scaled according to their specific demands.

In some cases, you can leverage PaaS for some services. For example, you can use Cloud Object Storage for some file systems. For the sake of redundancy, some services become clusters of nodes and store the same data.

In a horizontally scaled GitLab configuration, various ancillary services are required to coordinate clusters or discover resources. For example, PgBouncer for PostgreSQL connection management, or Consul for Prometheus end point discovery.

@startuml 1k
card "**Prometheus**" as monitor #7FFFD4
package "GitLab Single Server" as gitlab-single-server {
together {
  card "**GitLab Rails**" as gitlab #32CD32
  card "**Gitaly**" as gitaly #FF8C00
  card "**PostgreSQL**" as postgres #4EA7FF
  card "**Redis**" as redis #FF6347
  card "**Sidekiq**" as sidekiq #ff8dd1
}
card "Local Storage" as local_storage #white
}

gitlab -[#32CD32]--> gitaly
gitlab -[#32CD32]--> postgres
gitlab -[#32CD32]--> redis
gitlab -[#32CD32]--> sidekiq
gitaly -[#32CD32]--> local_storage
postgres -[#32CD32]--> local_storage
sidekiq -[#32CD32]--> local_storage
gitlab -[#32CD32]--> local_storage

monitor .[#7FFFD4]u-> gitlab
monitor .[#7FFFD4]u-> sidekiq
monitor .[#7FFFD4]-> postgres
monitor .[#7FFFD4]-> gitaly
monitor .[#7FFFD4,norank]--> redis

@enduml

Requirements

Before starting, see the requirements for reference architectures.

WARNING: The node's specifications are based on high percentiles of both usage patterns and repository sizes in good health. However, if you have large monorepos (larger than several gigabytes) or additional workloads, it might significantly impact the performance of the environment. If this applies to you, further adjustments might be required. See the linked documentation and reach out to your Customer Success Manager or our Support team for further guidance.

Testing methodology

The 1k architecture is designed to cover a large majority of workflows. It is regularly smoke and performance tested by the Test Platform team against the following endpoint throughput targets:

• API: 20 RPS
• Web: 2 RPS
• Git (Pull): 2 RPS
• Git (Push): 1 RPS

These targets are selected based on the real customer data of total environmental loads corresponding to the user count, including CI and other workloads.

Testing is done regularly by using our GitLab Performance Tool (GPT) and its dataset, which is available for anyone to use. The results of this testing are available publicly on the GPT wiki. For more information on our testing strategy, see validation and test results.

Setup instructions

To install GitLab for this default reference architecture, use the standard installation instructions.

You can also optionally configure GitLab to use an external PostgreSQL service or external object storage service. It improves performance and reliability, but at an increased complexity cost.

Configure advanced search

DETAILS: Tier: Premium, Ultimate Offering: Self-managed

You can leverage Elasticsearch and enable advanced search for faster, more advanced code search across your entire GitLab instance.

Elasticsearch cluster design and requirements depends on your data. For recommended best practices about how to set up your Elasticsearch cluster alongside your instance, see choose the optimal cluster configuration.

Cloud Native Hybrid reference architecture with Helm Charts

In the Cloud Native Hybrid reference architecture setup, the select stateless components are deployed in Kubernetes by using our official Helm Charts. The stateful components are deployed in compute VMs with the Linux package.

The smallest reference architecture available for use in Kubernetes is the 2k or 40 RPS GitLab Cloud Native Hybrid (non HA) and 3k or 60 RPS GitLab Cloud Native Hybrid (HA).

For environments that serve fewer users or a lower RPS, you can lower the node specification. Depending on your user count, you can lower all suggested node specifications as desired. However, you should not go lower than the general requirements.

Next steps

Now you have a fresh GitLab environment with core functionality configured accordingly. You might want to configure additional optional GitLab features depending on your requirements. See Steps after installing GitLab for more information.

NOTE: Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features. See the individual pages for more information.