You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
2.7 KiB
Markdown
50 lines
2.7 KiB
Markdown
# Image exporter
|
|
|
|
The `image` exporter outputs the build result into a container image format.
|
|
The `registry` exporter is identical, but it automatically pushes the result by
|
|
setting `push=true`.
|
|
|
|
## Synopsis
|
|
|
|
Build a container image using the `image` exporter:
|
|
|
|
```console
|
|
$ docker buildx build --output type=image[,parameters] .
|
|
```
|
|
|
|
The following table describes the available parameters that you can pass to
|
|
`--output` for `type=image`:
|
|
|
|
| Parameter | Value | Default | Description |
|
|
| ----------------- | ---------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `name` | String | | Specify image name(s) |
|
|
| `push` | `true`,`false` | `false` | Push after creating the image. |
|
|
| `push-by-digest` | `true`,`false` | `false` | Push image without name. |
|
|
| `registry.insecure` | `true`,`false` | `false` | Allow pushing to insecure registry. |
|
|
| `dangling-name-prefix` | `<value>` | | Name image with `prefix@<digest>`, used for anonymous images |
|
|
| `name-canonical` | `true`,`false` | | Add additional canonical name `name@<digest>` |
|
|
| `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] |
|
|
| `oci-mediatypes` | `true`,`false` | `false` | Use OCI mediatypes in exporter manifests, see [OCI Media types][2] |
|
|
| `buildinfo` | `true`,`false` | `true` | Attach inline [build info][3] |
|
|
| `buildinfo-attrs` | `true`,`false` | `false` | Attach inline [build info attributes][3] |
|
|
| `unpack` | `true`,`false` | `false` | Unpack image after creation (for use with containerd) |
|
|
| `store` | `true`,`false` | `true` | Store the result images to the worker's (e.g. containerd) image store as well as ensures that the image has all blobs in the content store. Ignored if the worker doesn't have image store (e.g. OCI worker). |
|
|
| `annotation.<key>` | String | | Attach an annotation with the respective `key` and `value` to the built image,see [annotations][4] |
|
|
|
|
[1]: index.md#cache-compression
|
|
[2]: index.md#oci-media-types
|
|
[3]: index.md#build-info
|
|
[4]: #annotations
|
|
|
|
## Annotations
|
|
|
|
<!-- FIXME: how to present this info from buildkit -->
|
|
|
|
https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
|
|
|
https://github.com/moby/buildkit/blob/master/docs/annotations.md
|
|
|
|
## Further reading
|