tons/shepherd

Shepherd

Shepherd是一个Docker Swarm服务，旨在当服务的基础镜像刷新时自动更新这些服务，帮助用户简化容器服务的维护工作，无需手动触发更新。

核心功能

• 自动检测服务基础镜像的更新
• 触发Docker Swarm服务的更新操作
• 支持自定义更新间隔、服务黑名单及私有镜像仓库认证

使用场景

适用于Docker Swarm集群环境中，需要自动保持服务基础镜像最新的场景，例如：

• 持续集成/持续部署（CI/CD）流程中，自动应用镜像更新
• 生产环境中减少手动维护服务更新的工作量

配置说明

Shepherd默认每5分钟检查一次镜像更新，可通过以下环境变量调整配置：

• SLEEP_TIME：设置检查更新的间隔（如"5m"表示5分钟）
• BLACKLIST_SERVICES：空格分隔的服务名称列表，这些服务不会被自动更新
• WITH_REGISTRY_AUTH：是否启用私有镜像仓库认证（设置为"true"启用）

部署示例

使用docker service创建

bash
docker service create --name shepherd \
                      --constraint "node.role==manager" \
                      --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock,ro \
                      mazzolino/shepherd

使用docker-compose部署

yaml
version: "3"
services:
  shepherd:
    image: mazzolino/shepherd
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    deploy:
      placement:
        constraints:
        - node.role == manager

带自定义配置的部署示例

bash
docker service create --name shepherd \
                    --constraint "node.role==manager" \
                    --env SLEEP_TIME="5m" \
                    --env BLACKLIST_SERVICES="shepherd my-other-service" \
                    --env WITH_REGISTRY_AUTH="true" \
                    --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock,ro \
                    --mount type=bind,source=/root/.docker/config.json,target=/root/.docker/config.json,ro \
                    mazzolino/shepherd

工作原理

Shepherd通过更新服务的镜像规范（移除当前摘要）来触发更新。大部分工作由Docker完成：Docker会解析镜像标签、检查仓库是否有新版本，并根据需要更新运行中的容器任务。同时，Docker会处理滚动更新，确保复制服务在更新过程中无明显 downtime。