duyquyen/redis-cluster

docker-redis-cluster

![Build Status]([***]

从源码构建并安装Redis，且已搭建好集群的Docker镜像。

所有Redis服务器版本可查看：https://github.com/antirez/redis/releases

讨论、帮助与指南

GitHub近期为更多仓库启用了测试版"Discussions"功能，本仓库已启用此功能。

因此，issues功能不再用于提问通用问题或寻求简单帮助。

你可以在Discussions中找到：

• 自由提问关于本仓库的任何问题
• 提问如"如何执行X操作？"等问题
• 获取使用本仓库时遇到的问题的帮助
• 由作者或贡献者编写的指南，包含常用问题示例和解决方案
• 社区提供的问题解答，经作者标记为推荐答案

本仓库和容器是什么

本仓库旨在提供快速、简单、无繁琐配置地搭建Redis集群的资源，只需最少操作即可启动集群。容器的主要用途是快速搭建可用于演示、展示或开发的Redis集群，不用于其他场景。

目标是支持所有支持集群功能的Redis版本，以便你能运行所需的精确版本。

作者个人使用此镜像开发Redis集群客户端代码：https://github.com/Grokzen/redis-py-cluster

本仓库和容器不是什么

本容器并非生产环境容器，也不应用于本地机器以外的任何环境。不建议在Kubernetes或任何生产/ staging/测试/开发环境中作为功能组件运行。如果它恰好满足你的使用场景，那很好，但本容器不会为适应此类场景而更改。

如果你需要生产级或Kubernetes兼容的解决方案，本仓库不适用。其他项目或本仓库的分支可能提供此类兼容方案。

对于本仓库未声明的用途，你可以自由fork或基于本容器模板构建所需内容。

Redis主要版本支持与Docker Hub可用性

自2020-04-01起，本仓库仅支持并在Docker Hub提供Redis服务器最新3个主要版本的所有次要版本。此日期起，Docker Hub上3.0、3.2和4.0主要版本的标签将被移除，仅提供5.0、6.0和6.2版本。这并不意味着你无法从本仓库构建所需版本，但不保证开箱即用的支持或兼容。

未来，当新主要版本发布后，在其首个次要版本X.Y.1发布时，最旧的支持主要版本标签将从Docker Hub移除。这为社区提供了适应新版本的时间。

此主要版本支持策略与Redis官方支持策略一致。

容器内的Redis实例

集群包含6个Redis实例，3主3从（每个主节点1个从节点），运行在端口7000至7005。

若传递标志-e "SENTINEL=true"，将启动3个哨兵节点，运行在端口5000至5002，对应集群的主实例。

本镜像至少需要Docker 1.10版本，推荐使用最新版本。

Mac用户注意事项

若在Mac电脑上使用此容器运行Redis集群，需配置容器使用其他IP地址进行集群发现，因为容器无法使用默认的硬编码发现IP。

若使用docker-compose文件构建容器，需在构建前在机器上导出环境变量：

bash
# 使Redis执行集群发现并将所有节点绑定到内部IP 127.0.0.1

export REDIS_CLUSTER_IP=0.0.0.0

若从Docker Hub下载容器，需在docker run命令中添加内部IP环境变量：

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

使用方法

本Git仓库使用pyinvoke拉取、构建、推送Docker镜像。你可使用它构建自己的镜像。

仓库中的invoke脚本仅支持Python 3.7及以上版本。

通过pip install invoke安装pyinvoke。

脚本将基于输入的版本，使用(CPU数量 - 1)个并行任务。

在仓库根目录运行invoke -l查看可用命令，示例：

bash
(tmp-615229a94c330b9) ➜  docker-redis-cluster git:(pyinvoke) ✗ invoke -l
"Configured multiprocess pool size: 3
Available tasks:

  build
  pull
  push

每个命令仅接受一个必填位置参数version，示例：

bash
(tmp-615229a94c330b9) ➜  docker-redis-cluster git:(pyinvoke) ✗ invoke build 6.0
...

此命令将对所有以6.0开头的版本执行构建步骤。

唯一其他有用的可选参数是--cpu=N，用于设置并行进程数。默认使用系统可用CPU核心数减1。拉取和推送命令对CPU消耗较低，若网络带宽良好，增加此数值可加速操作。

Makefile（遗留）

Makefile仍包含部分可使用的docker-compose命令：

构建镜像：

make build

启动容器：

make up

停止容器：

make down

连接集群可使用redis-cli工具：

redis-cli -c -p 7000

或使用容器内的内置redis-cli连接容器内集群：

make cli

包含哨兵实例

哨兵实例默认不启用。

使用纯Docker运行时，传递-e SENTINEL=true。

使用docker-compose时，在系统上设置环境变量REDIS_USE_SENTINEL=true并启动容器：

yaml
version: '2'
services:
  redis-cluster:
    ...
  environment:
    SENTINEL: 'true'

更改节点数量

默认启动3个主节点，每个主节点1个从节点。可通过以下环境变量配置：

因此，总节点数（NODES）为$MASTERS * ($SLAVES_PER_MASTER + 1)，端口范围从$INITIAL_PORT到$INITIAL_PORT + NODES - 1。

本仓库提供的docker-compose已将7000-7050端口映射到主机。若需超过50个节点或更改初始端口，需覆盖这些值。

注意：若启用哨兵，哨兵数量与主节点数量相同。docker-compose默认映射5000-5010端口，若主节点超过10个，也需覆盖这些值。

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

IPv6支持

默认情况下，Redis实例绑定并接受所有IPv4网络的请求。可通过环境变量指定Redis实例绑定的地址，使用IPv6的::（对应IPv4的0.0.0.0）可创建IPv6集群。

注意：Docker需配置IPv6支持（参考：[***]

遗憾的是，Docker不处理IPv6 NAT，因此在允许的情况下，可使用--network host。

bash
# 纯Docker示例
docker run -e "IP=::1" -e "BIND_ADDRESS=::" --network host grokzen/redis-cluster:latest

启用认证

默认禁用密码认证。可通过环境变量指定认证密码，客户端需使用AUTH命令认证。

保护模式

默认启用保护模式。可通过环境变量配置，管理员可忽略Redis错误，禁用保护模式或手动绑定所有接口。

构建其他Redis版本

需构建的版本需存在于以下URL：[***]

docker build

使用--build-arg参数构建不同Redis版本：

bash
# 纯Docker示例
docker build --build-arg redis_version=6.0.11 -t grokzen/redis-cluster .

docker-compose

使用--build-arg参数构建不同Redis版本：

bash
# docker-compose示例
docker-compose build --build-arg "redis_version=6.0.11" redis-cluster

可用标签

Docker Hub上提供以下预构建镜像标签:

最新稳定分支的最新版本标记为latest。

• latest == 6.2.1

Redis 6.2.x版本:

• 6.2.1
• 6.2.0
• 6.2-rc2
• 6.2-rc1

Redis 6.0.x版本:

• 6.0.12
• 6.0.11
• 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版本:

• 5.0.12
• 5.0.11
• 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

不再提供的主要版本

以下主要版本不再能从Docker Hub下载，但仍可从本仓库直接构建和运行:

• 4.0
• 3.2
• 3.0

许可证

本仓库使用MIT许可证。

详见文件LICENSE