tommy351/redis-cluster

docker-redis-cluster 镜像文档

镜像概述

docker-redis-cluster 是一个用于快速部署 Redis 集群的 Docker 镜像，基于 Redis 官方版本构建，集成了集群初始化所需的工具和配置。

主要用途

该镜像专为测试环境设计，用于快速搭建 Redis 集群环境，方便开发和测试过程中的集群功能验证。请勿用于生产环境。

核心功能与特性

• 自动集群部署：启动后自动创建包含 6 个 Redis 节点（监听端口 7000~7005）的集群，默认配置为 3 主 3 从架构。
• 进程管理：集成 supervisor 工具，确保所有 Redis 节点稳定运行。
• 自动初始化：通过 redis-trib 工具自动完成集群节点发现、槽位分配及主从关系配置。
• 数据持久化：支持通过数据卷挂载 /data 目录，实现集群数据持久化。
• 网络适配：Redis 4.0 及以上版本支持通过环境变量 CLUSTER_ANNOUNCE_IP 配置集群对外宣告 IP，解决跨主机或容器网络通信问题。

使用场景与适用范围

• 开发环境：快速搭建本地 Redis 集群，用于开发过程中的集群功能调试。
• 测试环境：验证依赖 Redis 集群的应用功能，如分布式锁、数据分片等场景。
• 适用限制：仅适用于非生产环境，不具备生产级高可用、监控及容灾能力。

使用方法与配置说明

基本启动

通过 docker run 命令启动集群，默认暴露节点端口 7000~7005，可直接映射到宿主机：

sh
docker run -d \
  -p 7000:7000 \
  -p 7001:7001 \
  -p 7002:7002 \
  -p 7003:7003 \
  -p 7004:7004 \
  -p 7005:7005 \
  docker.xuanyuan.run/tommy351/redis-cluster:3.2

参数说明：

• -d：后台运行容器。
• -p 7000:7000 ... -p 7005:7005：将容器内 Redis 节点端口映射到宿主机，允许外部访问集群节点。
• tommy351/redis-cluster:3.2：指定镜像及版本（支持 3.2、4.0 等标签，对应不同 Redis 版本）。

数据持久化（挂载数据卷）

通过 -v 参数挂载宿主机目录到容器 /data 目录，实现集群数据持久化：

sh
docker run -d \
  -v /宿主机路径/data:/data \
  docker.xuanyuan.run/tommy351/redis-cluster:3.2

说明：容器内所有 Redis 节点的持久化文件（如 dump.rdb、appendonly.aof）及集群配置文件均存储于 /data 目录，挂载后数据将保留在宿主机指定路径。

配置集群宣告 IP（Redis 4.0+）

Redis 4.0 及以上版本支持通过环境变量 CLUSTER_ANNOUNCE_IP 指定集群对外宣告的 IP 地址，解决容器网络中节点间通信时的 IP 识别问题（如跨主机部署或 NAT 网络环境）：

sh
docker run -d \
  -e CLUSTER_ANNOUNCE_IP=192.168.1.100 \  # 替换为实际集群对外暴露的 IP
  tommy351/redis-cluster:4.0

背景：当容器内 IP 与外部访问 IP 不一致时（如宿主机端口映射场景），节点会向集群宣告容器内 IP，导致其他节点无法通信。通过 CLUSTER_ANNOUNCE_IP 可强制指定外部可访问的 IP。

Docker Compose 配置示例

以下为 docker-compose.yml 示例，适用于本地快速启动集群：

yaml
version: '3'
services:
  redis-cluster:
    image: docker.xuanyuan.run/tommy351/redis-cluster:4.0
    ports:
      - "7000:7000"
      - "7001:7001"
      - "7002:7002"
      - "7003:7003"
      - "7004:7004"
      - "7005:7005"
    volumes:
      - ./redis-data:/data  # 宿主机当前目录下 redis-data 目录挂载到容器 /data
    environment:
      - CLUSTER_ANNOUNCE_IP=127.0.0.1  # 本地测试时指定为宿主机回环 IP
    restart: unless-stopped

启动命令：docker-compose up -d

环境变量说明

许可证

本镜像遵循 MIT 许可证。详情参见 https://opensource.org/licenses/MIT%E3%80%82