codestation/swarm-updater

Swarm Updater

自动更新Docker服务，当它们的镜像被更新时。灵感来自https://github.com/v2tec/watchtower

镜像概述和主要用途

Swarm Updater是一个用于Docker Swarm环境的自动更新工具，能够在服务镜像更新时自动更新相应的Docker服务。它提供了灵活的配置选项，支持定时检查、按需更新以及私有仓库认证等功能，适用于需要自动化服务部署和更新的场景。

核心功能和特性

• 自动更新服务：当监控的Docker镜像更新时，自动更新对应的Swarm服务
• 按需更新：通过API端点触发指定镜像的服务更新
• 定时检查：支持Cron表达式配置检查镜像更新的频率
• 灵活的服务筛选：通过标签启用或黑名单排除特定服务
• 私有仓库支持：集成Docker客户端配置，支持私有仓库认证
• 自身更新控制：可配置为最后更新自身服务，避免更新中断
• 镜像仅更新模式：支持仅更新服务镜像而不运行容器（适用于定时任务）

使用场景和适用范围

• Docker Swarm集群中需要自动部署更新的服务
• CI/CD流程中镜像构建完成后的自动部署
• 需要定时检查并更新服务的场景
• 包含私有仓库镜像的服务更新管理
• 对更新顺序有要求的服务集群

使用方法和配置说明

按需更新服务

可通过调用API端点/apis/swarm/v1/update触发指定镜像的服务更新，请求体示例：

json
{
  "images": [
    "mycompany/myapp"
  ]
}

命令行选项与环境变量

所有命令行选项都有对应的环境变量可供配置：

注意：--label-enable和--blacklist不能同时使用

其他环境变量

• DOCKER_API_VERSION：设置Docker API版本，留空则使用应用所需的最低版本
• DOCKER_CERT_PATH：TLS证书目录，当--host为TCP端点时使用

私有仓库认证

需在配置目录（默认~/.docker）下放置config.json文件，包含私有仓库凭据。可通过docker login <registry>命令生成该文件。

特殊标签配置

延迟自身更新

为swarm-updater服务添加标签xyz.megpoid.swarm-updater=true，使其成为最后更新的服务：

bash
docker service create --label xyz.megpoid.swarm-updater=true ... swarm-updater-image

仅更新镜像不运行容器

为服务添加标签xyz.megpoid.swarm-updater.update-only=true，仅更新镜像而不运行容器：

bash
docker service create --label xyz.megpoid.swarm-updater.update-only=true ... your-service-image

注意：该标签会将服务副本数设置为0，对全局复制模式无效

部署示例

基本部署（定时检查）

bash
docker service create \
  --name swarm-updater \
  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
  --env SCHEDULE="0 0 */4 * * *" \  # 每4小时检查一次
  --env LABEL_ENABLE=1 \  # 仅更新带指定标签的服务
  swarm-updater-image

带API端点和密钥的部署

bash
docker service create \
  --name swarm-updater \
  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
  --mount type=bind,source=$HOME/.docker,target=/root/.docker \  # 私有仓库配置
  --env LISTEN=0.0.0.0:8080 \  # 监听所有地址的8080端口
  --env APIKEY=your-secure-key \  # 设置API密钥
  --publish 8080:8080 \
  swarm-updater-image