Commit 7677855b authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-remove-notes-ra-docs' into 'master'

Docs: Update RA docs to remove additional notes

See merge request gitlab-org/gitlab!45078
parents 4c85d1e5 e6319a46
...@@ -64,18 +64,17 @@ To set up GitLab and its components to accommodate up to 2,000 users: ...@@ -64,18 +64,17 @@ To set up GitLab and its components to accommodate up to 2,000 users:
## Configure the external load balancer ## Configure the external load balancer
NOTE: **Note:**
This architecture has been tested and validated with [HAProxy](https://www.haproxy.org/).
Although you can use a load balancer with a similar set of features, GitLab
hasn't validated other load balancers.
In an active/active GitLab configuration, you'll need a load balancer to route In an active/active GitLab configuration, you'll need a load balancer to route
traffic to the application servers. The specifics for which load balancer to traffic to the application servers. The specifics on which load balancer to use
use or its exact configuration is out of scope for the GitLab documentation. or its exact configuration is beyond the scope of GitLab documentation. We hope
If you're managing multi-node systems (including GitLab) you'll probably that if you're managing multi-node systems like GitLab, you already have a load
already have a load balancer of choice. Some examples including HAProxy balancer of choice. Some load balancer examples include HAProxy (open-source),
(open-source), F5 Big-IP LTM, and Citrix Net Scaler. This documentation F5 Big-IP LTM, and Citrix Net Scaler. This documentation outline the ports and
includes the ports and protocols for use with GitLab. protocols needed for use with GitLab.
This architecture has been tested and validated with [HAProxy](https://www.haproxy.org/)
as the load balancer. Although other load balancers with similar feature sets
could also be used, those load balancers have not been validated.
The next question is how you will handle SSL in your environment. There are The next question is how you will handle SSL in your environment. There are
several different options: several different options:
...@@ -489,11 +488,10 @@ Name. If you are addressing the Gitaly server by its IP address, you must add it ...@@ -489,11 +488,10 @@ Name. If you are addressing the Gitaly server by its IP address, you must add it
as a Subject Alternative Name to the certificate. as a Subject Alternative Name to the certificate.
[gRPC does not support using an IP address as Common Name in a certificate](https://github.com/grpc/grpc/issues/2691). [gRPC does not support using an IP address as Common Name in a certificate](https://github.com/grpc/grpc/issues/2691).
NOTE: **Note:** It's possible to configure Gitaly servers with both an unencrypted listening
It is possible to configure Gitaly servers with both an address (`listen_addr`) and an encrypted listening address (`tls_listen_addr`)
unencrypted listening address `listen_addr` and an encrypted listening at the same time. This allows you to do a gradual transition from unencrypted to
address `tls_listen_addr` at the same time. This allows you to do a encrypted traffic, if necessary.
gradual transition from unencrypted to encrypted traffic, if necessary.
To configure Gitaly with TLS: To configure Gitaly with TLS:
...@@ -537,14 +535,14 @@ To configure Gitaly with TLS: ...@@ -537,14 +535,14 @@ To configure Gitaly with TLS:
## Configure GitLab Rails ## Configure GitLab Rails
NOTE: **Note:**
In our architectures we run each GitLab Rails node using the Puma webserver
and have its number of workers set to 90% of available CPUs along with four threads. For
nodes that are running Rails with other components the worker value should be reduced
accordingly where we've found 50% achieves a good balance but this is dependent
on workload.
This section describes how to configure the GitLab application (Rails) component. This section describes how to configure the GitLab application (Rails) component.
In our architecture, we run each GitLab Rails node using the Puma webserver, and
have its number of workers set to 90% of available CPUs, with four threads. For
nodes running Rails with other components, the worker value should be reduced
accordingly. We've determined that a worker value of 50% achieves a good balance,
but this is dependent on workload.
On each node perform the following: On each node perform the following:
1. If you're [using NFS](#configure-nfs-optional): 1. If you're [using NFS](#configure-nfs-optional):
...@@ -572,10 +570,10 @@ On each node perform the following: ...@@ -572,10 +570,10 @@ On each node perform the following:
mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data
``` ```
1. Download/install Omnibus GitLab using **steps 1 and 2** from 1. Download and install Omnibus GitLab using **steps 1 and 2** from
[GitLab downloads](https://about.gitlab.com/install/). Do not complete other [GitLab downloads](https://about.gitlab.com/install/). Do not complete other
steps on the download page. steps on the download page.
1. Create/edit `/etc/gitlab/gitlab.rb` and use the following configuration. 1. Create or edit `/etc/gitlab/gitlab.rb` and use the following configuration.
To maintain uniformity of links across nodes, the `external_url` To maintain uniformity of links across nodes, the `external_url`
on the application server should point to the external URL that users will use on the application server should point to the external URL that users will use
to access GitLab. This would be the URL of the [load balancer](#configure-the-external-load-balancer) to access GitLab. This would be the URL of the [load balancer](#configure-the-external-load-balancer)
...@@ -671,12 +669,10 @@ On each node perform the following: ...@@ -671,12 +669,10 @@ On each node perform the following:
[Gitaly node](#configure-gitaly) and [Gitaly node](#configure-gitaly) and
[reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
NOTE: **Note:** When you specify `https` in the `external_url`, as in the previous example,
When you specify `https` in the `external_url`, as in the example GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the
above, GitLab assumes you have SSL certificates in `/etc/gitlab/ssl/`. If certificates aren't present, NGINX will fail to start. For more information, see
certificates are not present, NGINX will fail to start. See the the [NGINX documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https).
[NGINX documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for more information.
### GitLab Rails post-configuration ### GitLab Rails post-configuration
...@@ -688,12 +684,11 @@ for more information. ...@@ -688,12 +684,11 @@ for more information.
sudo gitlab-rake gitlab:db:configure sudo gitlab-rake gitlab:db:configure
``` ```
NOTE: **Note:** If you encounter a `rake aborted!` error message stating that PgBouncer is
If you encounter a `rake aborted!` error stating that PgBouncer is failing to connect to failing to connect to PostgreSQL, it may be that your PgBouncer node's IP
PostgreSQL it may be that your PgBouncer node's IP address is missing from address is missing from PostgreSQL's `trust_auth_cidr_addresses` in `gitlab.rb`
PostgreSQL's `trust_auth_cidr_addresses` in `gitlab.rb` on your database nodes. See on your database nodes. Before proceeding, see
[PgBouncer error `ERROR: pgbouncer cannot connect to server`](troubleshooting.md#pgbouncer-error-error-pgbouncer-cannot-connect-to-server) [PgBouncer error `ERROR: pgbouncer cannot connect to server`](troubleshooting.md#pgbouncer-error-error-pgbouncer-cannot-connect-to-server).
in the Troubleshooting section before proceeding.
1. [Configure fast lookup of authorized SSH keys in the database](../operations/fast_ssh_key_lookup.md). 1. [Configure fast lookup of authorized SSH keys in the database](../operations/fast_ssh_key_lookup.md).
...@@ -893,16 +888,13 @@ functioning backups is encountered. ...@@ -893,16 +888,13 @@ functioning backups is encountered.
## Configure Advanced Search **(STARTER ONLY)** ## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:** You can leverage Elasticsearch and [enable Advanced Search](../../integration/elasticsearch.md)
Elasticsearch cluster design and requirements are dependent on your specific data. for faster, more advanced code search across your entire GitLab instance.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md) Elasticsearch cluster design and requirements are dependent on your specific
data. For recommended best practices about how to set up your Elasticsearch
cluster alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#setup-components"> <a type="button" class="btn btn-default" href="#setup-components">
......
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