docker/buildx
1
0
Fork 0
mirror of https://gitea.com/Lydanne/buildx.git synced 2025-05-29 17:05:46 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

added tables for cache parameters

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/guides/cache/azblob.md vendored
View File

@ -27,20 +27,18 @@ $ docker buildx build . --push -t <registry>/<image> \
--cache-from type=azblob,name=<cache-image>[,parameters...] --cache-from type=azblob,name=<cache-image>[,parameters...]
``` ```
Common parameters: The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.
- `name`: the name of the cache image. | Parameter | Option | Value | Default | Description |
- `account_url`: the base address of the blob storage account, for example: | ------------------- | ---------- | ---------- | ------- | -------------------------------------------------- |
`https://myaccount.blob.core.windows.net`. See | `name` | Both | String | | Required. The name of the cache image. |
[authentication](#authentication). | `account_url` | Both | String | | Base URL of the storage account. |
- `secret_access_key`: specifies the | `secret_access_key` | Both | String | | Blob storage account key, see [authentication][1]. |
[Azure Blob Storage account key](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage), | `mode` | `cache-to` | `min\|max` | `min` | Cache layers to export, see [cache mode][2]. |
see [authentication](#authentication).
Parameters for `--cache-to`: [1]: #authentication
[2]: index.md#cache-mode
- `mode`: specify cache layers to export (default: `min`), see
[cache mode](./index.md#cache-mode)
## Authentication ## Authentication

21
docs/guides/cache/gha.md vendored
View File

@ -31,18 +31,19 @@ $ docker buildx build . --push -t <registry>/<image> \
--cache-from type=gha[,parameters...] --cache-from type=gha[,parameters...]
``` ```
Common parameters: The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.
- `url`: cache server URL (default `$ACTIONS_CACHE_URL`), see | Parameter | Option | Value | Default | Description |
[authentication](#authentication) | --------- | ---------- | ---------- | ------------------------------- | -------------------------------------------- |
- `token`: access token (default `$ACTIONS_RUNTIME_TOKEN`), see | `url` | Both | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. |
[authentication](#authentication) | `token` | Both | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. |
- `scope`: cache scope (defaults to the name of the current Git branch). | `scope` | Both | String | Name of the current Git branch. | Cache scope, see [scope][2] |
| `mode` | `cache-to` | `min\|max` | `min` | Cache layers to export, see [cache mode][3]. |
Parameters for `--cache-to`: [1]: #authentication
[2]: #scope
- `mode`: specify cache layers to export (default: `min`), see [3]: index.md#cache-mode
[cache mode](./index.md#cache-mode)
## Authentication ## Authentication

39
docs/guides/cache/local.md vendored
View File

@ -26,30 +26,27 @@ $ docker buildx build . --push -t <registry>/<image> \
--cache-from type=local,src=path/to/local/dir, --cache-from type=local,src=path/to/local/dir,
``` ```
Parameters for `--cache-to`: The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.
- `dest`: absolute or relative path to the local directory where you want to | Parameter | Option | Value | Default | Description |
export the cache to. | ------------------- | ------------ | --------------------- | ------- | -------------------------------------------------------------------- |
- `mode`: specify cache layers to export (default: `min`), see | `src` | `cache-from` | String | | Path of the local directory where cache gets imported from. |
[cache mode](./index.md#cache-mode) | `digest` | `cache-from` | String | | Digest of manifest to import, see [cache versioning][4]. |
- `oci-mediatypes`: whether to use OCI media types in exported manifests | `dest` | `cache-to` | String | | Path of the local directory where cache gets exported to. |
(default `true`, since BuildKit `v0.8`), see | `mode` | `cache-to` | `min\|max` | `min` | Cache layers to export, see [cache mode][1]. |
[OCI media types](./index.md#oci-media-types) | `oci-mediatypes` | `cache-to` | `true\|false` | `true` | Use OCI media types in exported manifests, see [OCI media types][2]. |
- `compression`: compression type for layers newly created and cached (default: | `compression` | `cache-to` | `gzip\|estargz\|zstd` | `gzip` | Compression type, see [cache compression][3]. |
`gzip`), see [cache compression](./index.md#cache-compression) | `compression-level` | `cache-to` | `0..22` | | Compression level, see [cache compression][3]. |
- `compression-level`: compression level for `gzip`, `estargz` (0-9) and `zstd` | `force-compression` | `cache-to` | `true\|false` | `false` | Forcibly apply compression. |
(0-22)
- `force-compression`: forcibly apply `compression` option to all layers
Parameters for `--cache-from`: [1]: index.md#cache-mode
[2]: index.md#oci-media-types
[3]: index.md#cache-compression
[4]: #cache-versioning
- `src`: absolute or relative path to the local directory where you want to If the `src` cache doesn't exist, then the cache import step will fail, but the
import cache from. build will continue.
- `digest`: specify explicit digest of the manifest list to import, see
[cache versioning](#cache-versioning)
If the `src` cache doesn't exist, then the cache import step will fail, but
the build will continue.
## Cache versioning ## Cache versioning

29
docs/guides/cache/registry.md vendored
View File

@ -34,23 +34,22 @@ $ docker buildx build . --push -t <registry>/<image> \
--cache-from type=registry,ref=<registry>/<cache-image> --cache-from type=registry,ref=<registry>/<cache-image>
``` ```
Common parameters: The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.
- `ref`: full address and name of the cache image that you want to import or | Parameter | Option | Value | Default | Description |
export. | ------------------- | ---------- | --------------------- | ------- | -------------------------------------------------------------------- |
| `ref` | Both | String | | Full name of the cache image to import. |
| `dest` | `cache-to` | String | | Path of the local directory where cache gets exported to. |
| `mode` | `cache-to` | `min\|max` | `min` | Cache layers to export, see [cache mode][1]. |
| `oci-mediatypes` | `cache-to` | `true\|false` | `true` | Use OCI media types in exported manifests, see [OCI media types][2]. |
| `compression` | `cache-to` | `gzip\|estargz\|zstd` | `gzip` | Compression type, see [cache compression][3]. |
| `compression-level` | `cache-to` | `0..22` | | Compression level, see [cache compression][3]. |
| `force-compression` | `cache-to` | `true\|false` | `false` | Forcibly apply compression. |
Parameters for `--cache-to`: [1]: index.md#cache-mode
[2]: index.md#oci-media-types
- `mode`: specify cache layers to export (default: `min`), see [3]: index.md#cache-compression
[cache mode](./index.md#cache-mode)
- `oci-mediatypes`: whether to use OCI media types in exported manifests
(default `true`, since BuildKit `v0.8`), see
[OCI media types](./index.md#oci-media-types)
- `compression`: compression type for layers newly created and cached (default:
`gzip`), see [cache compression](./index.md#cache-compression)
- `compression-level`: compression level for `gzip`, `estargz` (0-9) and `zstd`
(0-22)
- `force-compression`: forcibly apply `compression` option to all layers
You can choose any valid value for `ref`, as long as it's not the same as the You can choose any valid value for `ref`, as long as it's not the same as the
target location that you push your image to. You might choose different tags target location that you push your image to. You might choose different tags

24
docs/guides/cache/s3.md vendored
View File

@ -28,19 +28,21 @@ $ docker buildx build . --push -t <user>/<image> \
--cache-from type=s3,region=<region>,bucket=<bucket>,name=<cache-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 | Parameter | Option | Value | Default | Description |
- `bucket`: name of the S3 bucket used for caching | ------------------- | ---------- | ---------- | ------- | -------------------------------------------- |
- `name`: name of the cache image | `region` | Both | String | | Geographic location. |
- `access_key_id`: access key ID, see [authentication](#authentication) | `bucket` | Both | String | | Name of the S3 bucket used for caching |
- `secret_access_key`: secret access key, see [authentication](#authentication) | `name` | Both | String | | Name of the cache image |
- `session_token`: session token, see [authentication](#authentication) | `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`: [1]: #authentication
[2]: index.md#cache-mode
- `mode`: specify cache layers to export (default: `min`), see
[cache mode](./index.md#cache-mode)
## Authentication ## Authentication