Docker image with redis built and installed from source and a cluster is built.
The main primary use for this container is to test redis cluster code. Specially https://github.com/Grokzen/redis-py-cluster
This repo is not intended to be a production quality docker build. It will also not be changed to use multiple containers or move away from supervisord, or to have support for different cluster managers, for example kubernetes, docker-ee or swarm. It will also not be made to handle persistent data between runs. However, any suggestions on improvements will be considered.
The container is made to be quick and easy to start, use and run.
The cluster is 6 redis instances running with 3 master & 3 slaves, one slave for each master. They run on ports 7000 to 7005.
If the flag -e "STANDALONE=true" is passed there is 2 standalone instances runnin on port 7006 and 7007.
If the flag -e "SENTINEL=true" is passed there are 3 Sentinel nodes running on ports 5000 to 5002 matching cluster's master instances.
This image requires at least Docker version 1.10 but the latest version is recommended.
If you are using this container to run a redis cluster on your mac computer, then you need to configure the container to use another IP address for cluster discovery as it can't use the default discovery IP that is hardcoded into the container.
If you are using the docker-compose file to build the container, then you must export a envrionment variable on your machine before building the container.
# This will make redis do cluster discovery and bind all nodes to ip 127.0.0.1 internally
export REDIS_CLUSTER_IP=0.0.0.0
If you are downloading the container from dockerhub, you must add the internal IP envrionment variable to your docker run command.
docker run grokzen/redis-cluster:latest -e "IP=0.0.0.0" ...
To build your own image run:
make build
To run the container run:
make up
To stop the container run:
make down
To connect to your cluster you can use the redis-cli tool:
redis-cli -c -p 7000
Or the built redis-cli tool inside the container that will connect to the cluster inside the container
make cli
Standalone instances is not enabled by default, but available to use to run 2 standalone redis instances that is not clustered.
If running with plain docker run
docker run ... -e STANDALONE=true ...
When running with docker-compose, set the envrionment variable on your system REDIS_USE_STANDALONE=true and start your container or modify the docker-compose.yml file
version: '2'
services:
redis-cluster:
...
environment:
STANDALONE: 'true'
Sentinel instances is not enabled by default.
If running with plain docker send in -e SENTINEL=true.
When running with docker-compose set the environment variable on your system REDIS_USE_SENTINEL=true and start your container.
version: '2'
services:
redis-cluster:
...
environment:
SENTINEL: 'true'
For a release to be buildable it needs to be present at this url: http://download.redis.io/releases/
To build a different redis version use the argument --build-arg argument.
# Example plain docker
docker build --build-arg redis_version=4.0.13 -t grokzen/redis-cluster .
To build a different redis version use the --build-arg argument.
# Example docker-compose
docker-compose build --build-arg "redis_version=4.0.13" redis-cluster
The following tags with pre-built images is available on docker-hub.
Latest release in the most recent stable branch will be used as latest version.
- latest == 5.0.3
Redis 5.0.x version:
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
Redis 4.0.x versions:
- 4.0.13
- 4.0.12
- 4.0.11
- 4.0.10
- 4.0.9
- 4.0.8
- 4.0.7
- 4.0.6
- 4.0.5
- 4.0.4
- 4.0.3
- 4.0.2
- 4.0.1
- 4.0.0
Redis 3.2.x versions:
- 3.2.12
- 3.2.11
- 3.2.10
- 3.2.9
- 3.2.8
- 3.2.7
- 3.2.6
- 3.2.5
- 3.2.4
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2.0
Redis 3.0.x versions:
- 3.0.7
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
This repo is using the MIT LICENSE.
You can find it in the file LICENSE