Skip to content

Commit 8f60bd2

Browse files
authored
Merge pull request #20782 from dvdksn/buildkit-016-s3-cache-opts
build(s3-cache): new/updated cache opt descriptions
2 parents 12bd4ff + e37be22 commit 8f60bd2

File tree

1 file changed

+16
-14
lines changed
  • content/manuals/build/cache/backends

1 file changed

+16
-14
lines changed

content/manuals/build/cache/backends/s3.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,22 @@ $ docker buildx build --push -t <user>/<image> \
3030
The following table describes the available CSV parameters that you can pass to
3131
`--cache-to` and `--cache-from`.
3232

33-
| Name | Option | Type | Default | Description |
34-
| ------------------- | ----------------------- | ----------- | ------- | ---------------------------------------------------------- |
35-
| `region` | `cache-to`,`cache-from` | String | | Required. Geographic location. |
36-
| `bucket` | `cache-to`,`cache-from` | String | | Required. Name of the S3 bucket. |
37-
| `name` | `cache-to`,`cache-from` | String | | Name of the cache image. |
38-
| `endpoint_url` | `cache-to`,`cache-from` | String | | Endpoint of the S3 bucket. |
39-
| `blobs_prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend to blob filenames. |
40-
| `manifests_prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend on manifest filenames. |
41-
| `use_path_style` | `cache-to`,`cache-from` | Boolean | `false` | When `true`, uses `bucket` in the URL instead of hostname. |
42-
| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1]. |
43-
| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1]. |
44-
| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1]. |
45-
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
46-
| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. |
33+
| Name | Option | Type | Default | Description |
34+
| -------------------- | ----------------------- | ----------- | ------- | -------------------------------------------------------------- |
35+
| `region` | `cache-to`,`cache-from` | String | | Required. Geographic location. |
36+
| `bucket` | `cache-to`,`cache-from` | String | | Required. Name of the S3 bucket. |
37+
| `name` | `cache-to`,`cache-from` | String | | Name of the cache image. |
38+
| `endpoint_url` | `cache-to`,`cache-from` | String | | Endpoint of the S3 bucket. |
39+
| `blobs_prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend to blob filenames. |
40+
| `upload_parallelism` | `cache-to` | Integer | `4` | Number of parallel layer uploads. |
41+
| `touch_refresh` | `cache-to` | Time | `24h` | Interval for updating the timestamp of unchanged cache layers. |
42+
| `manifests_prefix` | `cache-to`,`cache-from` | String | | Prefix to prepend on manifest filenames. |
43+
| `use_path_style` | `cache-to`,`cache-from` | Boolean | `false` | When `true`, uses `bucket` in the URL instead of hostname. |
44+
| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1]. |
45+
| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1]. |
46+
| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1]. |
47+
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
48+
| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. |
4749

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

0 commit comments

Comments
 (0)