publicWagsHome
/
buildx
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

review comments, align style with driver docs

Browse Source 
Signed-off-by: David Karlsson <david.karlsson@docker.com>
pull/1332/head
David Karlsson 2 years ago
parent 74a822568e
commit 4d6e36df99
6 changed files with 48 additions and 49 deletions
Show Stats Download Patch File Download Diff File

12
docs/guides/cache/azblob.md vendored
Unescape Escape View File

@ -30,12 +30,12 @@ $ docker buildx build . --push -t <registry>/<image> \
The following table describes the available CSV parameters that you can pass to The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`. `--cache-to` and `--cache-from`.
| Parameter | Option | Value | Default | Description | | Name | Option | Type | Default | Description |
| ------------------- | ---------- | ---------- | ------- | -------------------------------------------------- | | ------------------- | ----------------------- | ----------- | ------- | -------------------------------------------------- |
| `name` | Both | String | | Required. The name of the cache image. | | `name` | `cache-to`,`cache-from` | String | | Required. The name of the cache image. |
| `account_url` | Both | String | | Base URL of the storage account. | | `account_url` | `cache-to`,`cache-from` | String | | Base URL of the storage account. |
| `secret_access_key` | Both | String | | Blob storage account key, see [authentication][1]. | | `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]. | | `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
[1]: #authentication [1]: #authentication
[2]: index.md#cache-mode [2]: index.md#cache-mode

12
docs/guides/cache/gha.md vendored
Unescape Escape View File

@ -34,12 +34,12 @@ $ docker buildx build . --push -t <registry>/<image> \
The following table describes the available CSV parameters that you can pass to The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`. `--cache-to` and `--cache-from`.
| Parameter | Option | Value | Default | Description | | Name | Option | Type | Default | Description |
| --------- | ---------- | ---------- | ------------------------------- | -------------------------------------------- | | ------- | ----------------------- | ----------- | ------------------------------- | -------------------------------------------- |
| `url` | Both | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. | | `url` | `cache-to`,`cache-from` | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. |
| `token` | Both | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. | | `token` | `cache-to`,`cache-from` | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. |
| `scope` | Both | String | Name of the current Git branch. | Cache scope, see [scope][2] | | `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]. | | `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][3]. |
[1]: #authentication [1]: #authentication
[2]: #scope [2]: #scope

17
docs/guides/cache/index.md vendored
Unescape Escape View File

@ -20,24 +20,23 @@ important to keep the runtime of image builds as low as possible.
Buildx supports the following cache storage backends: 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. The inline cache gets pushed to the same location as the main output result.
Note that this only works for the `image` exporter. Note that this only works for the `image` exporter.
- [Registry cache](./registry.md) that embeds the build cache into a separate - `registry`: embeds the build cache into a separate image, and pushes to a
image, and pushes to a dedicated location separate from the main output. dedicated location separate from the main output.
- [Local directory cache](./local.md) that writes the build cache to a local - `local`: writes the build cache to a local directory on the filesystem.
directory on the filesystem.
- [GitHub Actions cache](./gha.md) that uploads the build cache to - `gha`: uploads the build cache to
[GitHub](https://docs.github.com/en/rest/actions/cache) (beta). [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). [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/) [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)
(unreleased). (unreleased).

20
docs/guides/cache/local.md vendored
Unescape Escape View File

@ -29,16 +29,16 @@ $ docker buildx build . --push -t <registry>/<image> \
The following table describes the available CSV parameters that you can pass to The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`. `--cache-to` and `--cache-from`.
| Parameter | Option | Value | Default | Description | | Name | Option | Type | Default | Description |
| ------------------- | ------------ | --------------------- | ------- | -------------------------------------------------------------------- | | ------------------- | ------------ | ----------------------- | ------- | -------------------------------------------------------------------- |
| `src` | `cache-from` | String | | Path of the local directory where cache gets imported from. | | `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]. | | `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. | | `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]. | | `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]. | | `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` | `cache-to` | `gzip`,`estargz`,`zstd` | `gzip` | Compression type, see [cache compression][3]. |
| `compression-level` | `cache-to` | `0..22` | | Compression level, 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. | | `force-compression` | `cache-to` | `true`,`false` | `false` | Forcibly apply compression, see [cache compression][3]. |
[1]: index.md#cache-mode [1]: index.md#cache-mode
[2]: index.md#oci-media-types [2]: index.md#oci-media-types

18
docs/guides/cache/registry.md vendored
Unescape Escape View File

@ -37,15 +37,15 @@ $ docker buildx build . --push -t <registry>/<image> \
The following table describes the available CSV parameters that you can pass to The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`. `--cache-to` and `--cache-from`.
| Parameter | Option | Value | Default | Description | | Name | Option | Type | Default | Description |
| ------------------- | ---------- | --------------------- | ------- | -------------------------------------------------------------------- | | ------------------- | ----------------------- | ----------------------- | ------- | -------------------------------------------------------------------- |
| `ref` | Both | String | | Full name of the cache image to import. | | `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. | | `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]. | | `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]. | | `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` | `cache-to` | `gzip`,`estargz`,`zstd` | `gzip` | Compression type, see [cache compression][3]. |
| `compression-level` | `cache-to` | `0..22` | | Compression level, 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. | | `force-compression` | `cache-to` | `true`,`false` | `false` | Forcibly apply compression, see [cache compression][3]. |
[1]: index.md#cache-mode [1]: index.md#cache-mode
[2]: index.md#oci-media-types [2]: index.md#oci-media-types

18
docs/guides/cache/s3.md vendored
Unescape Escape View File

@ -31,15 +31,15 @@ $ docker buildx build . --push -t <user>/<image> \
The following table describes the available CSV parameters that you can pass to The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`. `--cache-to` and `--cache-from`.
| Parameter | Option | Value | Default | Description | | Name | Option | Type | Default | Description |
| ------------------- | ---------- | ---------- | ------- | -------------------------------------------- | | ------------------- | ----------------------- | ----------- | ------- | -------------------------------------------- |
| `region` | Both | String | | Geographic location. | | `region` | `cache-to`,`cache-from` | String | | Geographic location. |
| `bucket` | Both | String | | Name of the S3 bucket used for caching | | `bucket` | `cache-to`,`cache-from` | String | | Name of the S3 bucket used for caching |
| `name` | Both | String | | Name of the cache image | | `name` | `cache-to`,`cache-from` | String | | Name of the cache image |
| `access_key_id` | Both | String | | See [authentication][1] | | `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `secret_access_key` | Both | String | | See [authentication][1] | | `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `session_token` | Both | 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]. | | `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
[1]: #authentication [1]: #authentication
[2]: index.md#cache-mode [2]: index.md#cache-mode

Write Preview
Loading…
Cancel
Save