Merge branch 'master' of gitlab_gitlab:gitlab-org/gitlab-cerunner-metrics-extractor

1 files changed, 158 insertions, 153 deletions

diff --git a/doc/administration/high_availability/redis_source.md b/doc/administration/high_availability/redis_source.md
index be6b547372a..63915e5d96c 100644
--- a/doc/administration/high_availability/redis_source.md
+++ b/doc/administration/high_availability/redis_source.md
@@ -1,3 +1,7 @@
+---
+type: reference
+---
+
 # Configuring non-Omnibus Redis for GitLab HA
 
 This is the documentation for configuring a Highly Available Redis setup when
@@ -49,22 +53,22 @@ Assuming that the Redis master instance IP is `10.0.0.1`:
 1. [Install Redis](../../install/installation.md#7-redis).
 1. Edit `/etc/redis/redis.conf`:
 
-    ```conf
-    ## 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 accessible IP, make
-    ## sure you add extra firewall rules to prevent unauthorized access:
-    bind 10.0.0.1
+   ```conf
+   ## 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 accessible IP, make
+   ## sure you add extra firewall rules to prevent unauthorized access:
+   bind 10.0.0.1
 
-    ## Define a `port` to force redis to listen on TCP so other machines can
-    ## connect to it (default port is `6379`).
-    port 6379
+   ## Define a `port` to force redis to listen on TCP so other machines can
+   ## connect to it (default port is `6379`).
+   port 6379
 
-    ## Set up password authentication (use the same password in all nodes).
-    ## The password should be defined equal for both `requirepass` and `masterauth`
-    ## when setting up Redis to use with Sentinel.
-    requirepass redis-password-goes-here
-    masterauth redis-password-goes-here
-    ```
+   ## Set up password authentication (use the same password in all nodes).
+   ## The password should be defined equal for both `requirepass` and `masterauth`
+   ## when setting up Redis to use with Sentinel.
+   requirepass redis-password-goes-here
+   masterauth redis-password-goes-here
+   ```
 
 1. Restart the Redis service for the changes to take effect.
 
@@ -75,25 +79,25 @@ Assuming that the Redis slave instance IP is `10.0.0.2`:
 1. [Install Redis](../../install/installation.md#7-redis).
 1. Edit `/etc/redis/redis.conf`:
 
-    ```conf
-    ## 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 accessible IP, make
-    ## sure you add extra firewall rules to prevent unauthorized access:
-    bind 10.0.0.2
+   ```conf
+   ## 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 accessible IP, make
+   ## sure you add extra firewall rules to prevent unauthorized access:
+   bind 10.0.0.2
 
-    ## Define a `port` to force redis to listen on TCP so other machines can
-    ## connect to it (default port is `6379`).
-    port 6379
+   ## Define a `port` to force redis to listen on TCP so other machines can
+   ## connect to it (default port is `6379`).
+   port 6379
 
-    ## Set up password authentication (use the same password in all nodes).
-    ## The password should be defined equal for both `requirepass` and `masterauth`
-    ## when setting up Redis to use with Sentinel.
-    requirepass redis-password-goes-here
-    masterauth redis-password-goes-here
+   ## Set up password authentication (use the same password in all nodes).
+   ## The password should be defined equal for both `requirepass` and `masterauth`
+   ## when setting up Redis to use with Sentinel.
+   requirepass redis-password-goes-here
+   masterauth redis-password-goes-here
 
-    ## Define `slaveof` pointing to the Redis master instance with IP and port.
-    slaveof 10.0.0.1 6379
-    ```
+   ## Define `slaveof` pointing to the Redis master instance with IP and port.
+   slaveof 10.0.0.1 6379
+   ```
 
 1. Restart the Redis service for the changes to take effect.
 1. Go through the steps again for all the other slave nodes.
@@ -110,56 +114,57 @@ master with IP `10.0.0.1` (some settings might overlap with the master):
 1. [Install Redis Sentinel](https://redis.io/topics/sentinel)
 1. Edit `/etc/redis/sentinel.conf`:
 
-    ```conf
-    ## 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 accessible IP, make
-    ## sure you add extra firewall rules to prevent unauthorized access:
-    bind 10.0.0.1
-
-    ## Define a `port` to force Sentinel to listen on TCP so other machines can
-    ## connect to it (default port is `6379`).
-    port 26379
-
-    ## Set up password authentication (use the same password in all nodes).
-    ## The password should be defined equal for both `requirepass` and `masterauth`
-    ## when setting up Redis to use with Sentinel.
-    requirepass redis-password-goes-here
-    masterauth redis-password-goes-here
-
-    ## Define with `sentinel auth-pass` the same shared password you have
-    ## defined for both Redis master and slaves instances.
-    sentinel auth-pass gitlab-redis redis-password-goes-here
-
-    ## Define with `sentinel monitor` the IP and port of the Redis
-    ## master node, and the quorum required to start a failover.
-    sentinel monitor gitlab-redis 10.0.0.1 6379 2
-
-    ## Define with `sentinel down-after-milliseconds` the time in `ms`
-    ## that an unresponsive server will be considered down.
-    sentinel down-after-milliseconds gitlab-redis 10000
-
-    ## Define a value for `sentinel failover_timeout` in `ms`. This has multiple
-    ## meanings:
-    ##
-    ## * The time needed to re-start a failover after a previous failover was
-    ##   already tried against the same master by a given Sentinel, is two
-    ##   times the failover timeout.
-    ##
-    ## * The time needed for a slave replicating to a wrong master according
-    ##   to a Sentinel current configuration, to be forced to replicate
-    ##   with the right master, is exactly the failover timeout (counting since
-    ##   the moment a Sentinel detected the misconfiguration).
-    ##
-    ## * The time needed to cancel a failover that is already in progress but
-    ##   did not produced any configuration change (SLAVEOF NO ONE yet not
-    ##   acknowledged by the promoted slave).
-    ##
-    ## * The maximum time a failover in progress waits for all the slaves to be
-    ##   reconfigured as slaves of the new master. However even after this time
-    ##   the slaves will be reconfigured by the Sentinels anyway, but not with
-    ##   the exact parallel-syncs progression as specified.
-    sentinel failover_timeout 30000
-    ```
+   ```conf
+   ## 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 accessible IP, make
+   ## sure you add extra firewall rules to prevent unauthorized access:
+   bind 10.0.0.1
+
+   ## Define a `port` to force Sentinel to listen on TCP so other machines can
+   ## connect to it (default port is `6379`).
+   port 26379
+
+   ## Set up password authentication (use the same password in all nodes).
+   ## The password should be defined equal for both `requirepass` and `masterauth`
+   ## when setting up Redis to use with Sentinel.
+   requirepass redis-password-goes-here
+   masterauth redis-password-goes-here
+
+   ## Define with `sentinel auth-pass` the same shared password you have
+   ## defined for both Redis master and slaves instances.
+   sentinel auth-pass gitlab-redis redis-password-goes-here
+
+   ## Define with `sentinel monitor` the IP and port of the Redis
+   ## master node, and the quorum required to start a failover.
+   sentinel monitor gitlab-redis 10.0.0.1 6379 2
+
+   ## Define with `sentinel down-after-milliseconds` the time in `ms`
+   ## that an unresponsive server will be considered down.
+   sentinel down-after-milliseconds gitlab-redis 10000
+
+   ## Define a value for `sentinel failover_timeout` in `ms`. This has multiple
+   ## meanings:
+   ##
+   ## * The time needed to re-start a failover after a previous failover was
+   ##   already tried against the same master by a given Sentinel, is two
+   ##   times the failover timeout.
+   ##
+   ## * The time needed for a slave replicating to a wrong master according
+   ##   to a Sentinel current configuration, to be forced to replicate
+   ##   with the right master, is exactly the failover timeout (counting since
+   ##   the moment a Sentinel detected the misconfiguration).
+   ##
+   ## * The time needed to cancel a failover that is already in progress but
+   ##   did not produced any configuration change (SLAVEOF NO ONE yet not
+   ##   acknowledged by the promoted slave).
+   ##
+   ## * The maximum time a failover in progress waits for all the slaves to be
+   ##   reconfigured as slaves of the new master. However even after this time
+   ##   the slaves will be reconfigured by the Sentinels anyway, but not with
+   ##   the exact parallel-syncs progression as specified.
+   sentinel failover_timeout 30000
+   ```
+
 1. Restart the Redis service for the changes to take effect.
 1. Go through the steps again for all the other Sentinel nodes.
 
@@ -180,21 +185,21 @@ setup:
    [resque.yml.example][resque], and uncomment the Sentinel lines, pointing to
    the correct server credentials:
 
-    ```yaml
-    # resque.yaml
-    production:
-      url: redis://:redi-password-goes-here@gitlab-redis/
-      sentinels:
-        -
-          host: 10.0.0.1
-          port: 26379 # point to sentinel, not to redis port
-        -
-          host: 10.0.0.2
-          port: 26379 # point to sentinel, not to redis port
-        -
-          host: 10.0.0.3
-          port: 26379 # point to sentinel, not to redis port
-    ```
+   ```yaml
+   # resque.yaml
+   production:
+     url: redis://:redi-password-goes-here@gitlab-redis/
+     sentinels:
+       -
+         host: 10.0.0.1
+         port: 26379 # point to sentinel, not to redis port
+       -
+         host: 10.0.0.2
+         port: 26379 # point to sentinel, not to redis port
+       -
+         host: 10.0.0.3
+         port: 26379 # point to sentinel, not to redis port
+   ```
 
 1. [Restart GitLab][restart] for the changes to take effect.
 
@@ -232,23 +237,23 @@ or a failover promotes a different **Master** node.
 
 1. In `/etc/redis/redis.conf`:
 
-    ```conf
-    bind 10.0.0.1
-    port 6379
-    requirepass redis-password-goes-here
-    masterauth redis-password-goes-here
-    ```
+   ```conf
+   bind 10.0.0.1
+   port 6379
+   requirepass redis-password-goes-here
+   masterauth redis-password-goes-here
+   ```
 
 1. In `/etc/redis/sentinel.conf`:
 
-    ```conf
-    bind 10.0.0.1
-    port 26379
-    sentinel auth-pass gitlab-redis redis-password-goes-here
-    sentinel monitor gitlab-redis 10.0.0.1 6379 2
-    sentinel down-after-milliseconds gitlab-redis 10000
-    sentinel failover_timeout 30000
-    ```
+   ```conf
+   bind 10.0.0.1
+   port 26379
+   sentinel auth-pass gitlab-redis redis-password-goes-here
+   sentinel monitor gitlab-redis 10.0.0.1 6379 2
+   sentinel down-after-milliseconds gitlab-redis 10000
+   sentinel failover_timeout 30000
+   ```
 
 1. Restart the Redis service for the changes to take effect.
 
@@ -256,24 +261,24 @@ or a failover promotes a different **Master** node.
 
 1. In `/etc/redis/redis.conf`:
 
-    ```conf
-    bind 10.0.0.2
-    port 6379
-    requirepass redis-password-goes-here
-    masterauth redis-password-goes-here
-    slaveof 10.0.0.1 6379
-    ```
+   ```conf
+   bind 10.0.0.2
+   port 6379
+   requirepass redis-password-goes-here
+   masterauth redis-password-goes-here
+   slaveof 10.0.0.1 6379
+   ```
 
 1. In `/etc/redis/sentinel.conf`:
 
-    ```conf
-    bind 10.0.0.2
-    port 26379
-    sentinel auth-pass gitlab-redis redis-password-goes-here
-    sentinel monitor gitlab-redis 10.0.0.1 6379 2
-    sentinel down-after-milliseconds gitlab-redis 10000
-    sentinel failover_timeout 30000
-    ```
+   ```conf
+   bind 10.0.0.2
+   port 26379
+   sentinel auth-pass gitlab-redis redis-password-goes-here
+   sentinel monitor gitlab-redis 10.0.0.1 6379 2
+   sentinel down-after-milliseconds gitlab-redis 10000
+   sentinel failover_timeout 30000
+   ```
 
 1. Restart the Redis service for the changes to take effect.
 
@@ -281,24 +286,24 @@ or a failover promotes a different **Master** node.
 
 1. In `/etc/redis/redis.conf`:
 
-    ```conf
-    bind 10.0.0.3
-    port 6379
-    requirepass redis-password-goes-here
-    masterauth redis-password-goes-here
-    slaveof 10.0.0.1 6379
-    ```
+   ```conf
+   bind 10.0.0.3
+   port 6379
+   requirepass redis-password-goes-here
+   masterauth redis-password-goes-here
+   slaveof 10.0.0.1 6379
+   ```
 
 1. In `/etc/redis/sentinel.conf`:
 
-    ```conf
-    bind 10.0.0.3
-    port 26379
-    sentinel auth-pass gitlab-redis redis-password-goes-here
-    sentinel monitor gitlab-redis 10.0.0.1 6379 2
-    sentinel down-after-milliseconds gitlab-redis 10000
-    sentinel failover_timeout 30000
-    ```
+   ```conf
+   bind 10.0.0.3
+   port 26379
+   sentinel auth-pass gitlab-redis redis-password-goes-here
+   sentinel monitor gitlab-redis 10.0.0.1 6379 2
+   sentinel down-after-milliseconds gitlab-redis 10000
+   sentinel failover_timeout 30000
+   ```
 
 1. Restart the Redis service for the changes to take effect.
 
@@ -306,20 +311,20 @@ or a failover promotes a different **Master** node.
 
 1. Edit `/home/git/gitlab/config/resque.yml`:
 
-    ```yaml
-    production:
-      url: redis://:redi-password-goes-here@gitlab-redis/
-      sentinels:
-        -
-          host: 10.0.0.1
-          port: 26379 # point to sentinel, not to redis port
-        -
-          host: 10.0.0.2
-          port: 26379 # point to sentinel, not to redis port
-        -
-          host: 10.0.0.3
-          port: 26379 # point to sentinel, not to redis port
-    ```
+   ```yaml
+   production:
+     url: redis://:redi-password-goes-here@gitlab-redis/
+     sentinels:
+       -
+         host: 10.0.0.1
+         port: 26379 # point to sentinel, not to redis port
+       -
+         host: 10.0.0.2
+         port: 26379 # point to sentinel, not to redis port
+       -
+         host: 10.0.0.3
+         port: 26379 # point to sentinel, not to redis port
+   ```
 
 1. [Restart GitLab][restart] for the changes to take effect.