2016-04-22 18:18:06 +00:00
|
|
|
# Configuring Redis for GitLab HA
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
You can choose to install and manage Redis yourself, or you can use the one
|
|
|
|
that comes bundled with GitLab Omnibus packages.
|
2016-04-22 18:18:06 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
> **Note:** Redis does not require authentication by default. See
|
|
|
|
[Redis Security](http://redis.io/topics/security) documentation for more
|
|
|
|
information. We recommend using a combination of a Redis password and tight
|
|
|
|
firewall rules to secure your Redis service.
|
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
|
|
**Table of Contents**
|
|
|
|
|
|
|
|
- [Configure your own Redis server](#configure-your-own-redis-server)
|
|
|
|
- [Configure Redis using Omnibus](#configure-redis-using-omnibus)
|
|
|
|
- [Experimental Redis Sentinel support](#experimental-redis-sentinel-support)
|
|
|
|
- [Redis setup](#redis-setup)
|
|
|
|
- [Source install](#source-install)
|
|
|
|
- [Omnibus Install](#omnibus-install)
|
|
|
|
- [Troubleshooting Replication](#troubleshooting-replication)
|
|
|
|
- [Sentinel](#sentinel)
|
|
|
|
- [Sentinel setup (Community Edition)](#sentinel-setup-community-edition)
|
|
|
|
- [Sentinel setup (EE Only)](#sentinel-setup-ee-only)
|
|
|
|
- [GitLab setup](#gitlab-setup)
|
|
|
|
- [Sentinel troubleshooting](#sentinel-troubleshooting)
|
|
|
|
- [Omnibus install](#omnibus-install)
|
|
|
|
- [Source install](#source-install-1)
|
|
|
|
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
## Configure your own Redis server
|
|
|
|
|
|
|
|
If you're hosting GitLab on a cloud provider, you can optionally use a
|
|
|
|
managed service for Redis. For example, AWS offers a managed ElastiCache service
|
|
|
|
that runs Redis.
|
|
|
|
|
|
|
|
## Configure Redis using Omnibus
|
|
|
|
|
|
|
|
If you don't want to bother setting up your own Redis server, you can use the
|
|
|
|
one bundled with Omnibus. In this case, you should disable all services except
|
|
|
|
Redis.
|
|
|
|
|
|
|
|
1. Download/install GitLab Omnibus using **steps 1 and 2** from
|
|
|
|
[GitLab downloads](https://about.gitlab.com/downloads). Do not complete other
|
|
|
|
steps on the download page.
|
|
|
|
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
|
|
|
|
URL:
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
external_url 'https://gitlab.example.com'
|
|
|
|
|
|
|
|
# Disable all services except Redis
|
|
|
|
redis['enable'] = true
|
|
|
|
bootstrap['enable'] = false
|
|
|
|
nginx['enable'] = false
|
|
|
|
unicorn['enable'] = false
|
|
|
|
sidekiq['enable'] = false
|
|
|
|
postgresql['enable'] = false
|
2016-10-15 03:40:15 +00:00
|
|
|
gitlab_rails['enable'] = false
|
2016-07-19 11:27:50 +00:00
|
|
|
gitlab_workhorse['enable'] = false
|
|
|
|
mailroom['enable'] = false
|
|
|
|
|
|
|
|
# Redis configuration
|
|
|
|
redis['port'] = 6379
|
|
|
|
redis['bind'] = '0.0.0.0'
|
|
|
|
|
|
|
|
# If you wish to use Redis authentication (recommended)
|
2016-10-06 23:47:22 +00:00
|
|
|
redis['password'] = 'redis-password-goes-here'
|
2016-07-19 11:27:50 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
1. Run `sudo gitlab-ctl reconfigure` to install and configure PostgreSQL.
|
|
|
|
|
|
|
|
> **Note**: This `reconfigure` step will result in some errors.
|
|
|
|
That's OK - don't be alarmed.
|
|
|
|
|
|
|
|
1. Run `touch /etc/gitlab/skip-auto-migrations` to prevent database migrations
|
|
|
|
from running on upgrade. Only the primary GitLab application server should
|
|
|
|
handle migrations.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-08-02 01:25:28 +00:00
|
|
|
## Experimental Redis Sentinel support
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
> [Introduced][ce-1877] in GitLab 8.11, improved in 8.13.
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-08-04 16:55:24 +00:00
|
|
|
Since GitLab 8.11, you can configure a list of Redis Sentinel servers that
|
2016-07-14 01:57:47 +00:00
|
|
|
will monitor a group of Redis servers to provide you with a standard failover
|
|
|
|
support.
|
|
|
|
|
|
|
|
To get a better understanding on how to correctly setup Sentinel, please read
|
2016-07-19 11:27:50 +00:00
|
|
|
the [Redis Sentinel documentation](http://redis.io/topics/sentinel) first, as
|
|
|
|
failing to configure it correctly can lead to data loss.
|
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
Redis Sentinel can handle the most important tasks in a HA environment to help
|
|
|
|
keep servers online with minimal to no downtime:
|
|
|
|
|
|
|
|
- Monitors master and slave instances to see if they are available
|
|
|
|
- Promote a slave to master when the master fails.
|
|
|
|
- Demote a master to slave when failed master comes back online (to prevent
|
|
|
|
data-partitioning).
|
|
|
|
- Can be queried by clients to always connect to the correct master server.
|
|
|
|
|
|
|
|
There is currently one exception to the Sentinel support: `mail_room`, the
|
|
|
|
component that processes incoming emails. It doesn't support Sentinel yet, but
|
|
|
|
we hope to integrate a future release that does support it soon.
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
The configuration consists of three parts:
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
- Setup Redis Master and Slave nodes
|
|
|
|
- Setup Sentinel nodes
|
|
|
|
- Setup GitLab
|
|
|
|
|
|
|
|
> **IMPORTANT**: You need at least 3 independent machines: physical, or VMs
|
|
|
|
running into distinct physical machines. If you fail to provision the
|
|
|
|
machines in that specific way, any issue with the shared environment can
|
|
|
|
bring your entire setup down.
|
2016-07-19 11:27:50 +00:00
|
|
|
|
|
|
|
Read carefully how to configure those components below.
|
|
|
|
|
2016-08-02 01:25:28 +00:00
|
|
|
### Redis setup
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
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).
|
|
|
|
|
2016-07-14 01:57:47 +00:00
|
|
|
They should be configured the same way and with similar server specs, as
|
2016-10-15 03:40:15 +00:00
|
|
|
in a failover situation, any `Slave` can be elected as the new `Master` by
|
2016-07-19 11:27:50 +00:00
|
|
|
the Sentinel servers.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
With Sentinel, you must define a password to protect the access as both
|
|
|
|
Sentinel instances and other redis instances should be able to talk to
|
|
|
|
each other over the network.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
You'll need to define both `requirepass` and `masterauth` in all
|
|
|
|
nodes because they can be re-configured at any time by the Sentinels
|
|
|
|
during a failover, and change it's status as `Master` or `Slave`.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
Initial `Slave` nodes will have in `redis.conf` an additional `slaveof` line
|
|
|
|
pointing to the initial `Master`.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
#### Source install
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
**Master Redis instance**
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
You need to make the following changes in `redis.conf`:
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
1. Define a `bind` address pointing to a local IP that your other machines
|
|
|
|
can reach you. If you really need to bind to an external acessible IP, make
|
|
|
|
sure you add extra firewall rules to prevent unauthorized access:
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
```conf
|
|
|
|
# By default, if no "bind" configuration directive is specified, Redis listens
|
|
|
|
# for connections from all the network interfaces available on the server.
|
|
|
|
# It is possible to listen to just one or multiple selected interfaces using
|
|
|
|
# the "bind" configuration directive, followed by one or more IP addresses.
|
|
|
|
#
|
|
|
|
# Examples:
|
|
|
|
#
|
|
|
|
# bind 192.168.1.100 10.0.0.1
|
|
|
|
# bind 127.0.0.1 ::1
|
|
|
|
bind 0.0.0.0 # This will bind to all interfaces
|
|
|
|
```
|
|
|
|
|
|
|
|
1. Define a `port` to force redis to listin on TCP so other machines can
|
|
|
|
connect to it:
|
|
|
|
|
|
|
|
```conf
|
|
|
|
# Accept connections on the specified port, default is 6379 (IANA #815344).
|
|
|
|
# If port 0 is specified Redis will not listen on a TCP socket.
|
|
|
|
port 6379
|
|
|
|
```
|
|
|
|
|
|
|
|
1. Set up password authentication (use the same password in all nodes)
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
```conf
|
2016-10-15 03:40:15 +00:00
|
|
|
requirepass "redis-password-goes-here"
|
|
|
|
masterauth "redis-password-goes-here"
|
2016-07-19 11:27:50 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
1. Restart the Redis services for the changes to take effect.
|
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
**Slave Redis instance**
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
1. Follow same instructions from master with the extra change in `redis.conf`:
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
```conf
|
|
|
|
# IP and port of the master Redis server
|
|
|
|
slaveof 10.10.10.10 6379
|
|
|
|
```
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
1. Restart the Redis services for the changes to take effect.
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
#### Omnibus Install
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
You need to install the omnibus package in 3 different and independent machines.
|
|
|
|
We will elect one as the initial `Master` and the other 2 as `Slaves`.
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
If you are migrating from a single machine install, you may want to setup the
|
|
|
|
machines as Slaves, pointing to the original machine as `Master`, to migrate
|
|
|
|
the data first, and than switch to this setup.
|
2016-08-02 01:25:28 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
To disable redis in the single install, edit `/etc/gitlab/gitlab.rb`:
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
redis['enable'] = false
|
|
|
|
```
|
|
|
|
|
|
|
|
**Master Redis instances**
|
|
|
|
|
|
|
|
You need to make the following changes in `/etc/gitlab/gitlab.rb`:
|
|
|
|
|
|
|
|
1. Define a `redis['bind']` address pointing to a local IP that your other machines
|
|
|
|
can reach you. If you really need to bind to an external acessible IP, make
|
|
|
|
sure you add extra firewall rules to prevent unauthorized access.
|
|
|
|
1. Define a `redis['port']` to force redis to listin on TCP so other machines can
|
|
|
|
connect to it.
|
|
|
|
1. Set up password authentication with `redis['master_password']` (use the same
|
|
|
|
password in all nodes).
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
```ruby
|
|
|
|
## Redis TCP support (will disable UNIX socket transport)
|
|
|
|
redis['bind'] = '0.0.0.0' # or specify an IP to bind to a single one
|
|
|
|
redis['port'] = 6379
|
|
|
|
redis['requirepass'] = 'redis-password-goes-here'
|
|
|
|
redis['master_password'] = 'redis-password-goes-here'
|
|
|
|
```
|
|
|
|
|
|
|
|
Reconfigure GitLab Omnibus for the changes to take effect: `sudo gitlab-ctl reconfigure`
|
|
|
|
|
|
|
|
**Slave Redis instances**
|
|
|
|
|
|
|
|
You need to make the same changes listed for the `Master` instance,
|
|
|
|
with an additional `Slave` section as in the example below:
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
## Redis TCP support (will disable UNIX socket transport)
|
|
|
|
redis['bind'] = '0.0.0.0' # or specify an IP to bind to a single one
|
|
|
|
redis['port'] = 6379
|
|
|
|
redis['requirepass'] = 'redis-password-goes-here'
|
|
|
|
redis['master_password'] = 'redis-password-goes-here'
|
|
|
|
|
|
|
|
## Slave redis instance
|
|
|
|
redis['master'] = false
|
|
|
|
redis['master_ip'] = '10.10.10.10' # IP of master Redis server
|
|
|
|
redis['master_port'] = 6379 # Port of master Redis server
|
|
|
|
```
|
|
|
|
|
|
|
|
Reconfigure GitLab Omnibus for the changes to take effect: `sudo gitlab-ctl reconfigure`
|
|
|
|
|
|
|
|
#### Troubleshooting Replication
|
|
|
|
|
|
|
|
You can check if everything is correct by connecting to each server using
|
|
|
|
`redis-cli` application, and sending the `INFO` command.
|
|
|
|
|
|
|
|
If authentication was correctly defined, it should fail with:
|
|
|
|
`NOAUTH Authentication required` error. Try to authenticate with the
|
|
|
|
previous defined password with `AUTH redis-password-goes-here` and
|
|
|
|
try the `INFO` command again.
|
|
|
|
|
|
|
|
Look for the `# Replication` section where you should see some important
|
|
|
|
information like the `role` of the server.
|
|
|
|
|
|
|
|
When connected to a `master` redis, you will see the number of connected
|
|
|
|
`slaves`, and a list of each with connection details.
|
|
|
|
|
|
|
|
When it's a `slave`, you will see details of the master connection and if
|
|
|
|
its `up` or `down`.
|
2016-07-19 11:27:50 +00:00
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
Now that the Redis servers are all set up, let's configure the Sentinel
|
|
|
|
servers.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
If you are not sure if your Redis servers are working and replicating
|
|
|
|
correctly, please read the [Troubleshooting Replication](#troubleshooting-replication)
|
|
|
|
and fix it before proceeding with Sentinel setup.
|
|
|
|
|
|
|
|
### Sentinel
|
|
|
|
|
|
|
|
You must have at least `3` Redis Sentinel servers, and they need to
|
|
|
|
be each in a independent machine. You can install them in the same
|
|
|
|
machines you installed the other `3` Redis servers.
|
|
|
|
|
|
|
|
This number is required for the consensus algorithm to be effective
|
|
|
|
in the case of a failure. You should always have and `odd` number
|
|
|
|
of Sentinel nodes provisioned.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
Here is a simple explanation on how Sentinel handles a failover:
|
2016-08-02 01:25:28 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
When a number of Sentinels (`quorum` value) agree the fact the `master` is
|
|
|
|
not reachable, the **majority** of the sentinels must elect a temporary
|
|
|
|
Sentinel `leader`, that will be responsible to start the failover proceedings.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
As an example, for a cluster of `3` Sentinels, at least `2` must agree on a
|
|
|
|
`leader`. If you have total of `5` at least `3` must agree on the leader.
|
|
|
|
|
|
|
|
The `quorum` is only used to detect failure, not to elect the `leader`.
|
|
|
|
|
|
|
|
Official [Sentinel documentation](http://redis.io/topics/sentinel#example-sentinel-deployments)
|
|
|
|
also lists different network topologies and warns againts situations like
|
|
|
|
network partition and how it can affect the state of the HA solution. Make
|
|
|
|
sure you read it carefully and understand the implications in your current
|
|
|
|
setup.
|
|
|
|
|
|
|
|
To make Sentinel setup easier, ee provide an [automated way to setup and run](#sentinel-setup-ee-only)
|
|
|
|
the Sentinel daemon with GitLab EE.
|
|
|
|
|
|
|
|
#### Sentinel setup (Community Edition)
|
|
|
|
|
|
|
|
For GitLab CE, you need to install, configure, execute and monitor Sentinel
|
|
|
|
by yourself.
|
|
|
|
|
|
|
|
Here is an example configuration file (`sentinel.conf`) for a minimal Sentinel
|
|
|
|
node:
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-07-14 01:57:47 +00:00
|
|
|
```conf
|
2016-10-15 03:40:15 +00:00
|
|
|
bind 0.0.0.0 # bind to all interfaces or change to a specific IP
|
|
|
|
port 26379 # default sentinel port
|
|
|
|
sentinel auth-pass gitlab-redis redis-password-goes-here
|
|
|
|
sentinel monitor gitlab-redis 10.0.0.1 6379 2
|
2016-09-22 09:05:28 +00:00
|
|
|
sentinel down-after-milliseconds gitlab-redis 10000
|
|
|
|
sentinel config-epoch gitlab-redis 0
|
|
|
|
sentinel leader-epoch gitlab-redis 0
|
2016-07-14 01:57:47 +00:00
|
|
|
```
|
|
|
|
|
2016-10-15 03:40:15 +00:00
|
|
|
#### Sentinel setup (EE Only)
|
|
|
|
|
|
|
|
To setup sentinel, you must edit `/etc/gitlab/gitlab.rb` file.
|
|
|
|
This is a minimal configuration required to run the daemon:
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
redis['master_name'] = 'gitlab-redis' # must be the same in every sentinel node
|
|
|
|
redis['master_ip'] = '10.0.0.1' # ip of the initial master redis instance
|
|
|
|
redis['master_port'] = 6379 # port of the initial master redis instance
|
|
|
|
redis['master_password'] = 'your-secure-password-here' # the same value defined in redis['password'] in the master instance
|
|
|
|
|
|
|
|
sentinel['enable'] = true
|
|
|
|
# sentinel['port'] = 26379
|
|
|
|
|
|
|
|
## Quorum must reflect the amount of voting sentinels it take to start a failover.
|
|
|
|
sentinel['quorum'] = 2
|
|
|
|
|
|
|
|
## Consider unresponsive server down after x amount of ms.
|
|
|
|
# sentinel['down_after_milliseconds'] = 10000
|
|
|
|
|
|
|
|
# sentinel['failover_timeout'] = 60000
|
|
|
|
```
|
|
|
|
|
|
|
|
When you install Sentinel in a separate machine, you need to control which
|
|
|
|
other services will be running in it. Take a look at the following variables
|
|
|
|
and enable or disable whenever it fits your strategy:
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
# Enabled Redis and Sentinel services
|
|
|
|
redis['enable'] = true
|
|
|
|
sentinel['enable'] = true
|
|
|
|
|
|
|
|
# Disabled all other services
|
|
|
|
redis['enable'] = false
|
|
|
|
bootstrap['enable'] = false
|
|
|
|
nginx['enable'] = false
|
|
|
|
unicorn['enable'] = false
|
|
|
|
sidekiq['enable'] = false
|
|
|
|
postgresql['enable'] = false
|
|
|
|
gitlab_workhorse['enable'] = false
|
|
|
|
gitlab_rails['enable'] = false
|
|
|
|
mailroom['enable'] = false
|
|
|
|
```
|
|
|
|
|
|
|
|
Remember that enabling a new service may also require additional configuration
|
|
|
|
params (like `redis` for example).
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
The final part is to inform the main GitLab application server of the Redis
|
|
|
|
master and the new sentinels servers.
|
|
|
|
|
2016-08-02 01:25:28 +00:00
|
|
|
### GitLab setup
|
2016-07-14 01:57:47 +00:00
|
|
|
|
|
|
|
You can enable or disable sentinel support at any time in new or existing
|
2016-07-19 11:27:50 +00:00
|
|
|
installations. From the GitLab application perspective, all it requires is
|
2016-08-02 01:25:28 +00:00
|
|
|
the correct credentials for the master Redis and for a few Sentinel nodes.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-08-02 01:25:28 +00:00
|
|
|
It doesn't require a list of all Sentinel nodes, as in case of a failure,
|
2016-07-14 01:57:47 +00:00
|
|
|
the application will need to query only one of them.
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
>**Note:**
|
|
|
|
The following steps should be performed in the [GitLab application server](gitlab.md).
|
|
|
|
|
|
|
|
**For source based installations**
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
1. Edit `/home/git/gitlab/config/resque.yml` following the example in
|
2016-08-02 01:25:28 +00:00
|
|
|
`/home/git/gitlab/config/resque.yml.example`, and uncomment the sentinels
|
2016-07-19 11:27:50 +00:00
|
|
|
line, changing to the correct server credentials.
|
|
|
|
1. Restart GitLab for the changes to take effect.
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
**For Omnibus installations**
|
2016-07-14 01:57:47 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
1. Edit `/etc/gitlab/gitlab.rb` and add/change the following lines:
|
|
|
|
|
|
|
|
```ruby
|
2016-09-22 09:05:28 +00:00
|
|
|
redis['master_name'] = "gitlab-redis"
|
2016-10-06 23:47:22 +00:00
|
|
|
redis['master_password'] = 'redis-password-goes-here'
|
2016-09-22 09:05:28 +00:00
|
|
|
gitlab_rails['redis_sentinels'] = [
|
2016-07-19 11:27:50 +00:00
|
|
|
{'host' => '10.10.10.1', 'port' => 26379},
|
|
|
|
{'host' => '10.10.10.2', 'port' => 26379},
|
|
|
|
{'host' => '10.10.10.3', 'port' => 26379}
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
|
|
|
1. [Reconfigure] the GitLab for the changes to take effect.
|
|
|
|
|
|
|
|
### Sentinel troubleshooting
|
|
|
|
|
2016-10-06 23:47:22 +00:00
|
|
|
#### Omnibus install
|
|
|
|
|
|
|
|
If you get an error like: `Redis::CannotConnectError: No sentinels available.`,
|
|
|
|
there may be something wrong with your configuration files or it can be related
|
|
|
|
to [this issue][gh-531].
|
|
|
|
|
|
|
|
You must make sure you are defining the same value in `redis['master_name']`
|
|
|
|
and `redis['master_pasword']` as you defined for your sentinel node.
|
|
|
|
|
|
|
|
The way the redis connector `redis-rb` works with sentinel is a bit
|
|
|
|
non-intuitive. We try to hide the complexity in omnibus, but it still requires
|
|
|
|
a few extra configs.
|
|
|
|
|
|
|
|
#### Source install
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
If you get an error like: `Redis::CannotConnectError: No sentinels available.`,
|
|
|
|
there may be something wrong with your configuration files or it can be related
|
2016-09-22 09:05:28 +00:00
|
|
|
to [this issue][gh-531].
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-09-22 09:05:28 +00:00
|
|
|
It's a bit non-intuitive the way you have to config `resque.yml` and
|
|
|
|
`sentinel.conf`, otherwise `redis-rb` will not work properly.
|
2016-07-19 11:27:50 +00:00
|
|
|
|
2016-09-22 09:05:28 +00:00
|
|
|
The `master-group-name` ('gitlab-redis') defined in (`sentinel.conf`)
|
|
|
|
**must** be used as the hostname in GitLab (`resque.yml` for source installations
|
|
|
|
or `gitlab-rails['redis_*']` in Omnibus):
|
2016-07-19 11:27:50 +00:00
|
|
|
|
|
|
|
```conf
|
|
|
|
# sentinel.conf:
|
2016-10-15 03:40:15 +00:00
|
|
|
sentinel monitor gitlab-redis 10.10.10.10 6379 2
|
2016-09-22 09:05:28 +00:00
|
|
|
sentinel down-after-milliseconds gitlab-redis 10000
|
|
|
|
sentinel config-epoch gitlab-redis 0
|
|
|
|
sentinel leader-epoch gitlab-redis 0
|
2016-07-14 01:57:47 +00:00
|
|
|
```
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
```yaml
|
|
|
|
# resque.yaml
|
|
|
|
production:
|
2016-09-22 09:05:28 +00:00
|
|
|
url: redis://:myredispassword@gitlab-redis/
|
2016-07-19 11:27:50 +00:00
|
|
|
sentinels:
|
|
|
|
-
|
2016-09-22 09:05:28 +00:00
|
|
|
host: slave1.example.com # or use ip
|
2016-07-19 11:27:50 +00:00
|
|
|
port: 26380 # point to sentinel, not to redis port
|
|
|
|
-
|
2016-09-22 09:05:28 +00:00
|
|
|
host: slave2.exampl.com # or use ip
|
2016-07-19 11:27:50 +00:00
|
|
|
port: 26381 # point to sentinel, not to redis port
|
|
|
|
```
|
2016-04-22 18:18:06 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
When in doubt, please read [Redis Sentinel documentation](http://redis.io/topics/sentinel)
|
2016-04-22 18:18:06 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
---
|
2016-04-22 18:18:06 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
To make sure your configuration is correct:
|
2016-04-22 18:18:06 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
1. SSH into your GitLab application server
|
|
|
|
1. Enter the Rails console:
|
|
|
|
|
|
|
|
```
|
|
|
|
# For Omnibus installations
|
|
|
|
sudo gitlab-rails console
|
|
|
|
|
|
|
|
# For source installations
|
2016-10-15 03:40:15 +00:00
|
|
|
sudo -u git rails console production
|
2016-07-19 11:27:50 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
1. Run in the console:
|
2016-04-22 18:18:06 +00:00
|
|
|
|
|
|
|
```ruby
|
2016-07-19 11:27:50 +00:00
|
|
|
redis = Redis.new(Gitlab::Redis.params)
|
|
|
|
redis.info
|
2016-04-22 18:18:06 +00:00
|
|
|
```
|
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
Keep this screen open and try to simulate a failover below.
|
2016-04-22 18:18:06 +00:00
|
|
|
|
2016-07-19 11:27:50 +00:00
|
|
|
1. To simulate a failover on master Redis, SSH into the Redis server and run:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
# port must match your master redis port
|
|
|
|
redis-cli -h localhost -p 6379 DEBUG sleep 60
|
|
|
|
```
|
|
|
|
|
|
|
|
1. Then back in the Rails console from the first step, run:
|
|
|
|
|
|
|
|
```
|
|
|
|
redis.info
|
|
|
|
```
|
|
|
|
|
|
|
|
You should see a different port after a few seconds delay
|
|
|
|
(the failover/reconnect time).
|
2016-04-22 18:18:06 +00:00
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
Read more on high-availability configuration:
|
|
|
|
|
|
|
|
1. [Configure the database](database.md)
|
|
|
|
1. [Configure NFS](nfs.md)
|
|
|
|
1. [Configure the GitLab application servers](gitlab.md)
|
|
|
|
1. [Configure the load balancers](load_balancer.md)
|
2016-07-19 11:27:50 +00:00
|
|
|
|
|
|
|
[ce-1877]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/1877
|
|
|
|
[restart]: ../restart_gitlab.md#installations-from-source
|
|
|
|
[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure
|
|
|
|
[gh-531]: https://github.com/redis/redis-rb/issues/531
|
|
|
|
[gh-534]: https://github.com/redis/redis-rb/issues/534
|