Amazon S3 cache

فهرست فصل‌ها دانلود آرشیوناشر

Docker Docs · نسخهٔ 747e4c7528c7 · CC BY 4.0 برای مستندات و مجوزهای همراه

{{< summary-bar feature_name="Amazon S3 cache" >}}

The s3 cache storage uploads your resulting build cache to Amazon S3 file storage service or other S3-compatible services, such as MinIO.

This cache storage backend is not supported with the default docker driver. To use this feature, create a new builder using a different driver. See Build drivers for more information.

Synopsis

console
$ docker buildx build --push -t <user>/<image> \
  --cache-to type=s3,region=<region>,bucket=<bucket>,name=<cache-image>[,parameters...] \
  --cache-from type=s3,region=<region>,bucket=<bucket>,name=<cache-image> .

The following table describes the available CSV parameters that you can pass to --cache-to and --cache-from.

NameOptionTypeDefaultDescription
regioncache-to,cache-fromStringRequired. Geographic location.
bucketcache-to,cache-fromStringRequired. Name of the S3 bucket.
namecache-to,cache-fromStringbuildkitName of the cache image.
endpoint_urlcache-to,cache-fromStringEndpoint of the S3 bucket.
prefixcache-to,cache-fromStringPrefix to prepend to all filenames.
blobs_prefixcache-to,cache-fromStringblobs/Prefix to prepend to blob filenames.
upload_parallelismcache-toInteger4Number of parallel layer uploads.
touch_refreshcache-toTime24hInterval for updating the timestamp of unchanged cache layers.
manifests_prefixcache-to,cache-fromStringmanifests/Prefix to prepend to manifest filenames.
use_path_stylecache-to,cache-fromBooleanfalseWhen true, uses bucket in the URL instead of hostname.
access_key_idcache-to,cache-fromStringSee [authentication][1].
secret_access_keycache-to,cache-fromStringSee [authentication][1].
session_tokencache-to,cache-fromStringSee [authentication][1].
modecache-tomin,maxminCache layers to export, see [cache mode][2].
ignore-errorcache-toBooleanfalseIgnore errors caused by failed cache exports.

[1]: #authentication [2]: _index.md#cache-mode

Authentication

Buildx can reuse existing AWS credentials, configured either using a credentials file or environment variables, for pushing and pulling cache to S3. Alternatively, you can use the access_key_id, secret_access_key, and session_token attributes to specify credentials directly on the CLI.

Refer to [AWS Go SDK, Specifying Credentials][3] for details about authentication using environment variables and credentials file.

[3]: https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/configure-gosdk.html#specifying-credentials

Further reading

For an introduction to caching see Docker build cache.

For more information on the s3 cache backend, see the BuildKit README.