Image and registry exporters
Page options
Table of contents
Theimage
exporter outputs the build result into a container image format. Theregistry
exporter is identical, but it automatically pushes the result bysettingpush=true
.
Synopsis
Build a container image using theimage
andregistry
exporters:
$ docker buildx build --outputtype=image[,parameters] .$ docker buildx build --outputtype=registry[,parameters] .
The following table describes the available parameters that you can pass to--output
fortype=image
:
Parameter | Type | 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 withprefix@<digest> , used for anonymous images | |
name-canonical | true ,false | Add additional canonical namename@<digest> | |
compression | uncompressed ,gzip ,estargz ,zstd | gzip | Compression type, seecompression |
compression-level | 0..22 | Compression level, seecompression | |
force-compression | true ,false | false | Forcefully apply compression, seecompression |
rewrite-timestamp | true ,false | false | Rewrite the file timestamps to theSOURCE_DATE_EPOCH value. Seebuild reproducibility for how to specify theSOURCE_DATE_EPOCH value. |
oci-mediatypes | true ,false | false | Use OCI media types in exporter manifests, seeOCI Media types |
oci-artifact | true ,false | false | Attestations are formatted as OCI artifacts, seeOCI Media types |
unpack | true ,false | false | Unpack image after creation (for use with containerd) |
store | true ,false | true | Store the result images to the worker's (for example, containerd) image store, and ensures that the image has all blobs in the content store. Ignored if the worker doesn't have image store (when using OCI workers, for example). |
annotation.<key> | String | Attach an annotation with the respectivekey andvalue to the built image,seeannotations |
Annotations
These exporters support adding OCI annotation usingannotation
parameter,followed by the annotation name using dot notation. The following example setstheorg.opencontainers.image.title
annotation:
$ docker buildx build\ --output "type=<type>,name=<registry>/<image>,annotation.org.opencontainers.image.title=<title>" .
For more information about annotations, seeBuildKit documentation.
Further reading
For more information on theimage
orregistry
exporters, see theBuildKit README.