davideshay/dockerautolabel

dockerautolabel

Docker Swarm集群的自动标签工具

Docker/Github构建状态

!Docker Pulls !GitHub Workflow Status !Docker Image Size (latest by date)

镜像概述和主要用途

dockerautolabel是一个专为Docker Swarm集群设计的自动标签工具，需作为服务运行在Swarm管理节点。其核心功能是自动创建、更新节点标签，并保持标签与服务运行位置的同步。例如，若运行名为"clusterip"的虚拟IP keepalived服务，集群中大多数节点会被标记"running_clusterip=0"，而实际运行该服务的节点则标记为"running_clusterip=1"。

核心功能和特性

• 自动标签管理：实时监控指定服务运行位置，自动为节点创建/更新标签（值为0或1）
• 服务亲和性支持：通过标签实现服务间的位置依赖，解决特定服务需在同一物理节点运行的问题
• 动态同步：当服务因故障或调度迁移时，自动更新相关节点标签，触发依赖服务跟随迁移
• 配置灵活：通过配置文件指定需监控的服务及对应标签名称

使用场景和适用范围

适用于需要实现服务亲和性部署的Docker Swarm集群环境，典型场景包括：

• 需在同一节点运行网络主机模式服务与依赖服务
• 多服务间存在网络或存储依赖，需协同部署
• 希望实现服务故障迁移时依赖服务自动跟随的场景

例如：将Traefik服务与clusterip服务部署在同一节点，当clusterip服务迁移时，Traefik服务自动跟随。

使用方法和配置说明

配置文件准备

创建逗号分隔的配置文件servicelist.txt，每行包含两个值：需监控的服务名称和要设置的标签名称。格式如下：

bash
# 服务名称,标签名称
cluster_clusterip,running_clusterip

注意：若使用docker stack deploy部署服务，服务名称需包含栈名称前缀（如上述示例中的cluster_为栈名称）。

部署要求

1. 文件挂载：需将配置文件目录或文件挂载到容器内/config/servicelist.txt
2. Docker Socket挂载：需挂载/var/run/docker.sock以访问Docker API
3. 运行位置：必须部署在Swarm管理节点

Docker Compose部署示例

docker
version: "3.7"
services:
    dockerautolabel:
        image: davideshay/dockerautolabel:1
        volumes:
           # 挂载配置文件目录，确保servicelist.txt位于该目录下
           - /data/docker/config/dockerautolabel:/config
           # 挂载Docker Socket
           - /var/run/docker.sock:/var/run/docker.sock
        networks:
           - proxy-net
        deploy:
            placement:
               constraints:
                  # 限制在管理节点运行
                  - node.role==manager

networks:
    proxy-net:
          external: true  # 使用已存在的外部网络

服务亲和性配置示例

在依赖服务的部署配置中，通过node.label约束实现与目标服务的同节点部署：

docker
services:
    traefik:
        # ... 其他配置 ...
        deploy:
            placement:
               constraints:
                  # 仅在clusterip服务运行的节点部署（标签值为1）
                  - node.label.running_clusterip=1