zeran123/dacker

包含依赖关系的Docker镜像的构建工具

Dacker

这是一个用于构建有依赖关系的Docker镜像，例如有镜像A，B，C的构建脚本放在同一个Repo中，镜像C依赖镜像B，镜像B又依赖镜像A，那么当镜像A有变动时，会自动构建镜像B和镜像C，如果镜像B有变动，则只会重新构建镜像C。

用法

1. 在 Dockerfile 中，将依赖的镜像的名称修改为占位符。

   占位符格式 ${镜像名称:Image|Tag}，例如${ubuntu:Image}和${ubuntu:Tag}

   ...
   
   FROM ubuntu:18.04
   
   ...
   
   ---- 修改后
   
   ...
   
   FROM ${ubuntu:Image}:${ubuntu:Tag}
   
   ...
   # 构建过程中，对应的占位符会被替换为该镜像最新的名称和Tag

2. 在 repo的根目录中新建 dacker.conf 文件。

• 配置文件结构

[
	{
		"name": "镜像名称，唯一，用于依赖的引用",
		"dockerfile": "Dockerfile文件的相对路径",
		"image": "用于构建的镜像名称",
		"tag": "镜像的标签，可用占位符${BuildNumber}",
		"deps": ["依赖的镜像的名称"]
	}
]

• 配置文件样例参考

2. 执行命令

Usage: dacker [arguments] command
The arguments are:
	-push=bool	是否推送镜像，默认false
	-v=string	构建版本号

The commands are:
	build	构建镜像,需配合 -v 参数使用
	release	发布镜像
	log	查看镜像构建记录

参数说明

参数名称	类型	说明	样例
buildNumber	字符串	构建的版本号	20200525.1

测试用例

测试用例 已手动测试通过

---

想法

通过JSON配置文件定义镜像之间的依赖关系，例如：

[
	{
		"name": "openjdk-11-jre-with-sidecar",
		"dockerfile": "./example/java/openjdk-11-jre-with-sidecar/dockerfile",
		"image": "example.com/sidecar-java",
		"tag": "openjdk-11-jre-${BuildNumber}",
		"deps": ["sidecar", "openjdk-11-jre"]
	},
	{
		"name": "ubuntu",
		"dockerfile": "./example/ubuntu:18.04-zh/dockerfile",
		"image": "example.com/ubuntu",
		"tag": "18.04-zh-${BuildNumber}"
	},
	{
		"name": "sidecar",
		"dockerfile": "./example/sidecar/dockerfile",
		"image": "example.com/sidecar",
		"tag": "u1804-${BuildNumber}",
		"deps": ["ubuntu"]
	},
	{
		"name": "openjdk-11-jre",
		"dockerfile": "./example/java/openjdk-11-jre/dockerfile",
		"image": "example.com/openjdk-11-jre",
		"tag": "${BuildNumber}",
		"deps": ["ubuntu"]
	}
]

当Repo有变更时，对以上每个镜像的构建目录进行如下步骤：

1. 计算构建目录中的各个文件的哈希值，并与之前保存的哈希值进行比较，判断文件是否有变化，如果没有变化，则跳过。
2. 如果文件有变化，则重新构建当前镜像
3. 构建成功后，保存当前镜像构建脚本的新的哈希值，并记录当前镜像的TAG（包含BuildNumber）
4. 检查是否有镜像依赖当前镜像，如果有，则开始构建被依赖的镜像（需替换被依赖镜像的Dockerfile中的镜像TAG）。

用于存储构建过程及结果的JSON数据结构，例如：

[
	{
		"name": "ubuntu",
		"hash": [{"文件名": "Hash值"}],
		"buildNumber": "20200519.1",
		"image": "ubuntu",
		"tag": "18.04-zh-20200519.1",
		"deps": [{"依赖的镜像名称": "镜像Tag"}]
	},
	{
		"name": "sidecar",
		"hash": [{"文件名": "Hash值"}],
		"buildNumber": "20200519.1",
		"image": "sidecar",
		"tag": "u1804-20200520.1",
		"deps": [{"依赖的镜像名称": "镜像Tag"}]
	}
]

步骤

1. 读取配置JSON数据
2. 根据镜像依赖关系，输出镜像构建顺序
3. for 镜像构建目录
4.   检查是否已构建
5.   计算构建文件的哈希值
6.   对比哈希值
7.   if 文件有变化
8.      docker build
9.      更新构建版本和tag
10.      获取被依赖的镜像
11.      for 被依赖的镜像
12.         替换目标dockerfile中的image和tag
13.         docker build
14.         更新构建版本和tag

LICENSE

dacker is licensed under the MIT license.