Skip to content

docs: clarify OCI and Docker exporter output modes #25698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
codewithdaniel1 wants to merge 1 commit into
base: main
Choose a base branch
from
+33 −2
Open

docs: clarify OCI and Docker exporter output modes #25698

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions content/manuals/build/exporters/oci-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ The following table describes the available parameters:
| Parameter | Type | Default | Description |
| ------------------- | -------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | String | | Specify image name(s) |
| `dest` | String | | Path |
| `tar` | `true`,`false` | `true` | Bundle the output into a tarball layout |
| `dest` | String | | Destination path for the exported image layout |
| `tar` | `true`,`false` | `true` | Bundle the output into a tar archive |
| `compression` | `uncompressed`,`gzip`,`estargz`,`zstd` | `gzip` | Compression type, see [compression][1] |
| `compression-level` | `0..22` | | Compression level, see [compression][1] |
| `force-compression` | `true`,`false` | `false` | Forcefully apply compression, see [compression][1] |
Expand All @@ -47,6 +47,37 @@ The following table describes the available parameters:
[3]: #annotations
[4]: https://github.com/moby/buildkit/blob/master/docs/build-repro.md

## Output modes

By default, these exporters write the image layout as a tar archive. The `dest`
parameter sets the path to the archive:

```console
$ docker buildx build --output type=oci,dest=./image.tar .
```

To write the image layout as an unpacked directory instead, set `tar=false`.
In this mode, `dest` sets the output directory:

```console
$ docker buildx build --output type=oci,dest=./image-layout,tar=false .
```

For the `docker` exporter, omitting `dest` loads the image to the local image
store when the builder supports loading images:

```console
$ docker buildx build \
--output type=docker,name=<registry>/<image> .
```

To save the Docker image layout to disk instead, specify `dest`:

```console
$ docker buildx build \
--output type=docker,dest=./image.tar,name=<registry>/<image> .
```

## Annotations

These exporters support adding OCI annotation using `annotation` parameter,
Expand Down