oliver006/valkey-cluster

docker-valkey-cluster

镜像概述

本Docker镜像基于官方Valkey镜像构建，用于本地开发和测试Valkey集群环境。它fork自https://github.com/mix3/valkey-redis-cluster项目，并新增`VALKEY_PASSWORD`等功能支持，主要用于https://github.com/oliver006/redis_exporter的CI流程。

注意：本镜像不适合生产环境，它在单个容器内运行6个Valkey集群节点，仅作为本地开发和测试集群相关代码的便捷工具（如验证AWS Elasticache/Valkey等集群场景下的代码逻辑）。

核心功能

• 快速搭建本地Valkey集群（默认3主1从共6节点）
• 支持设置Valkey密码（VALKEY_PASSWORD）
• 可启用哨兵（Sentinel）实例
• 自定义集群节点数量（主节点数、每主节点从节点数）
• 支持IPv6配置
• 可构建不同版本的Valkey集群镜像

使用场景

• 本地开发：验证集群环境下的代码逻辑，避免单节点测试遗漏的跨节点键操作等bug
• CI/CD：在持续集成流程中测试集群相关功能（如redis_exporter对Valkey集群的兼容性）

配置说明

Mac用户特别注意

若在Mac上使用本镜像，需配置集群发现IP：

bash
# 导出环境变量，使集群内部绑定到0.0.0.0
export VALKEY_CLUSTER_IP=0.0.0.0

包含哨兵实例

默认不启用哨兵，可通过环境变量开启：

• Docker run命令：

  bash
  docker run -e "SENTINEL=true" -p 7000-7005:7000-7005 docker.xuanyuan.run/oliver006/valkey-cluster:latest
  

• Docker Compose配置：

  yaml
  services:
    valkey-cluster:
      environment:
        SENTINEL: 'true'
  

修改节点数量

通过环境变量自定义集群节点数：

示例（Docker Compose配置）：

yaml
services:
  valkey-cluster:
    environment:
      INITIAL_PORT: 9000
      MASTERS: 2
      SLAVES_PER_MASTER: 2

IPv6支持

需先配置Docker支持IPv6，再通过环境变量启用：

bash
docker run -e "IP=::1" -e "BIND_ADDRESS=::" --network host docker.xuanyuan.run/oliver006/valkey-cluster:latest

构建替代Valkey版本

使用Docker Buildx构建多架构（linux/arm64、linux/amd64）镜像，推送至Docker Hub的标签格式为oliver006/valkey-cluster:<valkey-version>-<git-tag>或latest。

部署示例

Docker Run命令

bash
# 基础运行（Mac用户需先导出VALKEY_CLUSTER_IP=0.0.0.0）
docker run -p 7000-7005:7000-7005 docker.xuanyuan.run/oliver006/valkey-cluster:latest

# 启用哨兵
docker run -e "SENTINEL=true" -p 7000-7005:7000-7005 -p 5000-5003:5000-5003 docker.xuanyuan.run/oliver006/valkey-cluster:latest

Docker Compose配置

yaml
version: '3'
services:
  valkey-cluster:
    image: docker.xuanyuan.run/oliver006/valkey-cluster:latest
    ports:
      - "7000-7005:7000-7005"
      - "5000-5003:5000-5003" # 若启用哨兵
    environment:
      VALKEY_CLUSTER_IP: 0.0.0.0 # Mac用户必填
      SENTINEL: 'true' # 可选启用哨兵
      MASTERS: 3 # 可选自定义主节点数

许可证

本项目采用MIT许可证，基于Johan Andersson的grokzen/redis-cluster项目开发。详情见LICENSE文件。