docker/buildx
1
0
Fork 0
mirror of https://github.com/docker/buildx.git synced 2024-11-22 15:37:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1419 from jedevc/docs-clarify-support

Browse Source 
docs: clarify support for various sets of shared options
This commit is contained in:
Justin Chadwell 2022-11-23 10:25:14 +00:00 committed by GitHub
commit 60e2029e70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/manuals/cache/backends/index.md vendored
View File

@ -101,7 +101,8 @@ The common parameters described here are:
### Cache mode ### Cache mode
When generating a cache output, the `--cache-to` argument accepts a `mode` When generating a cache output, the `--cache-to` argument accepts a `mode`
option for defining which layers to include in the exported cache. option for defining which layers to include in the exported cache. This is
supported by all cache backends except for the `inline` cache.
Mode can be set to either of two options: `mode=min` or `mode=max`. For example, Mode can be set to either of two options: `mode=min` or `mode=max`. For example,
to build the cache with `mode=max` with the registry backend: to build the cache with `mode=max` with the registry backend:
@ -128,7 +129,8 @@ with both parameters to find the results that work best for you.
### Cache compression ### Cache compression
The cache compression options are the same as the The cache compression options are the same as the
[exporter compression options](../../exporters/index.md#compression). [exporter compression options](../../exporters/index.md#compression). This is
supported by the `local` and `registry` cache backends.
For example, to compress the `registry` cache with `zstd` compression: For example, to compress the `registry` cache with `zstd` compression:
@ -141,7 +143,8 @@ $ docker buildx build --push -t <registry>/<image> \
### OCI media types ### OCI media types
The cache OCI options are the same as the The cache OCI options are the same as the
[exporter OCI options](../../exporters/index.md#oci-media-types). [exporter OCI options](../../exporters/index.md#oci-media-types). These are
supported by the `local` and `registry` cache backends.
For example, to export OCI media type cache, use the `oci-mediatypes` property: For example, to export OCI media type cache, use the `oci-mediatypes` property:

2
docs/manuals/cache/backends/inline.md vendored
View File

@ -16,6 +16,8 @@ $ docker buildx build --push -t <registry>/<image> \
--cache-from type=registry,ref=<registry>/image . --cache-from type=registry,ref=<registry>/image .
``` ```
No additional parameters are supported for the `inline` cache.
To export cache using `inline` storage, pass `type=inline` to the `--cache-to` To export cache using `inline` storage, pass `type=inline` to the `--cache-to`
option: option:

7
docs/manuals/exporters/index.md
View File

@ -245,8 +245,8 @@ the previous compression algorithm.
### OCI media types ### OCI media types
Exporters that output container images, support creating images with either Exporters that output container images, support creating images with either
Docker media types or with OCI media types. By default, BuildKit exports images Docker media types (the default) or with OCI media types. This is supported by
using Docker media type. the `image`, `registry`, `oci` and `docker` exporters.
To export images with OCI media types set, use the `oci-mediatypes` property. To export images with OCI media types set, use the `oci-mediatypes` property.
For example, with the `image` exporter: For example, with the `image` exporter:
@ -260,7 +260,8 @@ $ docker buildx build \
Exporters that output container images, allow embedding information about the Exporters that output container images, allow embedding information about the
build, including information on the original build request and sources used build, including information on the original build request and sources used
during the build. during the build. This is supported by the `image`, `registry`, `oci` and
`docker` exporters.
This build info is attached to the image configuration: This build info is attached to the image configuration: