Skip to content

docs: clarify dest and tar for OCI/Docker exporters #25795

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
locker95 wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −2
Open

docs: clarify dest and tar for OCI/Docker exporters #25795

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
21 changes: 19 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 | | Path for the output. With default `tar=true`, this is the tarball file path. With `tar=false`, this is a directory. If omitted, Buildx does not write a layout file; for `type=docker` the result is often loaded into the local image store instead. |
| `tar` | `true`,`false` | `true` | When `true`, write a single tarball at `dest`. When `false`, write an unpacked image layout directory at `dest` (required when you want a directory layout). |
| `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,23 @@ The following table describes the available parameters:
[3]: #annotations
[4]: https://github.com/moby/buildkit/blob/master/docs/build-repro.md

### `dest` and `tar`

These exporters either produce a layout tarball or an unpacked layout directory:

```console
# Write an OCI layout tarball (default tar=true)
$ docker buildx build --output type=oci,dest=./image.tar .

# Write an unpacked Docker layout directory
$ docker buildx build --output type=docker,dest=./docker-layout,tar=false .
```

If you omit `dest` with `type=docker`, Buildx commonly loads the image into the
local Docker image store rather than leaving a file on disk (see also
[`--load`](/manuals/build/exporters/_index.md)). Set `dest` when you need a
portable tarball or directory layout.

## Annotations

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