shizunge/gantry Docker Image Overview

shizunge/gantry

自动更新Docker Swarm中选定服务至其标签对应的最新镜像的Docker服务，受Shepherd启发并增强功能。

0 次下载activeshizunge镜像

Gantry - Docker服务更新器

![Release]([] ![License]([] ![Image Size]([] ![Docker Pulls]([] ![Build]([] ![Coverage]([] ![CodeFactor Grade]([***]

Gantry 自动更新Docker Swarm中选定的服务至具有相同标签的较新镜像。它的设计受Shepherd启发，但功能更强大。

使用方法

Gantry以容器镜像形式发布。您可以创建Docker服务并在Swarm管理节点上运行它。

bash
docker service create \
  --name gantry \
  --mode replicated-job \
  --constraint "node.role==manager" \
  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
  shizunge/gantry

examples文件夹包含示例docker-compose文件以及更多启动Gantry的方法，例如定时运行和通过Webhook触发。

您也可以直接在容器外的主机上作为脚本运行Gantry：

bash
./src/entrypoint.sh

Gantry兼容busybox ash（v1.35+）和bash。

配置

您可以通过环境变量配置Gantry的大多数行为。

通用配置

环境变量	默认值	描述
GANTRY_LOG_LEVEL	INFO	控制Gantry生成的日志数量。有效值为NONE、ERROR、WARN、INFO、DEBUG。
GANTRY_NODE_NAME		向日志添加节点名称。若未设置，Gantry将使用Docker Swarm管理节点的主机名（从当前节点的Docker守护进程套接字或`DOCKER_HOST`读取）。
GANTRY_POST_RUN_CMD		每次更新迭代后要`eval`执行的命令。例如，您可以使用此命令删除未使用的容器、网络和镜像，或更新独立Docker容器（参见示例）。
GANTRY_PRE_RUN_CMD		每次更新迭代前要`eval`执行的命令。例如，您可以使用此命令删除未使用的容器、网络和镜像，或更新独立Docker容器（参见示例）。若预运行命令执行失败，Gantry将跳过服务更新。
GANTRY_SLEEP_SECONDS	0	两次更新之间的间隔（秒）。设为0表示运行一次后退出。当设为非零值时，更新完成后Gantry将休眠至下次计划更新时间（实际休眠时间为该值减去更新耗时）。
TZ		设置日志中的时区。

Gantry基于Docker命令行，Docker命令行的环境变量同样适用于Gantry。

登录镜像仓库

环境变量	默认值	描述
DOCKER_CONFIG		客户端配置文件的位置，用于存储认证信息。适用于所有Docker命令（即所有服务）。参见认证。您可以通过标签为特定服务设置不同值。
GANTRY_REGISTRY_CONFIG		参见认证。
GANTRY_REGISTRY_CONFIG_FILE		参见认证。
GANTRY_REGISTRY_CONFIGS_FILE		参见认证。
GANTRY_REGISTRY_HOST		参见认证。
GANTRY_REGISTRY_HOST_FILE		参见认证。
GANTRY_REGISTRY_PASSWORD		参见认证。
GANTRY_REGISTRY_PASSWORD_FILE		参见认证。
GANTRY_REGISTRY_USER		参见认证。
GANTRY_REGISTRY_USER_FILE		参见认证。

选择服务

环境变量	默认值	描述
GANTRY_SERVICES_EXCLUDED		空格分隔的服务名称列表，这些服务将被排除在更新之外。
GANTRY_SERVICES_EXCLUDED_FILTERS	`label=gantry.services.excluded=true`	空格分隔的过滤器列表，例如`label=project=project-a`。排除匹配给定过滤器的服务。默认值允许您通过为服务添加标签`gantry.services.excluded=true`来排除它们。注意：多个过滤器为逻辑“与”关系。空字符串表示无过滤器，Gantry将更新所有服务。
GANTRY_SERVICES_FILTERS		空格分隔的过滤器列表，用于`docker service ls --filter`选择要更新的服务，例如`label=project=project-a`。注意：多个过滤器为逻辑“与”关系。空字符串表示无过滤器，Gantry将更新所有服务。另请参见如何按名称过滤多个服务。

注意：Gantry读取服务上的标签，而非容器上的标签。若使用docker-compose文件设置服务，标签需添加到deploy部分。

检查新镜像是否可用

环境变量	默认值	描述
GANTRY_MANIFEST_CMD	buildx	有效值为`buildx`、`manifest`和`none`。设置用于检查镜像清单的命令： `docker buildx imagetools inspect` `docker manifest inspect` 设为`none`将跳过清单检查，此时`docker service update`将始终执行。另请参见FAQ如何选择GANTRY_MANIFEST_CMD。您可以通过标签为特定服务设置不同值。
GANTRY_MANIFEST_NUM_WORKERS	1	可并行运行的`GANTRY_MANIFEST_CMD`最大数量。
GANTRY_MANIFEST_OPTIONS		附加到`docker buildx imagetools inspect`或`docker manifest inspect`命令的选项（取决于`GANTRY_MANIFEST_CMD`的值），适用于所有服务。您可以通过标签为特定服务设置不同值。

添加服务更新选项

环境变量	默认值	描述
GANTRY_ROLLBACK_ON_FAILURE	true	设为`true`时，更新失败将自动回滚；设为`false`则禁用回滚。您可以通过标签为特定服务设置不同值。
GANTRY_ROLLBACK_OPTIONS		附加到`docker service update --rollback`命令的选项，适用于所有服务。您可以通过标签为特定服务设置不同值。
GANTRY_UPDATE_JOBS	false	设为`true`时更新`replicated-job`或`global-job`类型的服务；设为`false`则禁用。当服务无运行任务时，Gantry会向`docker service update`添加额外选项。您可以通过标签为特定服务设置不同值。
GANTRY_UPDATE_NUM_WORKERS	1	可并行执行的更新操作最大数量。
GANTRY_UPDATE_OPTIONS		附加到`docker service update`命令的选项，适用于所有服务。您可以通过标签为特定服务设置不同值。
GANTRY_UPDATE_TIMEOUT_SECONDS	0	单个服务更新超时时间（秒）。设为`0`禁用超时。您可以通过标签为特定服务设置不同值。

更新后操作

环境变量	默认值	描述
GANTRY_CLEANUP_IMAGES	true	设为`true`时清理所有主机上已更新的旧镜像；设为`false`则禁用清理。清理前，Gantry将尝试删除使用这些镜像的所有已退出（exited）和已终止（dead）容器。
GANTRY_CLEANUP_IMAGES_OPTIONS		附加到`docker service create`命令的选项，用于创建清理镜像的全局任务。您可以使用此选项为服务或容器添加标签。
GANTRY_NOTIFICATION_APPRISE_URL		通过Apprise启用服务更新通知。此值必须指向通知端点（例如`[***]`）。
GANTRY_NOTIFICATION_CONDITION	all	有效值为`all`和`on-change`。指定发送通知的条件：`all`表示每次运行都发送通知；`on-change`仅在有更新或错误时发送通知。
GANTRY_NOTIFICATION_TITLE		向通知标题添加附加消息。

标签	描述
`gantry.auth.config=<configuration>`	覆盖`DOCKER_CONFIG`。参见认证。
`gantry.services.excluded=true`	若使用默认`GANTRY_SERVICES_EXCLUDED_FILTERS`，此标签会将服务排除在更新之外。
`gantry.manifest.cmd=<command>`	覆盖`GANTRY_MANIFEST_CMD`。
`gantry.manifest.options=<string>`	覆盖`GANTRY_MANIFEST_OPTIONS`。
`gantry.rollback.on_failure=<boolean>`	覆盖`GANTRY_ROLLBACK_ON_FAILURE`。
`gantry.rollback.options=<string>`	覆盖`GANTRY_ROLLBACK_OPTIONS`。
`gantry.update.jobs=<boolean>`	覆盖`GANTRY_UPDATE_JOBS`。
`gantry.update.options=<string>`	覆盖`GANTRY_UPDATE_OPTIONS`。
`gantry.update.timeout_seconds=<number>`	覆盖`GANTRY_UPDATE_TIMEOUT_SECONDS`。