diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index d112c6174bf57888f4abbf622e7dbf0bac64a32c..e6c80d75978d4edff0ca8db397f0d659f38a803b 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -40,7 +40,7 @@ specifically the [Before you start](index.md#before-you-start) and [Deciding whi | Sidekiq7 | 4 | 4 vCPU, 15 GB memory | `n1-standard-4` | `m5.xlarge` | `D4s v3` | | GitLab Rails7 | 3 | 32 vCPU, 28.8 GB memory | `n1-highcpu-32` | `c5.9xlarge` | `F32s v2` | | Monitoring node | 1 | 4 vCPU, 3.6 GB memory | `n1-highcpu-4` | `c5.xlarge` | `F4s v2` | -| Object storage 4 | - | - | - | - | - | +| Object storage4 | - | - | - | - | - | **Footnotes:** diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index af324966583649366d1eee08ee551d189dec469b..4d29024076c85265bcf1d00e7a3a9db4f6a14420 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -23,9 +23,16 @@ For a full list of reference architectures, see > can follow a [modified hybrid reference architecture](#cloud-native-hybrid-reference-architecture-with-helm-charts). > - **Unsure which Reference Architecture to use?** [Go to this guide for more info](index.md#deciding-which-architecture-to-use). -| Users | Configuration | GCP | AWS | Azure | -|--------------|-------------------------|----------------|--------------|----------| -| Up to 1,000 or 20 RPS | 8 vCPU, 7.2 GB memory | `n1-highcpu-8` | `c5.2xlarge` | `F8s v2` | +| Users | Configuration | GCP | AWS | Azure | +|--------------|----------------------|----------------|--------------|----------| +| Up to 1,000 or 20 RPS | 8 vCPU, 16 GB memory | `n1-standard-8`1 | `c5.2xlarge` | `F8s v2` | + +**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](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type) can also be used if desired. + ```plantuml @startuml 1k diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index c08972a9c7a11b84ab4ac685fbbccc5c0d580035..d9bee40a2b5b6e978445a853a0e86738a3711cd4 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -1134,10 +1134,10 @@ services where applicable): | Service | Nodes | Configuration | GCP | AWS | |-----------------------------|-------|------------------------|-----------------|-------------| -| PostgreSQL 1 | 1 | 2 vCPU, 7.5 GB memory | `n1-standard-2` | `m5.large` | -| Redis 2 | 1 | 1 vCPU, 3.75 GB memory | `n1-standard-1` | `m5.large` | +| PostgreSQL1 | 1 | 2 vCPU, 7.5 GB memory | `n1-standard-2` | `m5.large` | +| Redis2 | 1 | 1 vCPU, 3.75 GB memory | `n1-standard-1` | `m5.large` | | Gitaly | 1 | 4 vCPU, 15 GB memory | `n1-standard-4` | `m5.xlarge` | -| Object storage 3 | - | - | - | - | +| Object storage3 | - | - | - | - | **Footnotes:** diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 7b7b1469fd3357c5087bf9a925eb092db26563a9..6b094f64502b81dc39d6d10e049c3305f12ae471 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -39,7 +39,7 @@ For a full list of reference architectures, see | Sidekiq7 | 2 | 4 vCPU, 15 GB memory | `n1-standard-4` | `m5.xlarge` | `D2s v3` | | GitLab Rails7 | 3 | 8 vCPU, 7.2 GB memory | `n1-highcpu-8` | `c5.2xlarge` | `F8s v2` | | Monitoring node | 1 | 2 vCPU, 1.8 GB memory | `n1-highcpu-2` | `c5.large` | `F2s v2` | -| Object storage 4 | - | - | - | - | - | +| Object storage4 | - | - | - | - | - | **Footnotes:** diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index c5874651cd75dd73e55e1edc24f9385e1f36137a..94192e275a644490cccac802152c30ff3825d949 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -208,12 +208,17 @@ Before implementing a reference architecture, refer to the following requirement ### Supported CPUs -These reference architectures were built and tested on Google Cloud Platform (GCP) using the -[Intel Xeon E5 v3 (Haswell)](https://cloud.google.com/compute/docs/cpu-platforms) -CPU platform as the lowest common denominator baseline ([Sysbench benchmark](https://gitlab.com/gitlab-org/quality/performance/-/wikis/Reference-Architectures/GCP-CPU-Benchmarks)). -Newer, similarly-sized CPUs are supported and may have improved performance as a result. +The reference architectures are built and tested across various cloud providers, primarily GCP and AWS, with +CPU targets being the lowest common denominator to ensure the widest range of compatibility: -ARM CPUs are supported for Linux package environments as well as for any [Cloud Provider services](#cloud-provider-services) where applicable. +- The [`n1` series](https://cloud.google.com/compute/docs/general-purpose-machines#n1_machines) for GCP. +- The [`m5` series](https://aws.amazon.com/ec2/instance-types/) for AWS. + +Depending on other requirements such as memory or network bandwidth as well as cloud provider availability, different machine types are used accordingly throughout the architectures, but it is expected that the target CPUs above should perform well. + +If you want, you can select a newer machine type series and have improved performance as a result. + +Additionally, ARM CPUs are supported for Linux package environments as well as for any [Cloud Provider services](#cloud-provider-services) where applicable. NOTE: Any "burstable" instance types are not recommended due to inconsistent performance. @@ -758,6 +763,8 @@ You can find a full history of changes [on the GitLab project](https://gitlab.co **2024:** +- [2024-04](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149528): Updated 20 RPS / 1,000 User architecture specs to follow recommended memory target of 16 GB. +- [2024-04](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148313): Updated Reference Architecture titles to include RPS for further clarity and to help right sizing. - [2024-02](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/145436): Updated recommended sizings for Load Balancer nodes if deployed on VMs. Also added notes on network bandwidth considerations. - [2024-02](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143539): Remove the Sidekiq Max Concurrency setting in examples as this is deprecated and no longer required to be set explicitly. - [2024-02](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143539): Adjusted the Sidekiq recommendations on 2k to disable Sidekiq on Rails nodes and updated architecture diagram. diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 24ad60560a73e45e33349a210cff785da4e29b1b..d3c9e948ff9839ff80335525073d66ca1e29c2fa 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -38,37 +38,22 @@ NOTE: CPU requirements are dependent on the number of users and expected workload. Your exact needs may be more, depending on your workload. Your workload is influenced by factors such as - but not limited to - how active your users are, how much automation you use, mirroring, and repository/change size. -The following is the recommended minimum CPU hardware guidance for a handful of example GitLab user base sizes. +Refer below for CPU recommendations depending on user count / load: -- **4 cores** is the **recommended** minimum number of cores and supports up to 500 users -- 8 cores supports up to 1000 users -- More users? Consult the [reference architectures page](../administration/reference_architectures/index.md) +- Up to 20 Requests per Second (RPS) or 1000 users - 8 vCPU. +- More users or load? Consult the [reference architectures page](../administration/reference_architectures/index.md). ### Memory Memory requirements are dependent on the number of users and expected workload. Your exact needs may be more, depending on your workload. Your workload is influenced by factors such as - but not limited to - how active your users are, how much automation you use, mirroring, and repository/change size. -The following is the recommended minimum Memory hardware guidance for a handful of example GitLab user base sizes. +Refer below for Memory recommendations depending on user count / load: -- **4 GB RAM** is the **required** minimum memory size and supports up to 500 users -- 8 GB RAM supports up to 1000 users -- More users? Consult the [reference architectures page](../administration/reference_architectures/index.md) - -For smaller installations, you should: - -- Have at least 2 GB of swap on your server, even if you have enough available RAM. Having swap helps to reduce the chance of - errors occurring if your available memory changes. -- Configure the kernel's swappiness setting to a low value like `10` to make the most of your RAM while still having the swap available when needed. - -For larger installations that follow our reference architectures, you [shouldn't configure swap](../administration/reference_architectures/index.md#no-swap). +- Up to 20 Requests per Second (RPS) or 1000 users - 8 GB (Minimum), 16 GB (Recommended). +- More users or load? Consult the [reference architectures page](../administration/reference_architectures/index.md). NOTE: -Although excessive swapping is undesired and degrades performance, it is an -extremely important last resort against out-of-memory conditions. During -unexpected system load, such as OS updates or other services on the same host, -peak memory load spikes could be much higher than average. Having plenty of swap -helps avoid the Linux OOM killer unsafely terminating a potentially critical -process, such as PostgreSQL, which can have disastrous consequences. +While not recommended, in certain circumstances GitLab may run in a [memory constrained environment](https://docs.gitlab.com/omnibus/settings/memory_constrained_envs.html). ## Database