From e75610dda9f21a2726d027eaffb5454c4a726624 Mon Sep 17 00:00:00 2001 From: Rocky Mongare Date: Tue, 29 Jul 2025 13:24:08 +0300 Subject: [PATCH 1/4] Update reference architecture docs to use gitaly_role --- .../reference_architectures/10k_users.md | 16 ++-------------- .../reference_architectures/25k_users.md | 16 ++-------------- .../reference_architectures/2k_users.md | 16 ++-------------- .../reference_architectures/3k_users.md | 16 ++-------------- .../reference_architectures/50k_users.md | 16 ++-------------- .../reference_architectures/5k_users.md | 16 ++-------------- 6 files changed, 12 insertions(+), 84 deletions(-) diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 98347e1c8e9bde..e95fff52cc1096 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -1593,17 +1593,8 @@ On each node: --> ```ruby - # Avoid running unnecessary services on the Gitaly server - postgresql['enable'] = false - redis['enable'] = false - nginx['enable'] = false - puma['enable'] = false - sidekiq['enable'] = false - gitlab_workhorse['enable'] = false - prometheus['enable'] = false - alertmanager['enable'] = false - gitlab_exporter['enable'] = false - gitlab_kas['enable'] = false + # https://docs.gitlab.com/omnibus/roles/#gitaly-roles + roles(["gitaly_role"]) # Prevent database migrations from running on upgrade automatically gitlab_rails['auto_migrate'] = false @@ -1613,9 +1604,6 @@ On each node: # balancer. gitlab_rails['internal_api_url'] = 'https://gitlab.example.com' - # Gitaly - gitaly['enable'] = true - # Configure the Consul agent consul['enable'] = true ## Enable service discovery for Prometheus diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index d8e2314492722f..feb35086538375 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -1602,17 +1602,8 @@ On each node: --> ```ruby - # Avoid running unnecessary services on the Gitaly server - postgresql['enable'] = false - redis['enable'] = false - nginx['enable'] = false - puma['enable'] = false - sidekiq['enable'] = false - gitlab_workhorse['enable'] = false - prometheus['enable'] = false - alertmanager['enable'] = false - gitlab_exporter['enable'] = false - gitlab_kas['enable'] = false + # https://docs.gitlab.com/omnibus/roles/#gitaly-roles + roles(["gitaly_role"]) # Prevent database migrations from running on upgrade automatically gitlab_rails['auto_migrate'] = false @@ -1622,9 +1613,6 @@ On each node: # balancer. gitlab_rails['internal_api_url'] = 'https://gitlab.example.com' - # Gitaly - gitaly['enable'] = true - # Configure the Consul agent consul['enable'] = true ## Enable service discovery for Prometheus diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index f2d24a1b499b24..7cdcfeadc55a9e 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -499,17 +499,8 @@ but do **not** provide the `EXTERNAL_URL` value. --> ```ruby - # Avoid running unnecessary services on the Gitaly server - postgresql['enable'] = false - redis['enable'] = false - nginx['enable'] = false - puma['enable'] = false - sidekiq['enable'] = false - gitlab_workhorse['enable'] = false - prometheus['enable'] = false - alertmanager['enable'] = false - gitlab_exporter['enable'] = false - gitlab_kas['enable'] = false + # https://docs.gitlab.com/omnibus/roles/#gitaly-roles + roles(["gitaly_role"]) # Prevent database migrations from running on upgrade automatically gitlab_rails['auto_migrate'] = false @@ -519,9 +510,6 @@ but do **not** provide the `EXTERNAL_URL` value. # balancer. gitlab_rails['internal_api_url'] = 'https://gitlab.example.com' - # Gitaly - gitaly['enable'] = true - # Set the network addresses that the exporters used for monitoring will listen on node_exporter['listen_address'] = '0.0.0.0:9100' diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 34f2501cb14653..b62ecae22edef6 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -1428,24 +1428,12 @@ On each node: --> ```ruby - # Avoid running unnecessary services on the Gitaly server - postgresql['enable'] = false - redis['enable'] = false - nginx['enable'] = false - puma['enable'] = false - sidekiq['enable'] = false - gitlab_workhorse['enable'] = false - prometheus['enable'] = false - alertmanager['enable'] = false - gitlab_exporter['enable'] = false - gitlab_kas['enable'] = false + # https://docs.gitlab.com/omnibus/roles/#gitaly-roles + roles(["gitaly_role"]) # Prevent database migrations from running on upgrade automatically gitlab_rails['auto_migrate'] = false - # Gitaly - gitaly['enable'] = true - # Configure the gitlab-shell API callback URL. Without this, `git push` will # fail. This can be your 'front door' GitLab URL or an internal load # balancer. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 4615939b68f2df..d6cbc105bce8e7 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -1607,17 +1607,8 @@ On each node: --> ```ruby - # Avoid running unnecessary services on the Gitaly server - postgresql['enable'] = false - redis['enable'] = false - nginx['enable'] = false - puma['enable'] = false - sidekiq['enable'] = false - gitlab_workhorse['enable'] = false - prometheus['enable'] = false - alertmanager['enable'] = false - gitlab_exporter['enable'] = false - gitlab_kas['enable'] = false + # https://docs.gitlab.com/omnibus/roles/#gitaly-roles + roles(["gitaly_role"]) # Prevent database migrations from running on upgrade automatically gitlab_rails['auto_migrate'] = false @@ -1627,9 +1618,6 @@ On each node: # balancer. gitlab_rails['internal_api_url'] = 'https://gitlab.example.com' - # Gitaly - gitaly['enable'] = true - # Configure the Consul agent consul['enable'] = true ## Enable service discovery for Prometheus diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 7b93c5a7beecfd..44b836b5c89ec2 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -1433,17 +1433,8 @@ On each node: --> ```ruby - # Avoid running unnecessary services on the Gitaly server - postgresql['enable'] = false - redis['enable'] = false - nginx['enable'] = false - puma['enable'] = false - sidekiq['enable'] = false - gitlab_workhorse['enable'] = false - prometheus['enable'] = false - alertmanager['enable'] = false - gitlab_exporter['enable'] = false - gitlab_kas['enable'] = false + # https://docs.gitlab.com/omnibus/roles/#gitaly-roles + roles(["gitaly_role"]) # Prevent database migrations from running on upgrade automatically gitlab_rails['auto_migrate'] = false @@ -1453,9 +1444,6 @@ On each node: # balancer. gitlab_rails['internal_api_url'] = 'https://gitlab.example.com' - # Gitaly - gitaly['enable'] = true - # Configure the Consul agent consul['enable'] = true ## Enable service discovery for Prometheus -- GitLab From 5b046155747fc702d6d09dc9bf137666afdb75df Mon Sep 17 00:00:00 2001 From: Rocky Mongare Date: Tue, 29 Jul 2025 13:24:08 +0300 Subject: [PATCH 2/4] Update reference architecture docs to use gitaly_role --- doc/administration/reference_architectures/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/administration/reference_architectures/_index.md b/doc/administration/reference_architectures/_index.md index 072c8a52dfb26a..d6e339dc2d410e 100644 --- a/doc/administration/reference_architectures/_index.md +++ b/doc/administration/reference_architectures/_index.md @@ -770,6 +770,7 @@ You can find a full history of changes [on the GitLab project](https://gitlab.co **2025**: +- [2025-08](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199549): Update docs to use the new [gitaly_role](https://docs.gitlab.com/omnibus/roles/#gitaly-roles) - [2025-02](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181145): Added further clarity around supported machine types and that the listed examples are not intended as prescriptive defaults. **2024**: -- GitLab From 8e267a3a5ec67d71f55514ed9c7cfac966e59b0f Mon Sep 17 00:00:00 2001 From: Rocky Mongare Date: Fri, 8 Aug 2025 13:31:46 +0300 Subject: [PATCH 3/4] Apply 1 suggestion(s) to 1 file(s) Co-authored-by: Nailia Iskhakova --- doc/administration/reference_architectures/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/administration/reference_architectures/_index.md b/doc/administration/reference_architectures/_index.md index d6e339dc2d410e..5c27e46f69add9 100644 --- a/doc/administration/reference_architectures/_index.md +++ b/doc/administration/reference_architectures/_index.md @@ -770,7 +770,7 @@ You can find a full history of changes [on the GitLab project](https://gitlab.co **2025**: -- [2025-08](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199549): Update docs to use the new [gitaly_role](https://docs.gitlab.com/omnibus/roles/#gitaly-roles) +- [2025-08](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199549): Updated Gitaly configurations to use [Gitaly roles](https://docs.gitlab.com/omnibus/roles/#gitaly-roles) - [2025-02](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181145): Added further clarity around supported machine types and that the listed examples are not intended as prescriptive defaults. **2024**: -- GitLab From cf79bb829c3e2025bbc22ad94dcfd34efa6b2362 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Fri, 8 Aug 2025 13:40:08 +0200 Subject: [PATCH 4/4] Apply 1 suggestion(s) to 1 file(s) --- doc/administration/reference_architectures/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/administration/reference_architectures/_index.md b/doc/administration/reference_architectures/_index.md index 5c27e46f69add9..a091386eb064f4 100644 --- a/doc/administration/reference_architectures/_index.md +++ b/doc/administration/reference_architectures/_index.md @@ -770,7 +770,7 @@ You can find a full history of changes [on the GitLab project](https://gitlab.co **2025**: -- [2025-08](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199549): Updated Gitaly configurations to use [Gitaly roles](https://docs.gitlab.com/omnibus/roles/#gitaly-roles) +- [2025-08](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/199549): Updated Gitaly configurations to use [Gitaly roles](https://docs.gitlab.com/omnibus/roles/#gitaly-roles). - [2025-02](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/181145): Added further clarity around supported machine types and that the listed examples are not intended as prescriptive defaults. **2024**: -- GitLab