Registry cache
Docker Docs · نسخهٔ 747e4c7528c7 · CC BY 4.0 برای مستندات و مجوزهای همراه
The registry cache storage can be thought of as an extension to the inline cache. Unlike the inline cache, the registry cache is entirely separate from the image, which allows for more flexible usage - registry-backed cache can do everything that the inline cache can do, and more:
- Allows for separating the cache and resulting image artifacts so that you can
distribute your final image without the cache inside.
- It can efficiently cache multi-stage builds in
maxmode, instead of only the
final stage.
- It works with other exporters for more flexibility, instead of only the
image exporter.
This cache storage backend works with the default docker driver only when the containerd image store is enabled. If the containerd image store isn't enabled, use a different driver. See Build drivers for more information.
Synopsis
Unlike the simpler inline cache, the registry cache supports several configuration parameters:
$ docker buildx build --push -t <registry>/<image> \
--cache-to type=registry,ref=<registry>/<cache-image>[,parameters...] \
--cache-from type=registry,ref=<registry>/<cache-image> .The following table describes the available CSV parameters that you can pass to --cache-to and --cache-from.
| Name | Option | Type | Default | Description |
|---|---|---|---|---|
ref | cache-to,cache-from | String | Full name of the cache image to import. | |
mode | cache-to | min,max | min | Cache layers to export, see [cache mode][1]. |
oci-mediatypes | cache-to | true,false | true | Use OCI media types in exported manifests, see [OCI media types][2]. |
image-manifest | cache-to | true,false | true | When using OCI media types, generate an image manifest instead of an image index for the cache image, see [OCI media types][2]. |
compression | cache-to | gzip,estargz,zstd | gzip | Compression type, see [cache compression][3]. |
compression-level | cache-to | 0..22 | Compression level, see [cache compression][3]. | |
force-compression | cache-to | true,false | false | Forcibly apply compression, see [cache compression][3]. |
ignore-error | cache-to | Boolean | false | Ignore errors caused by failed cache exports. |
[1]: _index.md#cache-mode [2]: _index.md#oci-media-types [3]: _index.md#cache-compression
You can choose any valid value for ref, as long as it's not the same as the target location that you push your image to. You might choose different tags (e.g. foo/bar:latest and foo/bar:build-cache), separate image names (e.g. foo/bar and foo/bar-cache), or even different repositories (e.g. docker.io/foo/bar and ghcr.io/foo/bar). It's up to you to decide the strategy that you want to use for separating your image from your cache images.
If the --cache-from target doesn't exist, then the cache import step will fail, but the build continues.
Further reading
For an introduction to caching see Docker build cache.
For more information on the registry cache backend, see the BuildKit README.