Skip to content

Commit

Permalink
Merge pull request #20782 from dvdksn/buildkit-016-s3-cache-opts
Browse files Browse the repository at this point in the history 
build(s3-cache): new/updated cache opt descriptions
  • Loading branch information
@dvdksn
dvdksn authored Sep 10, 2024
2 parents 12bd4ff + e37be22 commit 8f60bd2
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions content/manuals/build/cache/backends/s3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,22 @@ $ docker buildx build --push -t <user>/<image> \
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. |
| `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 | | 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. |

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

0 comments on commit 8f60bd2

Please sign in to comment.