volkerraschek/dcmerge

dcmerge

镜像概述和主要用途

dcmerge 是一款轻量级工具，用于合并来自多个来源的docker-compose文件，支持本地文件和HTTP/HTTPS网络来源。它提供三种合并策略，帮助用户灵活管理复杂或多环境的docker-compose配置。工具要求environments、ports和volumes字段必须声明为字符串切片，暂不支持动态模式（如同时作为字符串切片和对象列表）。

核心功能和特性

支持的来源

• 本地文件：读取本地文件系统中的docker-compose文件
• HTTP/HTTPS：通过HTTP或HTTPS协议获取远程docker-compose文件

合并策略

• 默认合并（default）：仅添加缺失的secrets、services、networks和volumes，不处理已存在项的属性。若服务（如app）已声明，后续同名服务将被完全跳过。
• existing-win合并：添加并保护已存在的属性。若同一属性在多个文件中存在，第一个声明的值将被保留，后续声明不会覆盖。
• last-win合并：递归覆盖已存在的属性。若同一属性在多个文件中存在，最后传入的文件中声明的值将覆盖前面的值。

使用场景和适用范围

• 合并基础配置与环境特定配置（如开发、测试、生产环境的差异化配置）
• 整合不同团队或模块维护的docker-compose配置片段
• 管理包含多层级依赖的复杂docker-compose配置

使用方法和配置说明

Docker基础运行命令

通过Docker运行dcmerge的基本命令格式：

bash
docker run --rm -v $(pwd):/workdir volkerraschek/dcmerge [选项] <docker-compose文件1> <docker-compose文件2> ...

说明：-v $(pwd):/workdir 将当前目录挂载到容器的/workdir，以便访问本地文件。使用HTTP/HTTPS来源时无需挂载目录。

合并策略详细说明

1. 默认合并（default）

特点：仅添加缺失的secrets、services、networks和volumes，不处理已存在项的属性。

示例：

本地文件：

yaml
# docker-compose-A.yaml
services:
  app:
    environments:
    - CLIENT_SECRET=HelloWorld123
    image: example.local/app/name:0.1.0

yaml
# docker-compose-B.yaml
services:
  app:
    image: app/name:2.3.0
    volume:
    - /etc/localtime:/etc/localtime
    - /dev/urandom:/etc/urandom
  db:
    image: postgres
    volume:
    - /etc/localtime:/etc/localtime
    - /dev/urandom:/etc/urandom

合并命令：

bash
docker run --rm -v $(pwd):/workdir volkerraschek/dcmerge /workdir/docker-compose-A.yaml /workdir/docker-compose-B.yaml

合并结果：

yaml
services:
  app:
    environments:
    - CLIENT_SECRET=HelloWorld123
    image: example.local/app/name:0.1.0  # 已存在的服务app不被覆盖
  db:
    image: postgres  # 添加缺失的db服务
    volume:
    - /etc/localtime:/etc/localtime
    - /dev/urandom:/etc/urandom

2. existing-win合并

特点：保护已存在的属性，第一个声明的值优先保留。

示例：

本地文件：

yaml
# docker-compose-A.yaml
services:
  app:
    environments:
    - CLIENT_SECRET=HelloWorld123
    image: example.local/app/name:0.1.0

yaml
# docker-compose-B.yaml
services:
  app:
    environments:
    - CLIENT_SECRET=FooBar123  # 与A中属性冲突
    image: example.local/app/name:0.1.0

合并命令：

bash
docker run --rm -v $(pwd):/workdir volkerraschek/dcmerge --existing-win /workdir/docker-compose-A.yaml /workdir/docker-compose-B.yaml

合并结果：

yaml
services:
  app:
    environments:
    - CLIENT_SECRET=HelloWorld123  # 保留A中的值
    image: example.local/app/name:0.1.0

3. last-win合并

特点：递归覆盖已存在的属性，最后传入的文件值优先。

示例：

本地文件：

yaml
# docker-compose-A.yaml
services:
  app:
    environments:
    - CLIENT_SECRET=HelloWorld123
    image: example.local/app/name:0.1.0

yaml
# docker-compose-B.yaml
services:
  app:
    environments:
    - CLIENT_SECRET=FooBar123  # 与A中属性冲突
    image: example.local/app/name:0.1.0

合并命令：

bash
docker run --rm -v $(pwd):/workdir volkerraschek/dcmerge --last-win /workdir/docker-compose-A.yaml /workdir/docker-compose-B.yaml

合并结果：

yaml
services:
  app:
    environments:
    - CLIENT_SECRET=FooBar123  # B中的值覆盖A中的值
    image: example.local/app/name:0.1.0