martel/mongo-replica-ctrl

Docker Swarm集群的MongoDB副本集控制器

![构建状态]([***]

本仓库提供了一个Docker化的控制器，用于在Docker Swarm集群上部署的MongoDB副本集。

官方测试过的Mongo版本：

• 3.6
• 3.4
• 3.2
• 3.0

官方测试过的Docker版本：

• 17.06
• 17.09
• 17.03（通过https://github.com/smartsdk/mongo-rs-controller-swarm/blob/d17.06.0-m3.2/docker-compose.yml%E5%8F%8A%E4%BD%BF%E7%94%A8secrets%EF%BC%89

使用方法

首先，你需要已搭建好Docker Swarm集群（Docker版本≥17.06.0-ce，本地搭建可参考测试部分）。其次，创建名为backend的overlay网络（创建网络和Swarm集群时需注意MTU问题：本地无此问题，但云服务商可能遇到）：

bash
docker network create --opt encrypted -d overlay backend

（如需修改默认MTU，添加--opt com.docker.network.driver.mtu=MTU_VALUE）

然后运行：

bash
docker stack deploy -c docker-compose.yml STACK_NAME

或者使用我们提供的简单脚本覆盖上述步骤：

bash
sh deploy.sh

等待镜像拉取和服务部署完成（约几分钟），可通过以下命令检查服务状态：

bash
docker service ls

预期输出类似：

ID                  NAME                MODE                REPLICAS            IMAGE                              PORTS
hmld6tiwr5o0        mongo_mongo         global              0/3                 mongo:3.2                          *:27017->27017/tcp
uppaix6drfps        mongo_controller    replicated          1/1                 martel/mongo-replica-ctrl:latest   

查看控制器日志以了解操作情况：

bash
docker service logs -f mongo_controller

移除栈：

bash
sh remove.sh

可通过docker-compose.yml中的环境变量配置部署（变量用于控制器服务，未配置可能导致服务异常）：

• MONGO_VERSION：默认值3.2
• REPLICASET_NAME：默认值rs
• MONGO_PORT：默认值27017
• BACKEND_NETWORK_NAME：默认值backend
• STACK_NAME：默认值mongo
• MONGO_SERVICE_NAME：默认值${STACK_NAME}_mongo

核心功能

• ✅ 连接已存在的副本集
• ✅ Docker Compose配置包含MongoDB健康检查脚本
• ✅ 检测新主节点
• ✅ 副本集不一致时强制选举新主节点
• ✅ 从 scratch 构建副本集
• ✅ 根据Swarm集群变化动态添加/移除节点
• ✅ 推荐配置失败重启策略，确保节点移除/排空时脚本重启（需多个主节点）
• ✅ 包含Travis CI测试，覆盖单节点Swarm环境的基础场景（初始化、扩容、缩容）
• ✅ 集成Nosqlclient作为MongoDB管理工具

使用场景

适用于需要在Docker Swarm集群中部署高可用MongoDB副本集的场景，如生产环境的数据库集群、需要动态扩展的应用后端等。

配置说明

• 数据持久化：生产环境推荐开启，Mongo服务需部署为global模式（避免同一节点多实例并发访问数据空间）。
• 控制器部署：需在Swarm管理节点部署单实例（多实例可能导致冲突），并配置重启策略（确保故障时重启）。
• HA建议：生产环境Swarm集群需多个管理节点，确保控制器在节点故障时可在其他节点启动。
• 外部访问：如需Swarm overlay网络外访问Mongo集群，可取消docker-compose.yml中Ports部分的注释。
• 健康检查：Mongo健康检查脚本仅验证服务状态，集群状态由控制器管理。
• 调试：开启DEBUG环境变量（取消docker-compose.yml中对应行注释）可查看详细日志。
• 服务命名：同一栈中其他服务名称不要以mongo开头，避免控制器误判。
• 管理工具：可通过docker-compose-addons.yml集成nosqlclient，启动前设置NOSQLCLIENT_PORT变量：

  bash
  docker stack deploy -c docker-compose-addons.yml addons
  

测试

前提条件

• Docker Swarm集群（Docker≥17.06.0-ce）
• 客户端安装https://github.com/kward/shunit2
• （可选）VirtualBox、docker-machine（用于utils脚本）
• Docker客户端已配置指向Swarm集群

工具

使用https://github.com/aelsabbahy/miniswarm%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E6%B5%8B%E8%AF%95%E9%9B%86%E7%BE%A4%EF%BC%9A

bash
# 安装miniswarm（root用户）
curl -sSL https://raw.githubusercontent.com/aelsabbahy/miniswarm/master/miniswarm -o /usr/local/bin/miniswarm
chmod +rx /usr/local/bin/miniswarm

# 创建集群（1个管理节点，2个工作节点）
miniswarm start 3

# 连接集群
eval $(docker-machine env ms-manager0)

# 删除集群
miniswarm delete

运行测试

脚本test-locally.sh覆盖以下场景：

• ✅ 启动带持久化的Mongo集群，验证控制器配置正确性
• ✅ 杀死Mongo容器，验证新容器创建及集群状态正常
• ✅ 停止Swarm节点，验证集群状态正常
• ✅ 重启Swarm节点，验证集群状态正常

运行测试：

bash
sh test/test-locally.sh

注意：ci-test开头的测试为Travis CI设计，本地运行需安装Mongo客户端。

待办

• ❌ 支持MongoDB认证
• ❌ 添加Travis CI测试验证主/从节点故障场景
• ❌ 改进get_mongo_service函数，避免与其他以mongo开头的服务冲突

贡献

欢迎通过Pull Request贡献代码。