Commit a39adfb4 authored by Lee Matos's avatar Lee Matos

clarify DB/Redis HA docs

parent e7b6f39f
...@@ -27,7 +27,7 @@ If you use a cloud-managed service, or provide your own PostgreSQL: ...@@ -27,7 +27,7 @@ If you use a cloud-managed service, or provide your own PostgreSQL:
steps on the download page. steps on the download page.
1. Create/edit `/etc/gitlab/gitlab.rb` and use the following configuration. 1. Create/edit `/etc/gitlab/gitlab.rb` and use the following configuration.
Be sure to change the `external_url` to match your eventual GitLab front-end Be sure to change the `external_url` to match your eventual GitLab front-end
URL. URL. If there is a directive listed below that you do not see in the configuration, be sure to add it.
```ruby ```ruby
external_url 'https://gitlab.example.com' external_url 'https://gitlab.example.com'
...@@ -39,6 +39,8 @@ If you use a cloud-managed service, or provide your own PostgreSQL: ...@@ -39,6 +39,8 @@ If you use a cloud-managed service, or provide your own PostgreSQL:
unicorn['enable'] = false unicorn['enable'] = false
sidekiq['enable'] = false sidekiq['enable'] = false
redis['enable'] = false redis['enable'] = false
prometheus['enable'] = false
gitaly['enable'] = false
gitlab_workhorse['enable'] = false gitlab_workhorse['enable'] = false
mailroom['enable'] = false mailroom['enable'] = false
......
...@@ -42,10 +42,10 @@ instances run in different machines. If you fail to provision the machines in ...@@ -42,10 +42,10 @@ instances run in different machines. If you fail to provision the machines in
that specific way, any issue with the shared environment can bring your entire that specific way, any issue with the shared environment can bring your entire
setup down. setup down.
It is OK to run a Sentinel along with a master or slave Redis instance. It is OK to run a Sentinel alongside of a master or slave Redis instance.
No more than one Sentinel in the same machine though. There should be no more than one Sentinel on the same machine though.
You also need to take in consideration the underlying network topology, You also need to take into consideration the underlying network topology,
making sure you have redundant connectivity between Redis / Sentinel and making sure you have redundant connectivity between Redis / Sentinel and
GitLab instances, otherwise the networks will become a single point of GitLab instances, otherwise the networks will become a single point of
failure. failure.
...@@ -113,7 +113,7 @@ the Omnibus GitLab package in `5` **independent** machines, both with ...@@ -113,7 +113,7 @@ the Omnibus GitLab package in `5` **independent** machines, both with
### Redis setup overview ### Redis setup overview
You must have at least `3` Redis servers: `1` Master, `2` Slaves, and they You must have at least `3` Redis servers: `1` Master, `2` Slaves, and they
need to be each in a independent machine (see explanation above). need to each be on independent machines (see explanation above).
You can have additional Redis nodes, that will help survive a situation You can have additional Redis nodes, that will help survive a situation
where more nodes goes down. Whenever there is only `2` nodes online, a failover where more nodes goes down. Whenever there is only `2` nodes online, a failover
...@@ -232,7 +232,7 @@ Pick the one that suits your needs. ...@@ -232,7 +232,7 @@ Pick the one that suits your needs.
This is the section where we install and setup the new Redis instances. This is the section where we install and setup the new Redis instances.
>**Notes:** >**Notes:**
- We assume that you install GitLab and all HA components from scratch. If you - We assume that you have installed GitLab and all HA components from scratch. If you
already have it installed and running, read how to already have it installed and running, read how to
[switch from a single-machine installation to Redis HA](#switching-from-an-existing-single-machine-installation-to-redis-ha). [switch from a single-machine installation to Redis HA](#switching-from-an-existing-single-machine-installation-to-redis-ha).
- Redis nodes (both master and slaves) will need the same password defined in - Redis nodes (both master and slaves) will need the same password defined in
...@@ -245,10 +245,9 @@ The prerequisites for a HA Redis setup are the following: ...@@ -245,10 +245,9 @@ The prerequisites for a HA Redis setup are the following:
1. Provision the minimum required number of instances as specified in the 1. Provision the minimum required number of instances as specified in the
[recommended setup](#recommended-setup) section. [recommended setup](#recommended-setup) section.
1. **Do NOT** install Redis or Redis Sentinel in the same machines your 1. We **Do not** recommend installing Redis or Redis Sentinel in the same machines your
GitLab application is running on. You can however opt in to install Redis GitLab application is running on as this weakens your HA configuration. You can however opt in to install Redis
and Sentinel in the same machine (each in independent ones is recommended and Sentinel in the same machine.
though).
1. All Redis nodes must be able to talk to each other and accept incoming 1. All Redis nodes must be able to talk to each other and accept incoming
connections over Redis (`6379`) and Sentinel (`26379`) ports (unless you connections over Redis (`6379`) and Sentinel (`26379`) ports (unless you
change the default ones). change the default ones).
......
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