bitnami/redis-cluster
Bitnami container image for Redis Cluster
100M+
Redis® is an open source, scalable, distributed in-memory cache for applications. It can be used to store and serve data in the form of strings, hashes, lists, sets and sorted sets.
Overview of Redis® Cluster Disclaimer: Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use by Bitnami is for referential purposes only and does not indicate any sponsorship, endorsement, or affiliation between Redis Ltd.
docker run --name redis-cluster -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis-cluster:latest
Looking to use Redis® Cluster in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Redis(R) Cluster Chart GitHub repository.
Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.
Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.
Please check the Bitnami Premium page in our partner Arrow Electronics for more information.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
You can see the equivalence between the different tags by taking a look at the tags-info.yaml
file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml
.
Subscribe to project updates by watching the bitnami/containers GitHub repo.
The recommended way to get the Bitnami Redis(R) Cluster Docker Image is to pull the prebuilt image from the Docker Hub Registry.
docker pull bitnami/redis-cluster:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
docker pull bitnami/redis-cluster:[TAG]
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build
command. Remember to replace the APP
, VERSION
and OPERATING-SYSTEM
path placeholders in the example command below with the correct values.
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
For persistence you should mount a directory at the /bitnami
path. If the mounted directory is empty, it will be initialized on the first run.
docker run \
-e ALLOW_EMPTY_PASSWORD=yes
-v /path/to/redis-cluster-persistence:/bitnami \
bitnami/redis-cluster:latest
You can also do this with a minor change to the docker-compose.yml
file present in this repository:
redis-cluster:
...
volumes:
- /path/to/redis-cluster-persistence:/bitnami
...
Using Docker container networking, a different server running inside a container can easily be accessed by your application containers and vice-versa.
Containers attached to the same network can communicate with each other using the container name as the hostname.
Step 1: Create a network
docker network create redis-cluster-network --driver bridge
Step 2: Launch the Redis(R) Cluster container within your network
Use the --network <NETWORK>
argument to the docker run
command to attach the container to the redis-cluster-network
network.
docker run -e ALLOW_EMPTY_PASSWORD=yes --name redis-cluster-node1 --network redis-cluster-network bitnami/redis-cluster:latest
Step 3: Run another containers
We can launch another containers using the same flag (--network NETWORK
) in the docker run
command. If you also set a name to your container, you will be able to use it as hostname in your network.
The image looks for configurations in /opt/bitnami/redis/mounted-etc/redis.conf
. You can overwrite the redis.conf
file using your own custom configuration file.
docker run --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/your_redis.conf:/opt/bitnami/redis/mounted-etc/redis.conf \
-v /path/to/redis-data-persistence:/bitnami/redis/data \
bitnami/redis-cluster:latest
Alternatively, modify the docker-compose.yml
file present in this repository:
services:
redis-node-0:
...
volumes:
- /path/to/your_redis.conf:/opt/bitnami/redis/mounted-etc/redis.conf
- /path/to/redis-persistence:/bitnami/redis/data
...
Refer to the Redis(R) configuration manual for the complete list of configuration options.
Instead of providing a custom redis.conf
, you may also choose to provide only settings you wish to override. The image will look for /opt/bitnami/redis/mounted-etc/overrides.conf
. This will be ignored if custom redis.conf
is provided.
docker run --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/overrides.conf:/opt/bitnami/redis/mounted-etc/overrides.conf \
bitnami/redis:latest
Alternatively, modify the docker-compose.yml
file present in this repository:
services:
redis:
...
volumes:
- /path/to/overrides.conf:/opt/bitnami/redis/mounted-etc/overrides.conf
...
Customizable environment variables
Name | Description | Default Value |
---|---|---|
REDIS_DATA_DIR | Redis data directory | ${REDIS_VOLUME_DIR}/data |
REDIS_OVERRIDES_FILE | Redis config overrides file | ${REDIS_MOUNTED_CONF_DIR}/overrides.conf |
REDIS_DISABLE_COMMANDS | Commands to disable in Redis | nil |
REDIS_DATABASE | Default Redis database | redis |
REDIS_AOF_ENABLED | Enable AOF | yes |
REDIS_RDB_POLICY | Enable RDB policy persitence | nil |
REDIS_RDB_POLICY_DISABLED | Allows to enable RDB policy persistence | no |
REDIS_MASTER_HOST | Redis master host (used by slaves) | nil |
REDIS_MASTER_PORT_NUMBER | Redis master host port (used by slaves) | 6379 |
REDIS_PORT_NUMBER | Redis port number | $REDIS_DEFAULT_PORT_NUMBER |
REDIS_ALLOW_REMOTE_CONNECTIONS | Allow remote connection to the service | yes |
REDIS_REPLICATION_MODE | Redis replication mode (values: master, slave) | nil |
REDIS_REPLICA_IP | The replication announce ip | nil |
REDIS_REPLICA_PORT | The replication announce port | nil |
REDIS_EXTRA_FLAGS | Additional flags pass to 'redis-server' commands | nil |
ALLOW_EMPTY_PASSWORD | Allow password-less access | no |
REDIS_PASSWORD | Password for Redis | nil |
REDIS_MASTER_PASSWORD | Redis master node password | nil |
REDIS_ACLFILE | Redis ACL file | nil |
REDIS_IO_THREADS_DO_READS | Enable multithreading when reading socket | nil |
REDIS_IO_THREADS | Number of threads | nil |
REDIS_TLS_ENABLED | Enable TLS | no |
REDIS_TLS_PORT_NUMBER | Redis TLS port (requires REDIS_ENABLE_TLS=yes) | 6379 |
REDIS_TLS_CERT_FILE | Redis TLS certificate file | nil |
REDIS_TLS_CA_DIR | Directory containing TLS CA certificates | nil |
REDIS_TLS_KEY_FILE | Redis TLS key file | nil |
REDIS_TLS_KEY_FILE_PASS | Redis TLS key file passphrase | nil |
REDIS_TLS_CA_FILE | Redis TLS CA file | nil |
REDIS_TLS_DH_PARAMS_FILE | Redis TLS DH parameter file | nil |
REDIS_TLS_AUTH_CLIENTS | Enable Redis TLS client authentication | yes |
REDIS_CLUSTER_CREATOR | Launch the cluster bootstrap command | no |
REDIS_CLUSTER_REPLICAS | Number of cluster replicas | 1 |
REDIS_CLUSTER_DYNAMIC_IPS | Use dynamic IPS for cluster creation | yes |
REDIS_CLUSTER_ANNOUNCE_IP | IP to use for announcing the cluster service | nil |
REDIS_CLUSTER_ANNOUNCE_PORT | Client port to use for announcing the cluster service | nil |
REDIS_CLUSTER_ANNOUNCE_BUS_PORT | Cluster message bus port to use for announcing the cluster service | nil |
REDIS_DNS_RETRIES | Number of retries in order to get an addresable domain name | 120 |
REDIS_NODES | List of Redis cluster nodes | nil |
REDIS_CLUSTER_SLEEP_BEFORE_DNS_LOOKUP | Time to wait before the DNS lookup | 0 |
REDIS_CLUSTER_DNS_LOOKUP_RETRIES | Number of retires for the DNS lookup | 1 |
REDIS_CLUSTER_DNS_LOOKUP_SLEEP | Time to sleep between DNS lookups | 1 |
REDIS_CLUSTER_ANNOUNCE_HOSTNAME | Hostname that node should announce, used for non dynamic ip environments. | nil |
REDIS_CLUSTER_PREFERRED_ENDPOINT_TYPE | Preferred endpoint type which cluster should use (ip, hostname) | ip |
Read-only environment variables
Name | Description | Value |
---|---|---|
REDIS_VOLUME_DIR | Persistence base directory | /bitnami/redis |
REDIS_BASE_DIR | Redis installation directory | ${BITNAMI_ROOT_DIR}/redis |
REDIS_CONF_DIR | Redis configuration directory | ${REDIS_BASE_DIR}/etc |
REDIS_DEFAULT_CONF_DIR | Redis default configuration directory | ${REDIS_BASE_DIR}/etc.default |
REDIS_MOUNTED_CONF_DIR | Redis mounted configuration directory | ${REDIS_BASE_DIR}/mounted-etc |
REDIS_CONF_FILE | Redis configuration file | ${REDIS_CONF_DIR}/redis.conf |
REDIS_LOG_DIR | Redis logs directory | ${REDIS_BASE_DIR}/logs |
REDIS_LOG_FILE | Redis log file | ${REDIS_LOG_DIR}/redis.log |
REDIS_TMP_DIR | Redis temporary directory | ${REDIS_BASE_DIR}/tmp |
REDIS_PID_FILE | Redis PID file | ${REDIS_TMP_DIR}/redis.pid |
REDIS_BIN_DIR | Redis executables directory | ${REDIS_BASE_DIR}/bin |
REDIS_DAEMON_USER | Redis system user | redis |
REDIS_DAEMON_GROUP | Redis system group | redis |
REDIS_DEFAULT_PORT_NUMBER | Redis port number (Build time) | 6379 |
Once all the Redis(R) nodes are running you need to execute command like the following to initiate the cluster:
redis-cli --cluster create node1:port node2:port --cluster-replicas 1 --cluster-yes
Where you can add all the node:port
that you want. The --cluster-replicas
parameters indicates how many replicas you want to have for every master.
Depending on the environment you're deploying into, you might run into issues where the cluster initialization is not completing successfully. One of the issue is related to the DNS lookup of the redis nodes performed during cluster initialization. By default, this DNS lookup is performed as soon as all the redis nodes reply to a successful ping.
However, in some environments such as Kubernetes, it can help to wait some time before performing this DNS lookup in order to prevent getting stale records. To this end, you can increase REDIS_CLUSTER_SLEEP_BEFORE_DNS_LOOKUP
to a value around 30
which has been found to be good in most cases.
Starting with version 6, Redis(R) adds the support for SSL/TLS connections. Should you desire to enable this optional feature, you may use the aforementioned REDIS_TLS_*
environment variables to configure the application.
When enabling TLS, conventional standard traffic is disabled by default. However this new feature is not mutually exclusive, which means it is possible to listen to both TLS and non-TLS connection simultaneously. To enable non-TLS traffic, set REDIS_TLS_PORT_NUMBER
to another port different than 0
.
Using docker run
$ docker run --name redis-cluster \
-v /path/to/certs:/opt/bitnami/redis/certs \
-v /path/to/redis-cluster-persistence:/bitnami \
-e ALLOW_EMPTY_PASSWORD=yes \
-e REDIS_TLS_ENABLED=yes \
-e REDIS_TLS_CERT_FILE=/opt/bitnami/redis/certs/redis.crt \
-e REDIS_TLS_KEY_FILE=/opt/bitnami/redis/certs/redis.key \
-e REDIS_TLS_CA_FILE=/opt/bitnami/redis/certs/redisCA.crt \
bitnami/redis-cluster:latest
Modifying the docker-compose.yml
file present in this repository:
redis-cluster:
...
environment:
...
- REDIS_TLS_ENABLED=yes
- REDIS_TLS_CERT_FILE=/opt/bitnami/redis/certs/redis.crt
- REDIS_TLS_KEY_FILE=/opt/bitnami/redis/certs/redis.key
- REDIS_TLS_CA_FILE=/opt/bitnami/redis/certs/redisCA.crt
...
volumes:
- /path/to/certs:/opt/bitnami/redis/certs
...
...
Alternatively, you may also provide with this configuration in your custom configuration file.
When the value of REDIS_RDB_POLICY_DISABLED
is no
(default value) the Redis(R) default persistence strategy will be used. If you want to modify the default strategy, you can configure it through the REDIS_RDB_POLICY
parameter. Here is a demonstration of modifying the default persistence strategy
Using docker run
$ docker run --name redis-cluster \
-v /path/to/redis-cluster-persistence:/bitnami \
-e ALLOW_EMPTY_PASSWORD=yes \
-e REDIS_RDB_POLICY_DISABLED=no
-e REDIS_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
bitnami/redis-cluster:latest
Modifying the docker-compose.yml
file present in this repository:
redis-cluster:
...
environment:
...
- REDIS_TLS_ENABLED=yes
- REDIS_RDB_POLICY_DISABLED=no
- REDIS_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
...
...
The Bitnami Redis(R) Cluster Docker image sends the container logs to stdout
. To view the logs:
docker logs redis-cluster
You can configure the containers logging driver using the --log-driver
option if you wish to consume the container logs differently. In the default configuration docker uses the json-file
driver.
Bitnami provides up-to-date versions of Redis(R) Cluster, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
Step 1: Get the updated image
docker pull bitnami/redis-cluster:latest
Step 2: Stop the running container
Stop the currently running container using the command
docker stop redis-cluster
Step 3: Remove the currently running container
docker rm -v redis-cluster
Step 4: Run the new image
Re-create your container from the new image.
docker run --name redis-cluster bitnami/redis-cluster:latest
The cluster initialization logic has changed. Now the container in charge of initialize the cluster will also be part of the cluster. It will initialize Redis in background, create the cluster and then bring back to foreground the Redis process.
docker-compose.yaml
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.
If you detect any issue in the docker-compose.yaml
file, feel free to report it or contribute with a fix by following our Contributing Guidelines.
We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.
Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.