diff --git a/docs/guides/cache/azblob.md b/docs/guides/cache/azblob.md index faf5334e..810e51ce 100644 --- a/docs/guides/cache/azblob.md +++ b/docs/guides/cache/azblob.md @@ -30,12 +30,12 @@ $ docker buildx build . --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Parameter | Option | Value | Default | Description | -| ------------------- | ---------- | ---------- | ------- | -------------------------------------------------- | -| `name` | Both | String | | Required. The name of the cache image. | -| `account_url` | Both | String | | Base URL of the storage account. | -| `secret_access_key` | Both | String | | Blob storage account key, see [authentication][1]. | -| `mode` | `cache-to` | `min\|max` | `min` | Cache layers to export, see [cache mode][2]. | +| Name | Option | Type | Default | Description | +| ------------------- | ----------------------- | ----------- | ------- | -------------------------------------------------- | +| `name` | `cache-to`,`cache-from` | String | | Required. The name of the cache image. | +| `account_url` | `cache-to`,`cache-from` | String | | Base URL of the storage account. | +| `secret_access_key` | `cache-to`,`cache-from` | String | | Blob storage account key, see [authentication][1]. | +| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. | [1]: #authentication [2]: index.md#cache-mode diff --git a/docs/guides/cache/gha.md b/docs/guides/cache/gha.md index ef71307e..9d0e7d5e 100644 --- a/docs/guides/cache/gha.md +++ b/docs/guides/cache/gha.md @@ -34,12 +34,12 @@ $ docker buildx build . --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Parameter | Option | Value | Default | Description | -| --------- | ---------- | ---------- | ------------------------------- | -------------------------------------------- | -| `url` | Both | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. | -| `token` | Both | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. | -| `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]. | +| Name | Option | Type | Default | Description | +| ------- | ----------------------- | ----------- | ------------------------------- | -------------------------------------------- | +| `url` | `cache-to`,`cache-from` | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. | +| `token` | `cache-to`,`cache-from` | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. | +| `scope` | `cache-to`,`cache-from` | 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]. | [1]: #authentication [2]: #scope diff --git a/docs/guides/cache/index.md b/docs/guides/cache/index.md index c290da56..884a011c 100644 --- a/docs/guides/cache/index.md +++ b/docs/guides/cache/index.md @@ -20,24 +20,23 @@ important to keep the runtime of image builds as low as possible. Buildx supports the following cache storage backends: -- [Inline cache](./inline.md) that embeds the build cache into the image. +- `inline-cache`: embeds the build cache into the image. The inline cache gets pushed to the same location as the main output result. Note that this only works for the `image` exporter. -- [Registry cache](./registry.md) that embeds the build cache into a separate - image, and pushes to a dedicated location separate from the main output. +- `registry`: embeds the build cache into a separate image, and pushes to a + dedicated location separate from the main output. -- [Local directory cache](./local.md) that writes the build cache to a local - directory on the filesystem. +- `local`: writes the build cache to a local directory on the filesystem. -- [GitHub Actions cache](./gha.md) that uploads the build cache to - [GitHub](https://docs.github.com/en/rest/actions/cache) (beta). +- `gha`: uploads the build cache to + [GitHub Actions cache](https://docs.github.com/en/rest/actions/cache) (beta). -- [Amazon S3 cache](./s3.md) that uploads the build cache to an +- `s3`: uploads the build cache to an [AWS S3 bucket](https://aws.amazon.com/s3/) (unreleased). -- [Azure Blob Storage cache](./azblob.md) that uploads the build cache to +- `azblob`: uploads the build cache to [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/) (unreleased). diff --git a/docs/guides/cache/local.md b/docs/guides/cache/local.md index c2e9d140..b53450d8 100644 --- a/docs/guides/cache/local.md +++ b/docs/guides/cache/local.md @@ -29,16 +29,16 @@ $ docker buildx build . --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Parameter | Option | Value | Default | Description | -| ------------------- | ------------ | --------------------- | ------- | -------------------------------------------------------------------- | -| `src` | `cache-from` | String | | Path of the local directory where cache gets imported from. | -| `digest` | `cache-from` | String | | Digest of manifest to import, see [cache versioning][4]. | -| `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. | +| Name | Option | Type | Default | Description | +| ------------------- | ------------ | ----------------------- | ------- | -------------------------------------------------------------------- | +| `src` | `cache-from` | String | | Path of the local directory where cache gets imported from. | +| `digest` | `cache-from` | String | | Digest of manifest to import, see [cache versioning][4]. | +| `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, see [cache compression][3]. | [1]: index.md#cache-mode [2]: index.md#oci-media-types diff --git a/docs/guides/cache/registry.md b/docs/guides/cache/registry.md index 2755ab47..aa7ab152 100644 --- a/docs/guides/cache/registry.md +++ b/docs/guides/cache/registry.md @@ -37,15 +37,15 @@ $ docker buildx build . --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Parameter | Option | Value | Default | Description | -| ------------------- | ---------- | --------------------- | ------- | -------------------------------------------------------------------- | -| `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. | +| Name | Option | Type | Default | Description | +| ------------------- | ----------------------- | ----------------------- | ------- | -------------------------------------------------------------------- | +| `ref` | `cache-to`,`cache-from` | 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, see [cache compression][3]. | [1]: index.md#cache-mode [2]: index.md#oci-media-types diff --git a/docs/guides/cache/s3.md b/docs/guides/cache/s3.md index 21e6d5b8..15c7002d 100644 --- a/docs/guides/cache/s3.md +++ b/docs/guides/cache/s3.md @@ -31,15 +31,15 @@ $ docker buildx build . --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| 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]. | +| Name | Option | Type | Default | Description | +| ------------------- | ----------------------- | ----------- | ------- | -------------------------------------------- | +| `region` | `cache-to`,`cache-from` | String | | Geographic location. | +| `bucket` | `cache-to`,`cache-from` | String | | Name of the S3 bucket used for caching | +| `name` | `cache-to`,`cache-from` | String | | Name of the cache image | +| `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]. | [1]: #authentication [2]: index.md#cache-mode