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.
60 lines
3.7 KiB
Markdown
60 lines
3.7 KiB
Markdown
2 years ago
|
# OCI and Docker exporters
|
||
|
|
|
||
|
|
The `oci` exporter outputs the build result into an
|
||
|
|
[OCI image layout](https://github.com/opencontainers/image-spec/blob/main/image-layout.md)
|
||
|
|
tarball. The `docker` exporter behaves the same way, except it exports a Docker
|
||
|
|
image layout instead.
|
||
|
|
|
||
|
|
The [`docker` driver](../drivers/docker.md) 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:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ docker buildx build --output type=oci[,parameters] .
|
||
|
|
```
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ 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][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` | | Use OCI media types in exporter manifests. Defaults to `true` for `type=oci`, and `false` for `type=docker`. 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] |
|
||
|
|
| `annotation.<key>` | String | | Attach an annotation with the respective `key` and `value` to the built image,see [annotations][4] |
|
||
|
|
|
||
|
2 years ago
|
[1]: index.md#compression
|
||
|
2 years ago
|
[2]: index.md#oci-media-types
|
||
|
|
[3]: index.md#build-info
|
||
|
|
[4]: #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:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ docker buildx build \
|
||
|
|
--output "type=<type>,name=<registry>/<image>,annotation.org.opencontainers.image.title=<title>" .
|
||
|
|
```
|
||
|
|
|
||
|
|
For more information about annotations, see
|
||
|
|
[BuildKit documentation](https://github.com/moby/buildkit/blob/master/docs/annotations.md).
|
||
|
|
|
||
|
|
## Further reading
|
||
|
|
|
||
|
|
For more information on the `oci` or `docker` exporters, see the
|
||
|
|
[BuildKit README](https://github.com/moby/buildkit/blob/master/README.md#docker-tarball).
|