Commit 284d47a6 authored by Grant Young's avatar Grant Young

Review updates for HA doc cleanup

Better titles and some grammar updates
parent 7f8b16f1
...@@ -54,10 +54,6 @@ scenario, the [new repository indexer](../../integration/elasticsearch.md#elasti ...@@ -54,10 +54,6 @@ scenario, the [new repository indexer](../../integration/elasticsearch.md#elasti
needs to be enabled in your GitLab configuration. [Since GitLab v12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481), needs to be enabled in your GitLab configuration. [Since GitLab v12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481),
the new indexer becomes the default and no configuration is required. the new indexer becomes the default and no configuration is required.
NOTE: **Note:** While Gitaly can be used as a replacement for NFS, it's not recommended
to use EFS as it may impact GitLab's performance. Review the [relevant documentation](../high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs)
for more details.
### Network architecture ### Network architecture
The following list depicts what the network architecture of Gitaly is: The following list depicts what the network architecture of Gitaly is:
......
...@@ -23,32 +23,32 @@ in from some of our customers. ...@@ -23,32 +23,32 @@ in from some of our customers.
## Recommended Setups based on number of users ## Recommended Setups based on number of users
- 1 - 1000 Users: A single node Omnibus setup with frequent backups. Refer to the [requirements page](https://docs.gitlab.com/ee/install/requirements.html) for further details of the specs you will require. - 1 - 1000 Users: A single node Omnibus setup with frequent backups. Refer to the [requirements page](https://docs.gitlab.com/ee/install/requirements.html) for further details of the specs you will require.
- 2000 - 50000+ Users: A scaled HA environment based on one of our [Reference Architectures](#reference-architecture-recommendations) below. - 2000 - 50000+ Users: A scaled HA environment based on one of our [Reference Architectures](#reference-architectures) below.
## GitLab Components and Installation Instructions ## GitLab Components and Configuration Instructions
Before we get into the architectures we should first detail the relevant GitLab The GitLab application depends on the following [components](https://docs.gitlab.com/ee/development/architecture.html#component-diagram)
[components](https://docs.gitlab.com/ee/development/architecture.html#component-diagram) and and services. They are included in the reference architectures along with our
services it depends on along with our recommendations. They are presented in the order you would recommendations for their use and configuration. They are presented in the order
typically install them: in which you would typically configure them.
| Component | Description | Install Instructions | | Component | Description | Configuration Instructions |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| [Load Balancer(s)](load_balancer.md)[^6] | Handles load balancing for the GitLab nodes where required. | [Link](load_balancer.md) | | [Load Balancer(s)](load_balancer.md)[^6] | Handles load balancing for the GitLab nodes where required. | [Link](load_balancer.md) |
| [Consul](https://docs.gitlab.com/ee/development/architecture.html#consul)[^3] | Service discovery and health checks/failover | [Link](consul.md) | | [Consul](https://docs.gitlab.com/ee/development/architecture.html#consul)[^3] | Service discovery and health checks/failover | [Link](consul.md) |
| [PostgreSQL](https://docs.gitlab.com/ee/development/architecture.html#postgresql) | Database | [Link](database.md) | | [PostgreSQL](https://docs.gitlab.com/ee/development/architecture.html#postgresql) | Database | [Link](database.md) |
| [PgBouncer](https://docs.gitlab.com/ee/development/architecture.html#pgbouncer) | Database Pool Manager | [Link](pgbouncer.md) | | [PgBouncer](https://docs.gitlab.com/ee/development/architecture.html#pgbouncer) | Database Pool Manager | [Link](pgbouncer.md) |
| [Redis](https://docs.gitlab.com/ee/development/architecture.html#redis)[^3] with Redis Sentinel | Key/Value store for shared data with HA watcher service | [Link](redis.md) | | [Redis](https://docs.gitlab.com/ee/development/architecture.html#redis)[^3] with Redis Sentinel | Key/Value store for shared data with HA watcher service | [Link](redis.md) |
| [Gitaly](https://docs.gitlab.com/ee/development/architecture.html#gitaly)[^2] [^5] [^7] | Provides high-level storage and RPC access to Git repositories. | [Link](gitaly.md) | | [Gitaly](https://docs.gitlab.com/ee/development/architecture.html#gitaly)[^2] [^5] [^7] | Recommended high-level storage for Git repository data. | [Link](gitaly.md) |
| [Sidekiq](https://docs.gitlab.com/ee/development/architecture.html#sidekiq) | Asynchronous/Background jobs | | | [Sidekiq](https://docs.gitlab.com/ee/development/architecture.html#sidekiq) | Asynchronous/Background jobs | |
| [S3 Object Storage service](object_storage.md)[^4] | Recommended store for shared data objects such as LFS, Uploads, Artifacts, etc... | [Link](object_storage.md) | | [S3 Object Storage service](object_storage.md)[^4] | Recommended store for shared data objects such as LFS, Uploads, Artifacts, etc... | [Link](object_storage.md) |
| [GitLab application nodes](https://docs.gitlab.com/ee/development/architecture.html#unicorn)[^1] | (Unicorn / Puma, Workhorse) - Web-requests (UI, API, Git over HTTP) | [Link](gitlab.md) | | [GitLab application nodes](https://docs.gitlab.com/ee/development/architecture.html#unicorn)[^1] | (Unicorn / Puma, Workhorse) - Web-requests (UI, API, Git over HTTP) | [Link](gitlab.md) |
| [NFS](nfs.md)[^5] [^7] | Shared disk storage service. Can be used as an alternative for Gitaly or Object Storage (unrecommended). Required for GitLab Pages. | [Link](nfs.md) | | [NFS](nfs.md)[^5] [^7] | Shared disk storage service. Can be used as an alternative for Gitaly or Object Storage. Required for GitLab Pages. | [Link](nfs.md) |
| [Prometheus](https://docs.gitlab.com/ee/development/architecture.html#prometheus) and [Grafana](https://docs.gitlab.com/ee/development/architecture.html#grafana) | GitLab environment monitoring | [Link](monitoring_node.md) | | [Prometheus](https://docs.gitlab.com/ee/development/architecture.html#prometheus) and [Grafana](https://docs.gitlab.com/ee/development/architecture.html#grafana) | GitLab environment monitoring | [Link](monitoring_node.md) |
In some cases, components can be combined on the same nodes to reduce complexity as well. In some cases, components can be combined on the same nodes to reduce complexity as well.
## Reference Architecture Recommendations ## Reference Architectures
In this section we'll detail the Reference Architectures that can support large numbers In this section we'll detail the Reference Architectures that can support large numbers
of users. These were built, tested and verified by our Quality and Support teams. of users. These were built, tested and verified by our Quality and Support teams.
...@@ -216,8 +216,8 @@ On different cloud vendors a best effort like for like can be used. ...@@ -216,8 +216,8 @@ On different cloud vendors a best effort like for like can be used.
[Packages](../packages/index.md#using-object-storage) (Optional Feature), [Packages](../packages/index.md#using-object-storage) (Optional Feature),
[Dependency Proxy](../packages/dependency_proxy.md#using-object-storage) (Optional Feature). [Dependency Proxy](../packages/dependency_proxy.md#using-object-storage) (Optional Feature).
[^5]: NFS can be used as an alternative for both repository data and object storage but this isn't [^5]: NFS can be used as an alternative for both repository data (replacing Gitaly) and
typically recommended for performance reasons. Note however it is required for object storage but this isn't typically recommended for performance reasons. Note however it is required for
[GitLab Pages](https://gitlab.com/gitlab-org/gitlab-pages/issues/196). [GitLab Pages](https://gitlab.com/gitlab-org/gitlab-pages/issues/196).
[^6]: Our architectures have been tested and validated with [HAProxy](https://www.haproxy.org/) [^6]: Our architectures have been tested and validated with [HAProxy](https://www.haproxy.org/)
......
...@@ -19,7 +19,7 @@ See [Running Gitaly on its own server](../gitaly/index.md#running-gitaly-on-its- ...@@ -19,7 +19,7 @@ See [Running Gitaly on its own server](../gitaly/index.md#running-gitaly-on-its-
in Gitaly documentation. in Gitaly documentation.
Continue configuration of other components by going back to the Continue configuration of other components by going back to the
[Scaling and High Availability](README.md#gitlab-components-and-install-instructions) page. [Scaling and High Availability](README.md#gitlab-components-and-configuration-instructions) page.
## Enable Monitoring ## Enable Monitoring
......
...@@ -84,7 +84,7 @@ Advanced configuration options are supported and can be added if ...@@ -84,7 +84,7 @@ Advanced configuration options are supported and can be added if
needed. needed.
Continue configuration of other components by going back to the Continue configuration of other components by going back to the
[Scaling and High Availability](README.md#gitlab-components-and-install-instructions) page. [Scaling and High Availability](README.md#gitlab-components-and-configuration-instructions) page.
### High Availability with GitLab Omnibus **(PREMIUM ONLY)** ### High Availability with GitLab Omnibus **(PREMIUM ONLY)**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment