brettmc/docker-compose-generator

docker-compose generator

一个使用类mustache替换从一个或多个模板生成docker-compose文件的工具。

安装/使用

Composer包

composer require brettmc/docker-compose-generator

Docker镜像

docker run --rm -it docker.xuanyuan.run/brettmc/docker-compose-generator --help

概述

如果您需要维护多个略有不同、因环境而异的https://docs.docker.com/compose%E9%85%8D%E7%BD%AE%EF%BC%8C%E9%82%A3%E4%B9%88%E8%BF%99%E4%B8%AA%E5%B7%A5%E5%85%B7%E6%AD%A3%E6%98%AF%E6%82%A8%E6%89%80%E9%9C%80%E8%A6%81%E7%9A%84%E3%80%82

该工具已在生产环境中用于多个中型项目，通常按以下流程使用：

• git提交触发CI/CD流水线
• 流水线测试、构建并标记一些Docker镜像，准备部署
• 流水线执行shell脚本，通过测试变量确定部署环境及应包含的文件：
  • 标签 -> 生产环境
  • develop分支 -> 测试环境
  • 其他情况 -> 构建环境
• 通过合并主模板文件与一个或多个环境特定文件，以及可选的主INI文件和环境特定INI文件，最后通过-e开关添加动态值，生成docker-compose配置
• 将生成的文件传递给docker stack deploy

环境间差异

例如，开发分支的提交会构建并部署到开发swarm。每个开发部署都有自己的数据库，而测试和生产部署则没有。

多输入文件

合并多个yaml模板。例如，main.yml模板可以通过dev.yml添加额外服务进行扩展。这些模板会在后续操作前合并在一起。如果同时通过stdin和--input选项提供模板，stdin会先处理。通过--input提供的多个输入按顺序处理。

变量替换

合并所有模板后，基于INI文件、环境变量和-e标志的值对结果执行变量替换。

多种变量定义方式

接受来自INI风格环境文件或命令开关的变量，处理顺序如下：

• .ini文件（如--ini global.ini --ini local.ini）按提供顺序处理，重复键会覆盖之前的；然后
• 环境变量；最后
• 命令行变量（-e FOO=foo）

使用方法

示例文件

main.yml

yaml
version: '3.4'
networks:
  front:
  back:
services:
  my-service:
    image: "docker.xuanyuan.run/my-service:{{TAG_OR_HASH}}"
    environment:
      BAR: "{{BAR}}"

dev.yml

yaml
services:
  my-service:
    ports:
      - "80:80"
  db:
    image: "docker.xuanyuan.run/postgres"

prod.yml

yaml
services:
  my-service:
    image: "docker.xuanyuan.run/my-service:{{TAG_OR_HASH}}"

prod.ini

ini
DB_HOST=prod.db.example.com
AUTH=prod.signon.example.com

dev.ini

ini
AUTH=dev.signon.example.com

示例脚本

您可以编写自定义逻辑来确定在main.yml之后应用哪些文件，例如：

bash
#!/bin/bash
echo "为环境生成配置: ${CI_ENV} # 预定义变量，如来自CI/CD系统"
case ${CI_ENV} in
  BUILD)
    HOST=docker-build-swarm-manager.example.com
    STACK=${CI_COMMIT_HASH}
    TAG_OR_HASH=${CI_COMMIT_HASH}
    BAR=something
    ;;
  PROD)
    HOST=docker-prod-swarm-manager.example.com
    STACK=prod
    TAG_OR_HASH=${CI_COMMIT_TAG}
    BAR=something-else
    ;;
esac
bin/console.php generate -e HASH=${CI_COMMIT_HASH} -e BAR=${BAR} --ini ${CI_ENV}.ini --input main.yml --input ${CI_ENV}.yml > docker-compose.yml
docker -H ${HOST} stack deploy --prune --with-registry-auth -c docker-compose.yml ${STACK}

通过Docker运行

注意：如果通过管道输入，不要附加TTY（即不要使用docker的-t开关）

bash
$ docker run --rm -i brettmc/docker-compose-generator generate -e FOO=foo -e BAR=bar < main.yml > output.yml

或

bash
$ cat main.yml | docker run --rm -i brettmc/docker-compose-generator generate -e FOO=foo -e BAR=bar > output.yml

或使用卷挂载：

bash
$ docker run --rm -v $(pwd)/conf:/srv/conf -v $(pwd)/template:/srv/template brettmc/docker-compose-generator generate --input /srv/template/main.yml --input /srv/template/dev.yml --ini /srv/conf/dev.ini -e DB_HOST=${HOST} > output.yml