Docker image with redis built and installed from source and a cluster is built.

To find all redis-server releases see them here https://github.com/antirez/redis/releases

Github have recently released their Discussions feature into beta for more repositories across the github space. This feature is enabled on this repo since a while back.

Becuase we now have this feature, the issues feature will NOT be a place where you can now ask general questions or need simple help with this repo and what it provides.

What can you expect to find in there?

• A place where you can freely ask any question regarding this repo.
• Ask questions like how do i do X?
• General help with problems with this repo
• Guides written by me or any other contributer with useful examples and ansers to commonly asked questions and how to resolve thos problems.
• Approved answers to questions marked and promoted by me if help is provided by the community regarding some questions

This repo exists as a resource to make it quick and simple to get a redis cluster up and running with no fuzz or issues with mininal effort. The primary use for this container is to get a cluster up and running in no time that you can use for demo/presentation/development. It is not intended or built for anything else.

I also aim to have every single release of redis that supports a cluster available for use so you can run the exact version you want.

I personally use this to develop redis cluster client code https://github.com/Grokzen/redis-py-cluster

This container that i have built is not supposed to be some kind of production container or one that is used within any environment other then running locally on your machine. It is not ment to be run on kubernetes or in any other prod/stage/test/dev environment as a fully working commponent in that environment. If that works for you and your use-case then awesome. But this container will not change to fit any other primary solution then to be used locally on your machine.

If you are looking for something else or some production quality or kubernetes compatible solution then you are looking in the wrong repo. There is other projects or forks of this repo that is compatible for that situation/solution.

For all other purposes other then what has been stated you are free to fork and/or rebuild this container using it as a template for what you need.

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 are, by default, 2 standalone instances running on port 7006 and 7007. However, you can set this variable to a number of standalone nodes you want, e.g., -e "STANDALONE=1". Note the standalone ports start right after the last slave.

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 environment 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 environment variable to your docker run command.

docker run -e "IP=0.0.0.0" -p 7000-7005:7000-7005 grokzen/redis-cluster:latest 

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 environment 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' 

Be default, it is going to launch 3 masters with 1 slave per master. This is configurable through a number of environment variables:

Therefore, the total number of nodes (NODES) is going to be $MASTERS * ( $SLAVES_PER_MASTER + 1 ) and ports are going to range from $INITIAL_PORT to $INITIAL_PORT + NODES - 1.

At the docker-compose provided by this repository, ports 7000-7050 are already mapped to the hosts'. Either if you need more than 50 nodes in total or if you need to change the initial port number, you should override those values.

Also note that the number of sentinels (if enabled) is the same as the number of masters. The docker-compose file already maps ports 5000-5010 by default. You should also override those values if you have more than 10 masters.

 version: '2' services: redis-cluster: ... environment: INITIAL_PORT: 9000, MASTERS: 2, SLAVES_PER_MASTER: 2 

By default, redis instances will bind and accept requests from any IPv4 network. This is configurable by an environment variable that specifies which address a redis instance will bind to. By using the IPv6 variant :: as counterpart to IPv4s 0.0.0.0 an IPv6 cluster can be created.

Note that Docker also needs to be configured for IPv6 support. Unfortunately Docker does not handle IPv6 NAT so, when acceptable, --network host can be used.

# Example using plain docker docker run -e "IP=::1" -e "BIND_ADDRESS=::" --network host grokzen/redis-cluster:latest 

Authentication is controlled by environment variables on your machine at the time the docker container is built. There are two users you can control and they can be set independently.

The default user is a special user name in Redis. It is the user that can authenticate into the cluster using just a password. It is also the user that the cluster nodes use to authenticate into the cluster itself. By default, Redis does not assign a password to user default. If the environment variable REDIS_DEFAULT_PASSWORD is set, then you must provide a password before issuing any Redis commands in redis-cli. Your application must provide a password to authenticate into the cluster as well.

To build the cluster with the default password, from the docker-redis-cluster directory:

export REDIS_DEFAULT_PASSORD=yourfavoritepassword MAKE BUILD MAKE UP 

After the cluster is running, in a new terminal window

% redis-cli -c -p 7000 127.0.0.1:7000> cluster nodes NOAUTH Authentication required 127.0.0.1:7000> AUTH yourfavoritepassword OK 127.0.0.1:7000> cluster nodes 6edadac1532e3332d45ef31528355cf88da01689 127.0.0.1:7002@17002 master - 0 1611433806048 3 connected 10923-16383 . . . 

To create a custom user in your Redis cluster, add two environment variables: REDIS_USER_NAME and REDIS_USER_PASSWORD. The user created has full access to the system. To experiment with different kinds of access, edit the default-user.tmpl file. See https://redis.io/commands/acl-setuser for more information on configuring ACLs.

To build the cluster with the default password, from the docker-redis-cluster directory:

export REDIS_USER_NAME=username export REDIS_USER_PASSWORD=userpassword MAKE BUILD MAKE UP 

After the cluster is running, in a new terminal window

% redis-cli -c -p 7000 127.0.0.1:7000> cluster nodes NOAUTH Authentication required 127.0.0.1:7000> AUTH username userpassword OK 127.0.0.1:7000> cluster nodes 6edadac1532e3332d45ef31528355cf88da01689 127.0.0.1:7002@17002 master - 0 1611433806048 3 connected 10923-16383 . . . 

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 == 6.0.10

Redis 6.2.x versions:

• 6.2-rc2
• 6.2-rc1

Redis 6.0.x versions:

• 6.0.10
• 6.0.9
• 6.0.8
• 6.0.7
• 6.0.6
• 6.0.5
• 6.0.4
• 6.0.3
• 6.0.2
• 6.0.1
• 6.0.0

Redis 5.0.x version:

• 5.0.10
• 5.0.9
• 5.0.8
• 5.0.7
• 5.0.6
• 5.0.5
• 5.0.4
• 5.0.3
• 5.0.2
• 5.0.1
• 5.0.0

Redis 4.0.x versions:

• 4.0.14
• 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.13
• 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