Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build(s3-cache): new/updated cache opt descriptions #20782

Merged
merged 2 commits into from
Sep 10, 2024
Merged

build(s3-cache): new/updated cache opt descriptions #20782

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b96f6e
build(s3-cache): upload_parallelism opt
dvdksn Sep 4, 2024
e37be22
build(s3-cache): touch_refresh opt
dvdksn Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions content/manuals/build/cache/backends/s3.md
View file
Open in desktop
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
Loading