Commit 682ec79a authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'clarify-that-health-checks-are-monitoring' into 'master'

Document use of monitoring in external load balancers

See merge request gitlab-org/gitlab!42551
parents 7b753e95 724e9c00
...@@ -167,6 +167,14 @@ added to GitLab to configure SSL certificates. See ...@@ -167,6 +167,14 @@ added to GitLab to configure SSL certificates. See
[NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for details on managing SSL certificates and configuring NGINX. for details on managing SSL certificates and configuring NGINX.
### Readiness checks
Ensure the external load balancer only routes to working services with built
in monitoring endpoints. The [readiness checks](../../user/admin_area/monitoring/health_check.md)
all require [additional configuration](../monitoring/ip_whitelist.md)
on the nodes being checked, otherwise, the external load balancer will not be able to
connect.
### Ports ### Ports
The basic ports to be used are shown in the table below. The basic ports to be used are shown in the table below.
......
...@@ -167,6 +167,14 @@ added to GitLab to configure SSL certificates. See ...@@ -167,6 +167,14 @@ added to GitLab to configure SSL certificates. See
[NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for details on managing SSL certificates and configuring NGINX. for details on managing SSL certificates and configuring NGINX.
### Readiness checks
Ensure the external load balancer only routes to working services with built
in monitoring endpoints. The [readiness checks](../../user/admin_area/monitoring/health_check.md)
all require [additional configuration](../monitoring/ip_whitelist.md)
on the nodes being checked, otherwise, the external load balancer will not be able to
connect.
### Ports ### Ports
The basic ports to be used are shown in the table below. The basic ports to be used are shown in the table below.
......
...@@ -42,7 +42,7 @@ doesn't require you to provision and maintain a node. ...@@ -42,7 +42,7 @@ doesn't require you to provision and maintain a node.
To set up GitLab and its components to accommodate up to 2,000 users: To set up GitLab and its components to accommodate up to 2,000 users:
1. [Configure the external load balancing node](#configure-the-load-balancer) 1. [Configure the external load balancing node](#configure-the-external-load-balancer)
to handle the load balancing of the two GitLab application services nodes. to handle the load balancing of the two GitLab application services nodes.
1. [Configure PostgreSQL](#configure-postgresql), the database for GitLab. 1. [Configure PostgreSQL](#configure-postgresql), the database for GitLab.
1. [Configure Redis](#configure-redis). 1. [Configure Redis](#configure-redis).
...@@ -60,7 +60,7 @@ To set up GitLab and its components to accommodate up to 2,000 users: ...@@ -60,7 +60,7 @@ To set up GitLab and its components to accommodate up to 2,000 users:
storage. You can skip this step if you're not using GitLab Pages (which storage. You can skip this step if you're not using GitLab Pages (which
requires NFS). requires NFS).
## Configure the load balancer ## Configure the external load balancer
NOTE: **Note:** NOTE: **Note:**
This architecture has been tested and validated with [HAProxy](https://www.haproxy.org/). This architecture has been tested and validated with [HAProxy](https://www.haproxy.org/).
...@@ -115,6 +115,14 @@ need to add a configuration to GitLab to configure SSL certificates. For ...@@ -115,6 +115,14 @@ need to add a configuration to GitLab to configure SSL certificates. For
details about managing SSL certificates and configuring NGINX, see the details about managing SSL certificates and configuring NGINX, see the
[NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https). [NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https).
### Readiness checks
Ensure the external load balancer only routes to working services with built
in monitoring endpoints. The [readiness checks](../../user/admin_area/monitoring/health_check.md)
all require [additional configuration](../monitoring/ip_whitelist.md)
on the nodes being checked, otherwise, the external load balancer will not be able to
connect.
### Ports ### Ports
The basic load balancer ports you should use are described in the following The basic load balancer ports you should use are described in the following
...@@ -568,7 +576,7 @@ On each node perform the following: ...@@ -568,7 +576,7 @@ On each node perform the following:
1. Create/edit `/etc/gitlab/gitlab.rb` and use the following configuration. 1. Create/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-load-balancer) to access GitLab. This would be the URL of the [load balancer](#configure-the-external-load-balancer)
which will route traffic to the GitLab application server: which will route traffic to the GitLab application server:
```ruby ```ruby
......
...@@ -162,6 +162,14 @@ added to GitLab to configure SSL certificates. See ...@@ -162,6 +162,14 @@ added to GitLab to configure SSL certificates. See
[NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for details on managing SSL certificates and configuring NGINX. for details on managing SSL certificates and configuring NGINX.
### Readiness checks
Ensure the external load balancer only routes to working services with built
in monitoring endpoints. The [readiness checks](../../user/admin_area/monitoring/health_check.md)
all require [additional configuration](../monitoring/ip_whitelist.md)
on the nodes being checked, otherwise, the external load balancer will not be able to
connect.
### Ports ### Ports
The basic ports to be used are shown in the table below. The basic ports to be used are shown in the table below.
......
...@@ -167,6 +167,14 @@ added to GitLab to configure SSL certificates. See ...@@ -167,6 +167,14 @@ added to GitLab to configure SSL certificates. See
[NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for details on managing SSL certificates and configuring NGINX. for details on managing SSL certificates and configuring NGINX.
### Readiness checks
Ensure the external load balancer only routes to working services with built
in monitoring endpoints. The [readiness checks](../../user/admin_area/monitoring/health_check.md)
all require [additional configuration](../monitoring/ip_whitelist.md)
on the nodes being checked, otherwise, the external load balancer will not be able to
connect.
### Ports ### Ports
The basic ports to be used are shown in the table below. The basic ports to be used are shown in the table below.
......
...@@ -162,6 +162,14 @@ added to GitLab to configure SSL certificates. See ...@@ -162,6 +162,14 @@ added to GitLab to configure SSL certificates. See
[NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX HTTPS documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for details on managing SSL certificates and configuring NGINX. for details on managing SSL certificates and configuring NGINX.
### Readiness checks
Ensure the external load balancer only routes to working services with built
in monitoring endpoints. The [readiness checks](../../user/admin_area/monitoring/health_check.md)
all require [additional configuration](../monitoring/ip_whitelist.md)
on the nodes being checked, otherwise, the external load balancer will not be able to
connect.
### Ports ### Ports
The basic ports to be used are shown in the table below. The basic ports to be used are shown in the table below.
......
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