From 83f61111115424958af2e403511736685ebe3d25 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Thu, 19 Oct 2023 11:20:00 +0100 Subject: [PATCH 1/5] Add note about Disk Types in Ref Arch docs --- doc/administration/reference_architectures/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index 44aa3d648ad3d4..216c573ecb331b 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -198,6 +198,15 @@ ARM-based equivalents are also supported. NOTE: Any "burstable" instance types are not recommended due to inconsistent performance. +### Supported Disk Types + +As a general guidance most standard disk types are expected to work for GitLab but be aware of the following specific call uts: + +- [Gitaly](../gitaly/index.md#disk-requirements) requires at least 8,000 input/output operations per second (IOPS) for read operations and 2,000 IOPS for write operations for their disks. +- We don't recommend the use of any disk types that are "burstable" due to inconsistent performance. + +Outside the above standard disk types are expected to work for GitLab and the choice of each will depend on your specific requirements around areas such as durability or costs. + ### Supported infrastructure As a general guidance, GitLab should run on most infrastructure such as reputable Cloud Providers (AWS, GCP, Azure) and -- GitLab From 621ac928c121156c7a11399cfabd25583d87ea4f Mon Sep 17 00:00:00 2001 From: Grant Young Date: Mon, 30 Oct 2023 12:25:52 +0000 Subject: [PATCH 2/5] Add note on recommended Object Storage --- doc/administration/reference_architectures/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index 216c573ecb331b..7066a6409db9db 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -365,6 +365,12 @@ If you choose to use a third party external service: Redis is primarily single threaded. For the 10,000 user and above Reference Architectures, separate out the instances as specified into Cache and Persistent data to achieve optimum performance at this scale. +### Recommendation notes for Object Storage + +GitLab has been tested against [various Object Storage providers](../object_storage.md#supported-object-storage-providers) that are expected to work. + +As a general guidance it's recommended to use a reputable solution that has full S3 compatibility. + #### Unsupported database services Several database cloud provider services are known not to support the above or have been found to have other issues and aren't recommended: -- GitLab From b0d79d38228b37caa729eea0d7fd921626d04f8b Mon Sep 17 00:00:00 2001 From: Grant Young Date: Mon, 30 Oct 2023 14:22:07 +0000 Subject: [PATCH 3/5] Expand note on monitoring --- doc/administration/reference_architectures/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index 7066a6409db9db..c5f31d942a73ce 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -678,8 +678,8 @@ Most setups would only need vertical scaling, but there are some specific areas 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. -### How to monitor your environment +### Monitoring -To monitor your GitLab environment, you can use the tools -[bundled with GitLab](../monitoring/index.md), but it's also possible to use third-party -options if desired. +There are numerous options available to monitor your infrastructure as well as [GitLab itself](../monitoring/index.md), and you should refer to your chosen monitoring solution's documentation for more information. + +Of note, the GitLab application is bundled with [Prometheus as well as various Prometheus compatible exporters](../monitoring/prometheus/index.md) that could be hooked into your solution. -- GitLab From e166def4a5fe3a54d6817f821838f214779c871f Mon Sep 17 00:00:00 2001 From: Grant Young Date: Wed, 1 Nov 2023 15:19:43 +0000 Subject: [PATCH 4/5] Adjust CPU message to be clearer about ARM --- doc/administration/reference_architectures/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index c5f31d942a73ce..3a0d7e92a70f7b 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -191,9 +191,9 @@ Before implementing a reference architecture, refer to the following requirement 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 a 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. -Newer, similarly-sized CPUs are supported and may have improved performance as a result. For Linux package environments, -ARM-based equivalents are also supported. +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. -- GitLab From 28608556ec9a3ed5a62338b41e2177b971de0140 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Thu, 2 Nov 2023 19:44:27 +0000 Subject: [PATCH 5/5] Apply 6 suggestion(s) to 1 file(s) --- doc/administration/reference_architectures/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index 3a0d7e92a70f7b..e2fc425b5362b1 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -198,14 +198,14 @@ ARM CPUs are supported for Linux package environments as well as for any [Cloud NOTE: Any "burstable" instance types are not recommended due to inconsistent performance. -### Supported Disk Types +### Supported disk types -As a general guidance most standard disk types are expected to work for GitLab but be aware of the following specific call uts: +As a general guidance, most standard disk types are expected to work for GitLab, but be aware of the following specific call outs: -- [Gitaly](../gitaly/index.md#disk-requirements) requires at least 8,000 input/output operations per second (IOPS) for read operations and 2,000 IOPS for write operations for their disks. +- [Gitaly](../gitaly/index.md#disk-requirements) requires at least 8,000 input/output operations per second (IOPS) for read operations, and 2,000 IOPS for write operations. - We don't recommend the use of any disk types that are "burstable" due to inconsistent performance. -Outside the above standard disk types are expected to work for GitLab and the choice of each will depend on your specific requirements around areas such as durability or costs. +Outside the above standard, disk types are expected to work for GitLab and the choice of each depends on your specific requirements around areas, such as durability or costs. ### Supported infrastructure @@ -369,7 +369,7 @@ Redis is primarily single threaded. For the 10,000 user and above Reference Arch GitLab has been tested against [various Object Storage providers](../object_storage.md#supported-object-storage-providers) that are expected to work. -As a general guidance it's recommended to use a reputable solution that has full S3 compatibility. +As a general guidance, it's recommended to use a reputable solution that has full S3 compatibility. #### Unsupported database services @@ -680,6 +680,6 @@ scaling downwards. You should take an iterative approach when scaling downwards, ### Monitoring -There are numerous options available to monitor your infrastructure as well as [GitLab itself](../monitoring/index.md), and you should refer to your chosen monitoring solution's documentation for more information. +There are numerous options available to monitor your infrastructure, as well as [GitLab itself](../monitoring/index.md), and you should refer to your chosen monitoring solution's documentation for more information. Of note, the GitLab application is bundled with [Prometheus as well as various Prometheus compatible exporters](../monitoring/prometheus/index.md) that could be hooked into your solution. -- GitLab