From 99282168ca40e73b1259f10a62889b5bdd9568b5 Mon Sep 17 00:00:00 2001 From: Roberto Villarreal Date: Sat, 22 Nov 2025 00:23:53 -0700 Subject: [PATCH 1/2] Update S3 cache options The `prefix` option was missing, thus added. The `name`, `blobs_prefix`, and `manifests_prefix` options were present but lacked the current default values; these have been updated. --- content/manuals/build/cache/backends/s3.md | 33 +++++++++++----------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/content/manuals/build/cache/backends/s3.md b/content/manuals/build/cache/backends/s3.md index abfbfe80c2..99280b9a54 100644 --- a/content/manuals/build/cache/backends/s3.md +++ b/content/manuals/build/cache/backends/s3.md @@ -27,22 +27,23 @@ $ docker buildx build --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Name | Option | Type | Default | Description | -| -------------------- | ----------------------- | ----------- | ------- | -------------------------------------------------------------- | -| `region` | `cache-to`,`cache-from` | String | | Required. Geographic location. | -| `bucket` | `cache-to`,`cache-from` | String | | Required. Name of the S3 bucket. | -| `name` | `cache-to`,`cache-from` | String | | Name of the cache image. | -| `endpoint_url` | `cache-to`,`cache-from` | String | | Endpoint of the S3 bucket. | -| `blobs_prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend to blob filenames. | -| `upload_parallelism` | `cache-to` | Integer | `4` | Number of parallel layer uploads. | -| `touch_refresh` | `cache-to` | Time | `24h` | Interval for updating the timestamp of unchanged cache layers. | -| `manifests_prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend on manifest filenames. | -| `use_path_style` | `cache-to`,`cache-from` | Boolean | `false` | When `true`, uses `bucket` in the URL instead of hostname. | -| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1]. | -| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1]. | -| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1]. | -| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. | -| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | +| Name | Option | Type | Default | Description | +|----------------------| ----------------------- | ----------- |--------------|----------------------------------------------------------------| +| `region` | `cache-to`,`cache-from` | String | | Required. Geographic location. | +| `bucket` | `cache-to`,`cache-from` | String | | Required. Name of the S3 bucket. | +| `name` | `cache-to`,`cache-from` | String | `buildkit` | Name of the cache image. | +| `endpoint_url` | `cache-to`,`cache-from` | String | | Endpoint of the S3 bucket. | +| `prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend to all filenames. | +| `blobs_prefix` | `cache-to`,`cache-from` | String | `blobs/` | Prefix to prepend to blob filenames. | +| `upload_parallelism` | `cache-to` | Integer | `4` | Number of parallel layer uploads. | +| `touch_refresh` | `cache-to` | Time | `24h` | Interval for updating the timestamp of unchanged cache layers. | +| `manifests_prefix` | `cache-to`,`cache-from` | String | `manifests/` | Prefix to prepend to manifest filenames. | +| `use_path_style` | `cache-to`,`cache-from` | Boolean | `false` | When `true`, uses `bucket` in the URL instead of hostname. | +| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1]. | +| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1]. | +| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1]. | +| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. | +| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | [1]: #authentication [2]: _index.md#cache-mode From 0e18ebc32dd1baa5e0f6077964ee623a91817739 Mon Sep 17 00:00:00 2001 From: Roberto Villarreal Date: Sat, 22 Nov 2025 00:30:40 -0700 Subject: [PATCH 2/2] Update S3 authentication link for caching The existing link is for v1 (which now has a banner announcing its EOL status), though buildkit currently uses v2. --- content/manuals/build/cache/backends/s3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/manuals/build/cache/backends/s3.md b/content/manuals/build/cache/backends/s3.md index 99280b9a54..99831816ca 100644 --- a/content/manuals/build/cache/backends/s3.md +++ b/content/manuals/build/cache/backends/s3.md @@ -58,7 +58,7 @@ Alternatively, you can use the `access_key_id`, `secret_access_key`, and 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/v1/developer-guide/configuring-sdk.html#specifying-credentials +[3]: https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/configure-gosdk.html#specifying-credentials ## Further reading