docker-redis

This redis image is based on Redis 3.2.5 and allows run redis in three ways:

• Redis Sentinel
• Redis Cluster
• Redis Standalone

Redis configuration files contents can be provided via environment variables (in 12-factor way).

Configuration

Configuration should be passed via environment variables.

Environment variables:

• REDIS_NODE_TYPE - mandatory variable indicates in which configuration will run Redis. Supported values:
  • SENTINEL - redis will be run as Sentinel node (for Sentinel mode)
  • SENTINEL_INIT_MASTER - redis will be run as Sentinel Master node (for Sentinel mode)
  • SENTINEL_SLAVE - - redis will be run as Sentinel Slave node (for Sentinel mode)
  • CLUSTER_NODE - redis will be run as Cluster node (for Cluster mode)
  • STANDALONE - redis will be run as Standalone node (for Standalone mode)
  • CLUSTER_NODE_COMPOSE - redis will be run as Cluster node (for Cluster mode) dedicated for docker compose environments

Environment variables used in Sentinel mode:

• SENTINEL_MASTER_ID - name of master configured in sentinel.conf used to monitoring
• SENTINEL_SERVICE_HOST - ip of sentinel service
• SENTINEL_SERVICE_PORT - port of sentinel service
• SENTINEL_INIT_MASTER_HOST - ip of redis node run as Sentinel Master
• SENTINEL_INIT_MASTER_PORT - port of redis node run as Sentinel Master

Environment variables stored in files:

• REDIS_CONFIG - if present will be saved into /data/redis.conf that will be passed to redis-server command. Description of redis.conf
• SENTINEL_CONFIG - if present will be saved into /data/sentinel.conf. Description of sentinel.conf
• CLUSTER_CONFIG - if present will be saved into /data/nodes.conf.

Command line variables

Image supports configuration provided via command line. Options from command line have bigger priority than configuration from redis.conf

How to run it in Kubernetes?

Redis Sentinel

Suggested Sentinel deployment is based on three Sentinels and three Redis nodes, one node run as a Master and two nodes run as a Slaves.

Here is example configuration

Redis Cluster

Here is example configuration

Redis Standalone

Here is example configuration

How to run it in docker?

Redis cluster on docker

Create redis containers on multiple hosts using command: docker run -d -v $HOME/data:/data -e "REDIS_NODE_TYPE=CLUSTER_NODE_COMPOSE" --network="host" --name=redis oberthur/docker-redis:3.2.5 or with custom configuration for example: docker run -d -v $HOME/data:/data -e "REDIS_NODE_TYPE=CLUSTER_NODE_COMPOSE" -e "REDIS_CONFIG=port 6379\ncluster-node-timeout 1000\ncluster-require-full-coverage yes" --network="host" --name=redis oberthur/docker-redis:3.2.5

Create cluster running command on single node docker run -it --entrypoint /redis-trib.rb --network="host" oberthur/docker-redis:3.2.5 create --replicas 1 ip1:port1 ip2:port2 ..., where ip1:port1 ip2:port2 is the list of all nodes in cluster.

Redis cluster on docker - compose manifests

Deploy redis containers on hosts using manifest, then create cluster running command on single node docker run -it --entrypoint /redis-trib.rb --network="host" oberthur/docker-redis:3.2.5 create --replicas 1 ip1:port1 ip2:port2 ..., where ip1:port1 ip2:port2 is the list of all nodes in cluster.