缓存存储后端

目录

为了确保快速构建，BuildKit 会自动将其构建结果缓存到其内部缓存中。此外，BuildKit 还支持将构建缓存导出到外部位置，以便在未来的构建中导入。

在 CI/CD 构建环境中，外部缓存几乎是必不可少的。这类环境在运行之间通常几乎没有持久性，但仍必须尽可能缩短镜像构建的运行时。

默认的 docker 驱动程序支持 inline、local、registry 和 gha 缓存后端，但前提是您已启用 containerd 镜像存储。其他缓存后端要求您选择不同的 驱动程序。

警告

如果您在构建过程中使用机密或凭据，请务必使用专用的 --secret 选项对其进行操作。手动使用 COPY 或 ARG 管理机密可能会导致凭据泄露。

后端

Buildx 支持以下缓存存储后端

  • inline：将构建缓存嵌入到镜像中。

    内联缓存会被推送到与主输出结果相同的位置。这仅适用于 image 导出器。

  • registry：将构建缓存嵌入到单独的镜像中，并推送到与主输出分离的专用位置。

  • local：将构建缓存写入文件系统上的本地目录。

  • gha：将构建缓存上传到 GitHub Actions 缓存（beta 版）。

  • s3：将构建缓存上传到 AWS S3 存储桶（未发布）。

  • azblob：将构建缓存上传到 Azure Blob 存储（未发布）。

命令语法

要使用任何缓存后端，您首先需要在构建时使用 --cache-to 选项指定它，以便将缓存导出到您选择的存储后端。然后，使用 --cache-from 选项将缓存从存储后端导入到当前构建中。与本地 BuildKit 缓存（始终启用）不同，所有缓存存储后端都必须显式导出到和显式导入自。

使用 registry 后端，利用导入和导出缓存的 buildx 命令示例

$ docker buildx build --push -t <registry>/<image> \
  --cache-to type=registry,ref=<registry>/<cache-image>[,parameters...] \
  --cache-from type=registry,ref=<registry>/<cache-image>[,parameters...] .
警告

通常，每个缓存都会写入某个位置。没有任何位置可以写入两次而不会覆盖之前缓存的数据。如果您希望维护多个范围缓存（例如，每个 Git 分支一个缓存），请确保对导出的缓存使用不同的位置。

多重缓存

BuildKit 支持多个缓存导出器，允许您将缓存推送到多个目的地。您还可以从任意数量的远程缓存导入。例如，一个常见模式是使用当前分支和主分支的缓存。以下示例展示了使用注册表缓存后端从多个位置导入缓存

$ docker buildx build --push -t <registry>/<image> \
  --cache-to type=registry,ref=<registry>/<cache-image>:<branch> \
  --cache-from type=registry,ref=<registry>/<cache-image>:<branch> \
  --cache-from type=registry,ref=<registry>/<cache-image>:main .

配置选项

本节介绍生成缓存导出时可用的一些配置选项。此处描述的选项对于至少两种或更多后端类型是通用的。此外，不同的后端类型也支持特定的参数。有关哪些配置参数适用的更多信息，请参阅每种后端类型的详细页面。

此处描述的通用参数是

缓存模式

生成缓存输出时，--cache-to 参数接受一个 mode 选项，用于定义要包含在导出缓存中的层。所有缓存后端都支持此功能，但 inline 缓存除外。

模式可以设置为两个选项之一：mode=min 或 mode=max。例如，要使用注册表后端以 mode=max 构建缓存

$ docker buildx build --push -t <registry>/<image> \
  --cache-to type=registry,ref=<registry>/<cache-image>,mode=max \
  --cache-from type=registry,ref=<registry>/<cache-image> .

此选项仅在导出缓存时设置，使用 --cache-to。导入缓存时（--cache-from），相关参数会自动检测。

在 min 缓存模式（默认）下，只有导出到结果镜像的层才会被缓存，而在 max 缓存模式下，所有层都会被缓存，即使是中间步骤的层。

虽然 min 缓存通常更小（这会加快导入/导出时间，并降低存储成本），但 max 缓存更有可能获得更多的缓存命中。根据构建的复杂性和位置，您应该尝试使用这两个参数，以找到最适合您的结果。

缓存压缩

缓存压缩选项与 导出器压缩选项 相同。local 和 registry 缓存后端支持此功能。

例如，要使用 zstd 压缩来压缩 registry 缓存

$ docker buildx build --push -t <registry>/<image> \
  --cache-to type=registry,ref=<registry>/<cache-image>,compression=zstd \
  --cache-from type=registry,ref=<registry>/<cache-image> .

OCI 媒体类型

缓存 OCI 选项与 导出器 OCI 选项 相同。local 和 registry 缓存后端支持这些功能。

例如，要导出 OCI 媒体类型缓存，请使用 oci-mediatypes 属性

$ docker buildx build --push -t <registry>/<image> \
  --cache-to type=registry,ref=<registry>/<cache-image>,oci-mediatypes=true \
  --cache-from type=registry,ref=<registry>/<cache-image> .

此属性仅对 --cache-to 标志有意义。当获取缓存时，BuildKit 将自动检测要使用的正确媒体类型。

默认情况下，OCI 媒体类型为缓存镜像生成一个镜像索引。某些 OCI 注册表，例如 Amazon ECR，不支持镜像索引媒体类型：application/vnd.oci.image.index.v1+json。如果您将缓存镜像导出到 ECR 或任何其他不支持镜像索引的注册表，请将 image-manifest 参数设置为 true，以便为缓存镜像生成单个镜像清单而不是镜像索引。

$ docker buildx build --push -t <registry>/<image> \
  --cache-to type=registry,ref=<registry>/<cache-image>,oci-mediatypes=true,image-manifest=true \
  --cache-from type=registry,ref=<registry>/<cache-image> .
注意

自 BuildKit v0.21 起，image-manifest 默认启用。

© . This site is unofficial and not affiliated with Kubernetes or Docker Inc.