docker-compose部署规范-目录结构与打包和升级工具

本规范根据多个项目实践，总结如下

规范部署目录结构

目录结构的规划基于下面几点考虑：

• 一个主机上可以部署多套系统
• 一个系统应该是”自洽“的，具有完整的逻辑性，系统涉及的所有文件是自包含的
• 当系统需要本地二次构建时，速度要够快（docker-compose.yml所在目录不能有太多无关文件，否则会影响docker up --build执行速度）

目录结构如下所示:

• [项目名称]-deplopy:
  • **conf
    • .env: 定义COMPOSE_PROJECT_NAME=[项目名称]-deplopy,通过变量定义项目名称
    • docker-compose.yml: 主文件
    • Dockerfile-[服务名]:一般情况下，web服务都放在docker-compose环境进行二次构建，以便于在部署环境修改nginx.conf的路由配置，安全设置，证书替换等。
      • 采用中横线命名方式:Dockerfile-[服务名],例如Dockerfile-auth表示提供鉴权的web服务
    • ningx-[服务名].conf：web服务进行二次构建时的配置文件
    • cert: SSL证书目录
  • init-data： 初始化的数据，如数据库脚本、程序加载时的初始数据等
  • run-data: 运行过程中的数据，如数据库存储目录，程序的临时文件目录
  • log: 程序日志目标
  • back: 程序备份目录
  • auto_pack.py/auto_pack.sh: 自动打包工具
  • auto_upgrade.py/auto_upgrade.sh: 自动升级工具

自动打包工具介绍

执行命令: python auto_pack.py

• step1 读取 docker-compose.yml和Dockerfile获取镜像列表
• step2 对镜像进行备份，打包到./back目录
  • 获取镜像的创建时间，镜像打包文件的格式：仓储名称标签名称创建时间(yyyymmddHHMMSS).tar.gz
  • 若打包文件已经存在，不会重复打包
  • 打包+压缩命令为"docker save IMAGE > xxx.tar && gizp xxx.tar.gz xxx.tar"
• step3 对部署目录进行打包:包含conf、init-data、*.py文件，打包后的文件为[项目名称]-deplopy.tar.gz

详见下列代码:

自动升级工具

执行命令: python auto_upgrade.py 镜像名|*.tar.gz|*.gz

• 如果是.gz文件，必须已经放到./back目录下，执行gizp -d xxx.tar.gz
• 如果是.tar文件，必须已经放到./back目录下，执行docker load < xxx.tar,并获取镜像名
• 根据镜像名，查找哪个Dockerfile(格式为Dockerfile-[服务名])包含改镜像，并解析出服务名
  • 执行 docker-compose up -d --build 服务名
• 检查docker-compose.xml中是否包含该镜像名，若存在
  • 执行 docker-compose up -d,自动

详见下列代码:

参考

• How to get exact date for docker images?如何抽取镜像时间
• Declare default environment variables in file 通过文件声明默认环境变量
• COMPOSE_PROJECT_NAME