Commit 63a5eeeb authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-refarch-gitaly' into 'master'

Update Gitaly reference architectures based on 2K

See merge request gitlab-org/gitlab!47308
parents dd6189f3 6c545e5b
...@@ -1356,19 +1356,17 @@ and improved designed. ...@@ -1356,19 +1356,17 @@ and improved designed.
[Gitaly](../gitaly/index.md) server node requirements are dependent on data, [Gitaly](../gitaly/index.md) server node requirements are dependent on data,
specifically the number of projects and those projects' sizes. It's recommended specifically the number of projects and those projects' sizes. It's recommended
that a Gitaly server node stores no more than 5 TB of data. Although this that a Gitaly server node stores no more than 5 TB of data. Depending on your
reference architecture includes a recommendation for the number of Gitaly server repository storage requirements, you may require additional Gitaly server nodes.
nodes to use, depending on your storage requirements, you may require additional
Gitaly server nodes.
Due to Gitaly having notable input and output requirements, we strongly Due to Gitaly having notable input and output requirements, we strongly
recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs should recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs
have a throughput of at least 8,000 input/output operations per second (IOPS) should have a throughput of at least 8,000
for read operations and 2,000 IOPS for write operations. These IOPS values are input/output operations per second (IOPS) for read operations and 2,000 IOPS for
initial recommendations, and may be adjusted to greater or lesser values write operations. These IOPS values are initial recommendations, and may be
depending on the scale of your environment's workload. If you're running the adjusted to greater or lesser values depending on the scale of your
environment on a Cloud provider, refer to their documentation about how to environment's workload. If you're running the environment on a Cloud provider,
configure IOPS correctly. refer to their documentation about how to configure IOPS correctly.
Be sure to note the following items: Be sure to note the following items:
...@@ -1376,8 +1374,8 @@ Be sure to note the following items: ...@@ -1376,8 +1374,8 @@ Be sure to note the following items:
[repository storage paths](../repository_storage_paths.md). [repository storage paths](../repository_storage_paths.md).
- A Gitaly server can host one or more storage paths. - A Gitaly server can host one or more storage paths.
- A GitLab server can use one or more Gitaly server nodes. - A GitLab server can use one or more Gitaly server nodes.
- Gitaly addresses must be specified to be correctly resolvable for _all_ - Gitaly addresses must be specified to be correctly resolvable for all Gitaly
Gitaly clients. clients.
- Gitaly servers must not be exposed to the public internet, as Gitaly's network - Gitaly servers must not be exposed to the public internet, as Gitaly's network
traffic is unencrypted by default. The use of a firewall is highly recommended traffic is unencrypted by default. The use of a firewall is highly recommended
to restrict access to the Gitaly server. Another option is to to restrict access to the Gitaly server. Another option is to
...@@ -1406,8 +1404,8 @@ On each node: ...@@ -1406,8 +1404,8 @@ On each node:
1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
package of your choice. Be sure to follow _only_ installation steps 1 and 2 package of your choice. Be sure to follow _only_ installation steps 1 and 2
on the page, and _do not_ provide the `EXTERNAL_URL` value. on the page, and _do not_ provide the `EXTERNAL_URL` value.
1. Edit `/etc/gitlab/gitlab.rb` to configure the storage paths, enable 1. Edit the Gitaly server node's `/etc/gitlab/gitlab.rb` file to configure
the network listener, and configure the token: storage paths, enable the network listener, and to configure the token:
<!-- <!--
updates to following example must also be made at updates to following example must also be made at
......
...@@ -1356,19 +1356,17 @@ and improved designed. ...@@ -1356,19 +1356,17 @@ and improved designed.
[Gitaly](../gitaly/index.md) server node requirements are dependent on data, [Gitaly](../gitaly/index.md) server node requirements are dependent on data,
specifically the number of projects and those projects' sizes. It's recommended specifically the number of projects and those projects' sizes. It's recommended
that a Gitaly server node stores no more than 5 TB of data. Although this that a Gitaly server node stores no more than 5 TB of data. Depending on your
reference architecture includes a recommendation for the number of Gitaly server repository storage requirements, you may require additional Gitaly server nodes.
nodes to use, depending on your storage requirements, you may require additional
Gitaly server nodes.
Due to Gitaly having notable input and output requirements, we strongly Due to Gitaly having notable input and output requirements, we strongly
recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs should recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs
have a throughput of at least 8,000 input/output operations per second (IOPS) should have a throughput of at least 8,000
for read operations and 2,000 IOPS for write operations. These IOPS values are input/output operations per second (IOPS) for read operations and 2,000 IOPS for
initial recommendations, and may be adjusted to greater or lesser values write operations. These IOPS values are initial recommendations, and may be
depending on the scale of your environment's workload. If you're running the adjusted to greater or lesser values depending on the scale of your
environment on a Cloud provider, refer to their documentation about how to environment's workload. If you're running the environment on a Cloud provider,
configure IOPS correctly. refer to their documentation about how to configure IOPS correctly.
Be sure to note the following items: Be sure to note the following items:
...@@ -1376,8 +1374,8 @@ Be sure to note the following items: ...@@ -1376,8 +1374,8 @@ Be sure to note the following items:
[repository storage paths](../repository_storage_paths.md). [repository storage paths](../repository_storage_paths.md).
- A Gitaly server can host one or more storage paths. - A Gitaly server can host one or more storage paths.
- A GitLab server can use one or more Gitaly server nodes. - A GitLab server can use one or more Gitaly server nodes.
- Gitaly addresses must be specified to be correctly resolvable for _all_ - Gitaly addresses must be specified to be correctly resolvable for all Gitaly
Gitaly clients. clients.
- Gitaly servers must not be exposed to the public internet, as Gitaly's network - Gitaly servers must not be exposed to the public internet, as Gitaly's network
traffic is unencrypted by default. The use of a firewall is highly recommended traffic is unencrypted by default. The use of a firewall is highly recommended
to restrict access to the Gitaly server. Another option is to to restrict access to the Gitaly server. Another option is to
...@@ -1406,8 +1404,8 @@ On each node: ...@@ -1406,8 +1404,8 @@ On each node:
1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
package of your choice. Be sure to follow _only_ installation steps 1 and 2 package of your choice. Be sure to follow _only_ installation steps 1 and 2
on the page, and _do not_ provide the `EXTERNAL_URL` value. on the page, and _do not_ provide the `EXTERNAL_URL` value.
1. Edit `/etc/gitlab/gitlab.rb` to configure the storage paths, enable 1. Edit the Gitaly server node's `/etc/gitlab/gitlab.rb` file to configure
the network listener, and configure the token: storage paths, enable the network listener, and to configure the token:
<!-- <!--
updates to following example must also be made at updates to following example must also be made at
......
...@@ -1067,19 +1067,17 @@ and improved designed. ...@@ -1067,19 +1067,17 @@ and improved designed.
[Gitaly](../gitaly/index.md) server node requirements are dependent on data, [Gitaly](../gitaly/index.md) server node requirements are dependent on data,
specifically the number of projects and those projects' sizes. It's recommended specifically the number of projects and those projects' sizes. It's recommended
that a Gitaly server node stores no more than 5 TB of data. Although this that a Gitaly server node stores no more than 5 TB of data. Depending on your
reference architecture includes a recommendation for the number of Gitaly server repository storage requirements, you may require additional Gitaly server nodes.
nodes to use, depending on your storage requirements, you may require additional
Gitaly server nodes.
Due to Gitaly having notable input and output requirements, we strongly Due to Gitaly having notable input and output requirements, we strongly
recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs should recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs
have a throughput of at least 8,000 input/output operations per second (IOPS) should have a throughput of at least 8,000
for read operations and 2,000 IOPS for write operations. These IOPS values are input/output operations per second (IOPS) for read operations and 2,000 IOPS for
initial recommendations, and may be adjusted to greater or lesser values write operations. These IOPS values are initial recommendations, and may be
depending on the scale of your environment's workload. If you're running the adjusted to greater or lesser values depending on the scale of your
environment on a Cloud provider, refer to their documentation about how to environment's workload. If you're running the environment on a Cloud provider,
configure IOPS correctly. refer to their documentation about how to configure IOPS correctly.
Be sure to note the following items: Be sure to note the following items:
...@@ -1087,8 +1085,8 @@ Be sure to note the following items: ...@@ -1087,8 +1085,8 @@ Be sure to note the following items:
[repository storage paths](../repository_storage_paths.md). [repository storage paths](../repository_storage_paths.md).
- A Gitaly server can host one or more storage paths. - A Gitaly server can host one or more storage paths.
- A GitLab server can use one or more Gitaly server nodes. - A GitLab server can use one or more Gitaly server nodes.
- Gitaly addresses must be specified to be correctly resolvable for _all_ - Gitaly addresses must be specified to be correctly resolvable for all Gitaly
Gitaly clients. clients.
- Gitaly servers must not be exposed to the public internet, as Gitaly's network - Gitaly servers must not be exposed to the public internet, as Gitaly's network
traffic is unencrypted by default. The use of a firewall is highly recommended traffic is unencrypted by default. The use of a firewall is highly recommended
to restrict access to the Gitaly server. Another option is to to restrict access to the Gitaly server. Another option is to
...@@ -1117,8 +1115,8 @@ On each node: ...@@ -1117,8 +1115,8 @@ On each node:
1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
package of your choice. Be sure to follow _only_ installation steps 1 and 2 package of your choice. Be sure to follow _only_ installation steps 1 and 2
on the page, and _do not_ provide the `EXTERNAL_URL` value. on the page, and _do not_ provide the `EXTERNAL_URL` value.
1. Edit `/etc/gitlab/gitlab.rb` to configure the storage paths, enable 1. Edit the Gitaly server node's `/etc/gitlab/gitlab.rb` file to configure
the network listener, and configure the token: storage paths, enable the network listener, and to configure the token:
<!-- <!--
updates to following example must also be made at updates to following example must also be made at
......
...@@ -1356,19 +1356,17 @@ and improved designed. ...@@ -1356,19 +1356,17 @@ and improved designed.
[Gitaly](../gitaly/index.md) server node requirements are dependent on data, [Gitaly](../gitaly/index.md) server node requirements are dependent on data,
specifically the number of projects and those projects' sizes. It's recommended specifically the number of projects and those projects' sizes. It's recommended
that a Gitaly server node stores no more than 5 TB of data. Although this that a Gitaly server node stores no more than 5 TB of data. Depending on your
reference architecture includes a recommendation for the number of Gitaly server repository storage requirements, you may require additional Gitaly server nodes.
nodes to use, depending on your storage requirements, you may require additional
Gitaly server nodes.
Due to Gitaly having notable input and output requirements, we strongly Due to Gitaly having notable input and output requirements, we strongly
recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs should recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs
have a throughput of at least 8,000 input/output operations per second (IOPS) should have a throughput of at least 8,000
for read operations and 2,000 IOPS for write operations. These IOPS values are input/output operations per second (IOPS) for read operations and 2,000 IOPS for
initial recommendations, and may be adjusted to greater or lesser values write operations. These IOPS values are initial recommendations, and may be
depending on the scale of your environment's workload. If you're running the adjusted to greater or lesser values depending on the scale of your
environment on a Cloud provider, refer to their documentation about how to environment's workload. If you're running the environment on a Cloud provider,
configure IOPS correctly. refer to their documentation about how to configure IOPS correctly.
Be sure to note the following items: Be sure to note the following items:
...@@ -1376,8 +1374,8 @@ Be sure to note the following items: ...@@ -1376,8 +1374,8 @@ Be sure to note the following items:
[repository storage paths](../repository_storage_paths.md). [repository storage paths](../repository_storage_paths.md).
- A Gitaly server can host one or more storage paths. - A Gitaly server can host one or more storage paths.
- A GitLab server can use one or more Gitaly server nodes. - A GitLab server can use one or more Gitaly server nodes.
- Gitaly addresses must be specified to be correctly resolvable for _all_ - Gitaly addresses must be specified to be correctly resolvable for all Gitaly
Gitaly clients. clients.
- Gitaly servers must not be exposed to the public internet, as Gitaly's network - Gitaly servers must not be exposed to the public internet, as Gitaly's network
traffic is unencrypted by default. The use of a firewall is highly recommended traffic is unencrypted by default. The use of a firewall is highly recommended
to restrict access to the Gitaly server. Another option is to to restrict access to the Gitaly server. Another option is to
...@@ -1406,8 +1404,8 @@ On each node: ...@@ -1406,8 +1404,8 @@ On each node:
1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
package of your choice. Be sure to follow _only_ installation steps 1 and 2 package of your choice. Be sure to follow _only_ installation steps 1 and 2
on the page, and _do not_ provide the `EXTERNAL_URL` value. on the page, and _do not_ provide the `EXTERNAL_URL` value.
1. Edit `/etc/gitlab/gitlab.rb` to configure the storage paths, enable 1. Edit the Gitaly server node's `/etc/gitlab/gitlab.rb` file to configure
the network listener, and configure the token: storage paths, enable the network listener, and to configure the token:
<!-- <!--
updates to following example must also be made at updates to following example must also be made at
......
...@@ -1066,19 +1066,17 @@ and improved designed. ...@@ -1066,19 +1066,17 @@ and improved designed.
[Gitaly](../gitaly/index.md) server node requirements are dependent on data, [Gitaly](../gitaly/index.md) server node requirements are dependent on data,
specifically the number of projects and those projects' sizes. It's recommended specifically the number of projects and those projects' sizes. It's recommended
that a Gitaly server node stores no more than 5 TB of data. Although this that a Gitaly server node stores no more than 5 TB of data. Depending on your
reference architecture includes a recommendation for the number of Gitaly server repository storage requirements, you may require additional Gitaly server nodes.
nodes to use, depending on your storage requirements, you may require additional
Gitaly server nodes.
Due to Gitaly having notable input and output requirements, we strongly Due to Gitaly having notable input and output requirements, we strongly
recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs should recommend that all Gitaly nodes use solid-state drives (SSDs). These SSDs
have a throughput of at least 8,000 input/output operations per second (IOPS) should have a throughput of at least 8,000
for read operations and 2,000 IOPS for write operations. These IOPS values are input/output operations per second (IOPS) for read operations and 2,000 IOPS for
initial recommendations, and may be adjusted to greater or lesser values write operations. These IOPS values are initial recommendations, and may be
depending on the scale of your environment's workload. If you're running the adjusted to greater or lesser values depending on the scale of your
environment on a Cloud provider, refer to their documentation about how to environment's workload. If you're running the environment on a Cloud provider,
configure IOPS correctly. refer to their documentation about how to configure IOPS correctly.
Be sure to note the following items: Be sure to note the following items:
...@@ -1086,8 +1084,8 @@ Be sure to note the following items: ...@@ -1086,8 +1084,8 @@ Be sure to note the following items:
[repository storage paths](../repository_storage_paths.md). [repository storage paths](../repository_storage_paths.md).
- A Gitaly server can host one or more storage paths. - A Gitaly server can host one or more storage paths.
- A GitLab server can use one or more Gitaly server nodes. - A GitLab server can use one or more Gitaly server nodes.
- Gitaly addresses must be specified to be correctly resolvable for _all_ - Gitaly addresses must be specified to be correctly resolvable for all Gitaly
Gitaly clients. clients.
- Gitaly servers must not be exposed to the public internet, as Gitaly's network - Gitaly servers must not be exposed to the public internet, as Gitaly's network
traffic is unencrypted by default. The use of a firewall is highly recommended traffic is unencrypted by default. The use of a firewall is highly recommended
to restrict access to the Gitaly server. Another option is to to restrict access to the Gitaly server. Another option is to
...@@ -1116,8 +1114,8 @@ On each node: ...@@ -1116,8 +1114,8 @@ On each node:
1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
package of your choice. Be sure to follow _only_ installation steps 1 and 2 package of your choice. Be sure to follow _only_ installation steps 1 and 2
on the page, and _do not_ provide the `EXTERNAL_URL` value. on the page, and _do not_ provide the `EXTERNAL_URL` value.
1. Edit `/etc/gitlab/gitlab.rb` to configure the storage paths, enable 1. Edit the Gitaly server node's `/etc/gitlab/gitlab.rb` file to configure
the network listener, and configure the token: storage paths, enable the network listener, and to configure the token:
<!-- <!--
updates to following example must also be made at updates to following example must also be made at
......
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