Configure this chart with External Redis
This document intends to provide documentation on how to configure this Helm chart with an external Redis service.
If you don’t have Redis configured, for on-premise or deployment to VM, consider using our Omnibus GitLab package.
Configure the Chart
Disable the redis
chart and the Redis service it provides, and point the other services to the external service.
You need to set the following parameters:
-
redis.install
: Set tofalse
to disable including the Redis chart. -
global.redis.host
: Set to the hostname of the external Redis, can be a domain or an IP address. -
global.redis.password.enabled
: Set tofalse
if the external Redis does not require a password. -
global.redis.password.secret
: The name of the secret which contains the token for authentication. -
global.redis.password.key
: The key within the secret, which contains the token content.
Items below can be further customized if you are not using the defaults:
-
global.redis.port
: The port the database is available on, defaults to6379
For example, pass these values via Helm’s --set
flag while deploying:
helm install gitlab gitlab/gitlab \
--set redis.install=false \
--set global.redis.host=redis.example \
--set global.redis.password.secret=gitlab-redis \
--set global.redis.password.key=redis-password \
If you are connecting to a Redis HA cluster that has Sentinel servers
running, the global.redis.host
attribute needs to be set to the cluster
name as specified in the sentinel.conf
. Sentinel servers can be referenced
using the global.redis.sentinels[0].host
and global.redis.sentinels[0].port
values for the --set
flag. The index is zero based.
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc