From 987bb32267ddbaf44895eedc8a626fbad0c52bc8 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Thu, 8 Aug 2024 10:08:24 +0100 Subject: [PATCH 1/8] Add Next Steps breadcrumb section to RA docs --- .../reference_architectures/10k_users.md | 17 ++++++++++++ .../reference_architectures/1k_users.md | 17 ++++++++++++ .../reference_architectures/25k_users.md | 17 ++++++++++++ .../reference_architectures/2k_users.md | 17 ++++++++++++ .../reference_architectures/3k_users.md | 26 ++++++++++++++++--- .../reference_architectures/50k_users.md | 17 ++++++++++++ .../reference_architectures/5k_users.md | 17 ++++++++++++ 7 files changed, 125 insertions(+), 3 deletions(-) diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index afe2d88e390426..e630227c53b9d2 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2446,3 +2446,20 @@ An example for the GitLab Helm Charts targetting the above 200 RPS or 10,000 ref Back to set up components + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index ecd82b341b481e..b246a2322736b7 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -129,3 +129,20 @@ and _stateful_ components are deployed in compute VMs with the Linux package. The [2k or 40 RPS GitLab Cloud Native Hybrid](2k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) (non HA) and [3k or 60 RPS GitLab Cloud Native Hybrid](3k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) (HA) reference architectures are the smallest we recommend in Kubernetes. For environments that serve fewer users or a lower RPS, you can lower the node specs. Depending on your user count, you can lower all suggested node specs as desired. However, it's recommended that you don't go lower than the [general requirements](../../install/requirements.md). + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 2eba5f563ab9c4..4f28eee81d08b5 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2453,3 +2453,20 @@ An example for the GitLab Helm Charts targetting the above 500 RPS or 25,000 ref Back to set up components + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 169220c9093c23..1394117d474181 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -1244,3 +1244,20 @@ An example for the GitLab Helm Charts for the above 40 RPS or 2,000 reference ar Back to set up components + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 692b01012715f2..6fbd9dd20e63e6 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2116,16 +2116,19 @@ supported modifications you can make to this architecture to reduce complexity a It should be noted that to achieve HA with GitLab, the 60 RPS or 3,000 users architecture's makeup is ultimately what is required. Each component has various considerations and rules to follow, and the architecture meets all of these. Smaller versions of this architecture will be fundamentally the same, -but with smaller performance requirements, several modifications can be considered as follows: +but with smaller performance requirements, the following modifications are supported as follows: + +NOTE: +If not started below no other modifications are supported at this time for lower use counts. - Lowering node specs: Depending on your user count, you can lower all suggested node specs as desired. However, it's recommended that you don't go lower than the [general requirements](../../install/requirements.md). -- Combining select nodes: Some nodes can be combined to reduce complexity at the cost of some performance: +- Combining select nodes: The following specific components are supported to be combined onto the same nodes to reduce complexity at the cost of some performance: - GitLab Rails and Sidekiq: Sidekiq nodes can be removed, and the component instead enabled on the GitLab Rails nodes. - PostgreSQL and PgBouncer: PgBouncer nodes could be removed and instead be enabled on PostgreSQL nodes with the Internal Load Balancer pointing to them. However, to enable [Database Load Balancing](../postgresql/database_load_balancing.md), a separate PgBouncer array is still required. - Reducing the node counts: Some node types do not need consensus and can run with fewer nodes (but more than one for redundancy). This will also lead to reduced performance. - GitLab Rails and Sidekiq: Stateless services don't have a minimum node count. Two are enough for redundancy. - PostgreSQL and PgBouncer: A quorum is not strictly necessary. Two PostgreSQL nodes and two PgBouncer nodes are enough for redundancy. -- Running select components in reputable Cloud PaaS solutions: Select components of the GitLab setup can instead be run on Cloud Provider PaaS solutions. By doing this, additional dependent components can also be removed: +- Running select components in reputable Cloud PaaS solutions: The following specific components are supported to be run on reputable Cloud Provider PaaS solutions. By doing this, additional dependent components can also be removed: - PostgreSQL: Can be run on reputable Cloud PaaS solutions such as Google Cloud SQL or Amazon RDS. In this setup, the PgBouncer and Consul nodes are no longer required: - Consul may still be desired if [Prometheus](../monitoring/prometheus/index.md) auto discovery is a requirement, otherwise you would need to [manually add scrape configurations](../monitoring/prometheus/index.md#adding-custom-scrape-configurations) for all nodes. - As Redis Sentinel runs on the same box as Consul in this architecture, it may need to be run on a separate box if Redis is still being run using the Linux package. @@ -2338,3 +2341,20 @@ An example for the GitLab Helm Charts for the above 60 RPS or 3,000 reference ar Back to set up components + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 406360ee54df36..e12d231de76d34 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2467,3 +2467,20 @@ An example for the GitLab Helm Charts targetting the above 1000 RPS or 50,000 re Back to set up components + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 26cd85cfb322c4..df1f5173e8bc37 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -2314,3 +2314,20 @@ An example for the GitLab Helm Charts targetting the above 100 RPS or 5,000 refe Back to set up components + +## Next Steps + +After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. + +Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: + +- [GitLab Runner](https://docs.gitlab.com/runner/) +- [Container Registry](../packages/container_registry.md) +- [Pages](../pages/index.md) +- [Incoming Email](../incoming_email.md) +- [Advanced Search](../../integration/advanced_search/elasticsearch.md) +- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) +- [Integrations](../../integration/) + +NOTE: +Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. -- GitLab From 5df090b2b1a0606cd41108ec6bb35c5bba004497 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Thu, 8 Aug 2024 10:13:00 +0100 Subject: [PATCH 2/8] Added note to Update History --- 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 8520f1924663ae..718675c7593dc0 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -776,6 +776,7 @@ You can find a full history of changes [on the GitLab project](https://gitlab.co **2024:** +- [2024-08](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/162144): Added Next Steps breadcrumb section to the pages to help discoverability of additional features. - [2024-05](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153716): Updated the 60 RPS / 3k User and 100 RPS / 5k User pages to have latest Redis guidance on co-locating Redis Sentinel with Redis itself. - [2024-05](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153579): Renamed `Cost to run` section to `Cost calculator templates` to better reflect the calculators are only a starting point and need to be adjusted with specific usage to give more accurate cost estimates. - [2024-04](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149878): Updated recommended sizings for Webservice nodes for Cloud Native Hybrids on GCP. Also adjusted NGINX pod recommendation to be run on Webservice node pool as a DaemonSet. -- GitLab From 5996484b9742dfedcee28b5cc0147cf6bf74a481 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Thu, 8 Aug 2024 10:18:44 +0100 Subject: [PATCH 3/8] Lint fix --- doc/administration/reference_architectures/10k_users.md | 2 +- doc/administration/reference_architectures/1k_users.md | 2 +- doc/administration/reference_architectures/25k_users.md | 2 +- doc/administration/reference_architectures/2k_users.md | 2 +- doc/administration/reference_architectures/3k_users.md | 2 +- doc/administration/reference_architectures/50k_users.md | 2 +- doc/administration/reference_architectures/5k_users.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index e630227c53b9d2..8116e96226f0d8 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2459,7 +2459,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index b246a2322736b7..84c07267605599 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -142,7 +142,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 4f28eee81d08b5..a7ad4ee66c5e1f 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2466,7 +2466,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 1394117d474181..3d75064f84c8cb 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -1257,7 +1257,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 6fbd9dd20e63e6..986ed9432e63f5 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2354,7 +2354,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index e12d231de76d34..debf6f7652babe 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2480,7 +2480,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index df1f5173e8bc37..9cb814fc9d91dd 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -2327,7 +2327,7 @@ Next would be to configure your environment as per your specific requirements fr - [Incoming Email](../incoming_email.md) - [Advanced Search](../../integration/advanced_search/elasticsearch.md) - [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/) +- [Integrations](../../integration/index.md) NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. -- GitLab From fc42d655610b0558d27d3e23dc8253900cf029f3 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Fri, 9 Aug 2024 13:22:03 +0100 Subject: [PATCH 4/8] Switch to existing Next Steps page --- .../reference_architectures/10k_users.md | 12 ++---------- .../reference_architectures/1k_users.md | 12 ++---------- .../reference_architectures/25k_users.md | 12 ++---------- .../reference_architectures/2k_users.md | 12 ++---------- .../reference_architectures/3k_users.md | 12 ++---------- .../reference_architectures/50k_users.md | 12 ++---------- .../reference_architectures/5k_users.md | 12 ++---------- doc/install/next_steps.md | 10 +++++++++- 8 files changed, 23 insertions(+), 71 deletions(-) diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 8116e96226f0d8..be268cd3b44df6 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2449,17 +2449,9 @@ An example for the GitLab Helm Charts targetting the above 200 RPS or 10,000 ref ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index 84c07267605599..764c5a84b315ee 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -132,17 +132,9 @@ For environments that serve fewer users or a lower RPS, you can lower the node s ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index a7ad4ee66c5e1f..0d0c0424c9993d 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2456,17 +2456,9 @@ An example for the GitLab Helm Charts targetting the above 500 RPS or 25,000 ref ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 3d75064f84c8cb..4e3e7b331bdee2 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -1247,17 +1247,9 @@ An example for the GitLab Helm Charts for the above 40 RPS or 2,000 reference ar ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 986ed9432e63f5..197460f38be1c7 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2344,17 +2344,9 @@ An example for the GitLab Helm Charts for the above 60 RPS or 3,000 reference ar ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index debf6f7652babe..b8f32a84521b27 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2470,17 +2470,9 @@ An example for the GitLab Helm Charts targetting the above 1000 RPS or 50,000 re ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 9cb814fc9d91dd..75501edb87276e 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -2317,17 +2317,9 @@ An example for the GitLab Helm Charts targetting the above 100 RPS or 5,000 refe ## Next Steps -After following this guide you should now have a fresh GitLab environment with core functionality configured for up to 20 RPS or 1,000 users. +After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -Next would be to configure your environment as per your specific requirements from adjusting the [configuration](../configure.md) to setting up additional features GitLab offers, such as: - -- [GitLab Runner](https://docs.gitlab.com/runner/) -- [Container Registry](../packages/container_registry.md) -- [Pages](../pages/index.md) -- [Incoming Email](../incoming_email.md) -- [Advanced Search](../../integration/advanced_search/elasticsearch.md) -- [GitLab agent for Kubernetes (KAS)](../clusters/kas.md) -- [Integrations](../../integration/index.md) +There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. NOTE: Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md index 76416408facc75..e14ff0d43218f4 100644 --- a/doc/install/next_steps.md +++ b/doc/install/next_steps.md @@ -18,7 +18,7 @@ installation. - [SMTP](https://docs.gitlab.com/omnibus/settings/smtp.html): Configure SMTP for proper email notifications support. -## CI/CD +## CI/CD (Runner) - [Set up runners](https://docs.gitlab.com/runner/): Set up one or more runners, the agents that are responsible for running CI/CD jobs. @@ -30,6 +30,14 @@ installation. - [GitLab Dependency Proxy](../administration/packages/dependency_proxy.md): Set up the dependency proxy so you can cache container images from Docker Hub for faster, more reliable builds. +## Container Registry + +- [Container Registry](../administration/packages/container_registry.md): Integrated container registry to store container images for each GitLab project. + +## Pages + +- [GitLab Pages](../user/project/pages/index.md): Publish static websites directly from a repository in GitLab + ## Security - [Secure GitLab](../security/index.md): -- GitLab From e319f84d89c83195fad3d40efc4a6a536400b044 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Mon, 12 Aug 2024 13:14:35 +0000 Subject: [PATCH 5/8] Apply 21 suggestion(s) to 7 file(s) --- doc/administration/reference_architectures/10k_users.md | 6 +++--- doc/administration/reference_architectures/1k_users.md | 6 +++--- doc/administration/reference_architectures/25k_users.md | 6 +++--- doc/administration/reference_architectures/2k_users.md | 6 +++--- doc/administration/reference_architectures/3k_users.md | 6 +++--- doc/administration/reference_architectures/50k_users.md | 6 +++--- doc/administration/reference_architectures/5k_users.md | 6 +++--- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index be268cd3b44df6..b453cbca74a7a1 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2447,11 +2447,11 @@ An example for the GitLab Helm Charts targetting the above 200 RPS or 10,000 ref -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index 764c5a84b315ee..aad4cda1de79ba 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -130,11 +130,11 @@ and _stateful_ components are deployed in compute VMs with the Linux package. The [2k or 40 RPS GitLab Cloud Native Hybrid](2k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) (non HA) and [3k or 60 RPS GitLab Cloud Native Hybrid](3k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) (HA) reference architectures are the smallest we recommend in Kubernetes. For environments that serve fewer users or a lower RPS, you can lower the node specs. Depending on your user count, you can lower all suggested node specs as desired. However, it's recommended that you don't go lower than the [general requirements](../../install/requirements.md). -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 0d0c0424c9993d..a083b5198dbf07 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2454,11 +2454,11 @@ An example for the GitLab Helm Charts targetting the above 500 RPS or 25,000 ref -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 4e3e7b331bdee2..e9be9dcae4430e 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -1245,11 +1245,11 @@ An example for the GitLab Helm Charts for the above 40 RPS or 2,000 reference ar -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 197460f38be1c7..2cc24da5efaf3b 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2342,11 +2342,11 @@ An example for the GitLab Helm Charts for the above 60 RPS or 3,000 reference ar -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index b8f32a84521b27..5499ec5e619199 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2468,11 +2468,11 @@ An example for the GitLab Helm Charts targetting the above 1000 RPS or 50,000 re -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 75501edb87276e..8a9a384da85bf3 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -2315,11 +2315,11 @@ An example for the GitLab Helm Charts targetting the above 100 RPS or 5,000 refe -## Next Steps +## Next steps After following this guide you should now have a fresh GitLab environment with core functionality configured accordingly. -There are additional optional features of GitLab you may want to configure on the environment depending on your requirements. Head to the [Steps after installing GitLab](../../install/next_steps.md) documentation for more information. +You may want to configure additional optional features of GitLab depending on your requirements. See [Steps after installing GitLab](../../install/next_steps.md) for more information. NOTE: -Depending on your environment and requirements additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. +Depending on your environment and requirements, additional hardware requirements or adjustments may be required to set up additional features as desired. Refer to the individual pages for more information. -- GitLab From f199612a5e4beceecd8323f17638e975c652f832 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Mon, 12 Aug 2024 13:47:36 +0000 Subject: [PATCH 6/8] Apply 1 suggestion(s) to 1 file(s) Co-authored-by: Achilleas Pipinellis --- doc/administration/reference_architectures/3k_users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 2cc24da5efaf3b..827e687efb2352 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2119,7 +2119,7 @@ meets all of these. Smaller versions of this architecture will be fundamentally but with smaller performance requirements, the following modifications are supported as follows: NOTE: -If not started below no other modifications are supported at this time for lower use counts. +If not stated below, no other modifications are supported for lower use counts. - Lowering node specs: Depending on your user count, you can lower all suggested node specs as desired. However, it's recommended that you don't go lower than the [general requirements](../../install/requirements.md). - Combining select nodes: The following specific components are supported to be combined onto the same nodes to reduce complexity at the cost of some performance: -- GitLab From aea9fb9a99a64e61794e10b9767a470e9e0fc689 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Mon, 12 Aug 2024 14:48:16 +0100 Subject: [PATCH 7/8] Remove duplicate sections in Next Steps page --- doc/install/next_steps.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md index e14ff0d43218f4..a6df9b38d350b0 100644 --- a/doc/install/next_steps.md +++ b/doc/install/next_steps.md @@ -22,17 +22,12 @@ installation. - [Set up runners](https://docs.gitlab.com/runner/): Set up one or more runners, the agents that are responsible for running CI/CD jobs. -- [GitLab Pages](../administration/pages/index.md): Configure GitLab Pages to - allow hosting of static sites. -- [GitLab Registry](../administration/packages/container_registry.md): Set up the - GitLab container registry so every project can have its own space to store Docker - images. -- [GitLab Dependency Proxy](../administration/packages/dependency_proxy.md): Set up the dependency - proxy so you can cache container images from Docker Hub for faster, more reliable builds. ## Container Registry - [Container Registry](../administration/packages/container_registry.md): Integrated container registry to store container images for each GitLab project. +- [GitLab Dependency Proxy](../administration/packages/dependency_proxy.md): Set up the dependency + proxy so you can cache container images from Docker Hub for faster, more reliable builds. ## Pages -- GitLab From e4c99a00dc08d98ec39e25da40360bde7125992a Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 14 Aug 2024 10:33:55 +0000 Subject: [PATCH 8/8] Apply 1 suggestion(s) to 1 file(s) --- doc/install/next_steps.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md index a6df9b38d350b0..346841f5fbcbb5 100644 --- a/doc/install/next_steps.md +++ b/doc/install/next_steps.md @@ -17,6 +17,8 @@ installation. - [SMTP](https://docs.gitlab.com/omnibus/settings/smtp.html): Configure SMTP for proper email notifications support. +- [Incoming email](../administration/incoming_email.md): Configure incoming email + so that users can use email to reply to comments, create new issues and merge requests, etc. ## CI/CD (Runner) -- GitLab