feat: support image cache when build (#2400)

Author: jamesgetx

smart-app-builder/README.md

@@ -33,6 +33,8 @@ docker run -it --rm --privileged \
     -e SOURCE_GET_URL=file:///podman/source \
     -e DEST_PUT_URL=file:///podman/dest \
     -e BUILDER_SHIM_IMAGE=bk-builder-heroku-bionic:v1.0.2 \
+    -e CACHE_REGISTRY='mirrors.example.com/foo' \
+    -e REGISTRY_AUTH='{"mirrors.example.com": "Basic xxx"}' \
     -v $APP_PATH:/podman/source \
     -v $SMART_PATH:/podman/dest \
     smart-app-builder:pind
@@ -49,6 +51,8 @@ docker run -it --rm --privileged \
 - `DEST_PUT_URL`: S-Mart 包的生成路径。同样地，`podman` 用户需要对目录具有读写权限(如示例中的 `/podman/dest`)。
 - `BUILDER_SHIM_IMAGE`: CNB
   构建工具镜像。镜像的制作方法可以参考 [cnb-builder-shim]([blueking-paas/cnb-builder-shim/README.md at builder-stack · TencentBlueKing/blueking-paas · GitHub](https://github.com/TencentBlueKing/blueking-paas/blob/builder-stack/cnb-builder-shim/README.md))。
+- `CACHE_REGISTRY`: (可选) 用于缓存的镜像仓库。设置后, 构建过程会启用缓存功能, 否则不启用。
+- `REGISTRY_AUTH`: (可选) 镜像仓库凭证。如果镜像仓库需要鉴权, 则必须设置此参数。
 
 #### 2.2 基于 DIND 构建
 
@@ -70,6 +74,8 @@ docker run -it --rm --privileged \
     -e SOURCE_GET_URL=file:///tmp/source \
     -e DEST_PUT_URL=file:///tmp/dest \
     -e BUILDER_SHIM_IMAGE=bk-builder-heroku-bionic:v1.0.2 \
+    -e CACHE_REGISTRY='mirrors.example.com/foo' \
+    -e REGISTRY_AUTH='{"mirrors.example.com": "Basic xxx"}' \
     -v $APP_PATH:/tmp/source \
     -v $SMART_PATH:/tmp/dest \
     smart-app-builder:dind
@@ -84,6 +90,8 @@ docker run -it --rm --privileged \
 - `DEST_PUT_URL`: S-Mart 包的生成路径
 - `BUILDER_SHIM_IMAGE`: CNB
   构建工具镜像。镜像的制作方法可以参考 [cnb-builder-shim]([blueking-paas/cnb-builder-shim/README.md at builder-stack · TencentBlueKing/blueking-paas · GitHub](https://github.com/TencentBlueKing/blueking-paas/blob/builder-stack/cnb-builder-shim/README.md))。
+- `CACHE_REGISTRY`: (可选) 用于缓存的镜像仓库。设置后, 构建过程会启用缓存功能, 否则不启用。
+- `REGISTRY_AUTH`: (可选) 镜像仓库凭证。如果镜像仓库需要鉴权, 则必须设置此参数。
 
 #### 2.3 PIND vs DIND
 

smart-app-builder/pkg/builder/executor/container.go

@@ -133,7 +133,7 @@ func (c *containerExecutor) runBuilder(buildPlan *plan.BuildPlan, runImage strin
 		}
 
 		// 2. 生成运行命令参数
-		args := makeRunArgs(group, moduleSrcTGZ, runImage)
+		args := makeRunArgs(buildPlan.AppCode, group, moduleSrcTGZ, runImage)
 		c.logger.Info("build", "module name", group.BuildModuleName, "run args", args)
 
 		// 3. 运行构建命令, 并打印输出

smart-app-builder/pkg/builder/executor/utils.go

@@ -90,7 +90,7 @@ func archiveArtifactTarball(buildPlan *plan.BuildPlan, artifactDir string) (stri
 }
 
 // makeRunArgs 生成运行命令, 其中 moduleSrcTGZ 为模块源码包, runImage 为运行时镜像
-func makeRunArgs(group *plan.ModuleBuildGroup, moduleSrcTGZ string, runImage string) []string {
+func makeRunArgs(appCode string, group *plan.ModuleBuildGroup, moduleSrcTGZ string, runImage string) []string {
 	args := make([]string, 0)
 
 	envSlice := lo.MapToSlice(group.Envs, func(k string, v string) string {
@@ -118,6 +118,15 @@ func makeRunArgs(group *plan.ModuleBuildGroup, moduleSrcTGZ string, runImage str
 		args = append(args, "-e", env)
 	}
 
+	// 添加缓存配置
+	if config.G.CacheRegistry != "" {
+		cacheImage := fmt.Sprintf("%s/%s/%s:cnb-build-cache", config.G.CacheRegistry, appCode, group.BuildModuleName)
+		args = append(args, "-e", fmt.Sprintf("CACHE_IMAGE=%s", cacheImage))
+		if config.G.RegistryAuth != "" {
+			args = append(args, "-e", fmt.Sprintf("CNB_REGISTRY_AUTH=%s", config.G.RegistryAuth))
+		}
+	}
+
 	// 挂载源码压缩包
 	args = append(args, "--mount", fmt.Sprintf("type=bind,source=%s,target=%s", moduleSrcTGZ, bindTarget))
 

smart-app-builder/pkg/config/config.go

@@ -48,6 +48,11 @@ var G = struct {
 
 	// BuildpackType is the type of buildpack to use. Supported values: oci-embedded and tgz, default is oci-embedded
 	BuildpackType string
+
+	// CacheRegistry is a registry used to cache image layers. e.g., mirrors.tencent.com/bkapps
+	CacheRegistry string
+	// RegistryAuth is the cache registry auth. e.g., '{"mirrors.tencent.com": "Basic xxx"}'
+	RegistryAuth string
 }{Viper: viper.New()}
 
 // SetGlobalConfig set global config
@@ -95,4 +100,7 @@ func SetGlobalConfig() {
 
 	// set bk-buildpack-apt env
 	G.SetDefault("APT_BUILDPACK_VERSION", "v2")
+
+	G.CacheRegistry = G.GetString("CACHE_REGISTRY")
+	G.RegistryAuth = G.GetString("REGISTRY_AUTH")
 }