added tables for cache parameters

Signed-off-by: David Karlsson <david.karlsson@docker.com>
This commit is contained in:
David Karlsson
2022-09-28 14:13:13 +02:00
parent e98c252490
commit 74a822568e
5 changed files with 66 additions and 69 deletions

View File

@ -28,19 +28,21 @@ $ docker buildx build . --push -t <user>/<image> \
--cache-from type=s3,region=<region>,bucket=<bucket>,name=<cache-image>
```
Common parameters:
The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.
- `region`: geographic location
- `bucket`: name of the S3 bucket used for caching
- `name`: name of the cache image
- `access_key_id`: access key ID, see [authentication](#authentication)
- `secret_access_key`: secret access key, see [authentication](#authentication)
- `session_token`: session token, see [authentication](#authentication)
| Parameter | Option | Value | Default | Description |
| ------------------- | ---------- | ---------- | ------- | -------------------------------------------- |
| `region` | Both | String | | Geographic location. |
| `bucket` | Both | String | | Name of the S3 bucket used for caching |
| `name` | Both | String | | Name of the cache image |
| `access_key_id` | Both | String | | See [authentication][1] |
| `secret_access_key` | Both | String | | See [authentication][1] |
| `session_token` | Both | String | | See [authentication][1] |
| `mode` | `cache-to` | `min\|max` | `min` | Cache layers to export, see [cache mode][2]. |
Parameters for `--cache-to`:
- `mode`: specify cache layers to export (default: `min`), see
[cache mode](./index.md#cache-mode)
[1]: #authentication
[2]: index.md#cache-mode
## Authentication