docker/buildx
1
0
Fork 0
mirror of https://gitea.com/Lydanne/buildx.git synced 2025-05-22 19:57:44 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity
buildx/docs/guides/exporters/oci-docker.md
Justin Chadwell d32926a7e5 docs: add exporter docs 
This patch adds more complete documentation for the various exporters
available to buildx.

Co-Authored-By: David Karlsson <david.karlsson@docker.com>
Signed-off-by: Justin Chadwell <me@jedevc.com>
2022-11-01 12:16:45 +00:00

3.7 KiB
Raw Blame History

OCI and Docker exporters

The oci exporter outputs the build result into an OCI image layout tarball. The docker exporter behaves the same way, except it exports a Docker image layout instead.

The docker driver doesn't support these exporters. You must use docker-container or some other driver if you want to generate these outputs.

Synopsis

Build a container image using the oci and docker exporters:

$ docker buildx build --output type=oci[,parameters] .

$ docker buildx build --output type=docker[,parameters] .

The following table describes the available parameters:

Parameter Value Default Description
name String Specify image name(s)
dest String Path
compression uncompressed,gzip,estargz,zstd gzip Compression type, see compression
compression-level 0..22 Compression level, see compression
force-compression true,false false Forcefully apply compression, see compression
oci-mediatypes true,false Use OCI media types in exporter manifests. Defaults to true for type=oci, and false for type=docker. See OCI Media types
buildinfo true,false true Attach inline build info
buildinfo-attrs true,false false Attach inline build info attributes
annotation.<key> String Attach an annotation with the respective key and value to the built image,see annotations

Annotations

These exporters support adding OCI annotation using annotation.* dot notation parameter. The following example sets the org.opencontainers.image.title annotation for a build:

$ docker buildx build \
    --output "type=<type>,name=<registry>/<image>,annotation.org.opencontainers.image.title=<title>" .

For more information about annotations, see BuildKit documentation.

Further reading

For more information on the oci or docker exporters, see the BuildKit README.