docker/dockerfile

BuildKit Dockerfile frontend

Official Dockerfile frontend images that enable building Dockerfiles with BuildKit.

Report issues at https://github.com/moby/buildkit

Join #buildkit channel on Docker Community Slack

Tags

Latest releases

• https://github.com/moby/buildkit/blob/dockerfile/1.23.0/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

• https://github.com/moby/buildkit/blob/dockerfile/1.22.0/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

• https://github.com/moby/buildkit/blob/dockerfile/1.21.0/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

• https://github.com/moby/buildkit/blob/dockerfile/1.20.0/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

Latest labs releases

• https://github.com/moby/buildkit/blob/dockerfile/1.23.0/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

• https://github.com/moby/buildkit/blob/dockerfile/1.22.0-labs/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

Development build from master branch

• https://github.com/moby/buildkit/blob/dockerfile/master/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

• https://github.com/moby/buildkit/blob/dockerfile/master/frontend/dockerfile/cmd/dockerfile-frontend/Dockerfile

Note for Docker users

If you are using Docker v18.09 or later, BuildKit mode can be enabled by setting export DOCKER_BUILDKIT=1 on the client side.

https://github.com/docker/buildx always enables BuildKit.

Using external Dockerfile frontend

BuildKit supports loading frontends dynamically from container images. Images for Dockerfile frontends are available at https://hub.docker.com/r/docker/dockerfile/tags/ repository.

To use the external frontend, the first line of your Dockerfile needs to be # syntax=docker/dockerfile:1.3 pointing to the specific image you want to use.

BuildKit also ships with Dockerfile frontend builtin but it is recommended to use an external image to make sure that all users use the same version on the builder and to pick up bugfixes automatically without waiting for a new version of BuildKit or Docker engine.

The images are published on two channels: latest and labs. The latest channel uses semver versioning while labs uses an https://github.com/moby/buildkit/issues/528. This means the labs channel may remove a feature without incrementing the major component of a version and you may want to pin the image to a specific revision. Even when syntaxes change in between releases on labs channel, the old versions are guaranteed to be backward compatible.

Linked copies COPY --link, ADD --link

To use this flag set Dockerfile version to at least 1.4.

dockerfile
# syntax=docker/dockerfile:1.4

Enabling this flag in COPY or ADD commands allows you to copy files with enhanced semantics where your files remain independent on their own layer and don't get invalidated when commands on previous layers are changed.

When --link is used your source files are copied into an empty destination directory. That directory is turned into a layer that is linked on top of your previous state.

dockerfile
# syntax=docker/dockerfile:1.4
FROM alpine
COPY --link /foo /bar

Is equivalent of doing two builds:

dockerfile
FROM alpine

and

dockerfile
FROM scratch
COPY /foo /bar

and merging all the layers of both images together.

Benefits of using --link

Using --link allows to reuse already built layers in subsequent builds with --cache-from even if the previous layers have changed. This is especially important for multi-stage builds where a COPY --from statement would previously get invalidated if any previous commands in the same stage changed, causing the need to rebuild the intermediate stages again. With --link the layer the previous build generated is reused and merged on top of the new layers. This also means you can easily rebase your images when the base images receive updates, without having to execute the whole build again. In backends that support it, BuildKit can do this rebase action without the need to push or pull any layers between the client and the registry. BuildKit will detect this case and only create new image manifest that contains the new layers and old layers in correct order.

The same behavior where BuildKit can avoid pulling down the base image can also happen when using --link and no other commands that would require access to the files in the base image. In that case BuildKit will only build the layers for the COPY commands and push them to the registry directly on top of the layers of the base image.

Incompatibilities with --link=false

When using --link the COPY/ADD commands are not allowed to read any files from the previous state. This means that if in previous state the destination directory was a path that contained a symlink, COPY/ADD can not follow it. In the final image the destination path created with --link will always be a path containing only directories.

If you don't rely on the behavior of following symlinks in the destination path, using --link is always recommended. The performance of --link is equivalent or better than the default behavior and it creates much better conditions for cache reuse.

Build Mounts RUN --mount=...

To use this flag set Dockerfile version to at least 1.2

# syntax=docker/dockerfile:1.3

RUN --mount allows you to create mounts that process running as part of the build can access. This can be used to bind files from other part of the build without copying, accessing build secrets or ssh-agent sockets, or creating cache locations to speed up your build.

RUN --mount=type=bind (the default mount type)

This mount type allows binding directories (read-only) in the context or in an image to the build container.

RUN --mount=type=cache

This mount type allows the build container to cache directories for compilers and package managers.

Contents of the cache directories persists between builder invocations without invalidating the instruction cache. Cache mounts should only be used for better performance. Your build should work with any contents of the cache directory as another build may overwrite the files or GC may clean it if more storage space is needed.

Example: cache Go packages

dockerfile
# syntax = docker/dockerfile:1.3
FROM golang
...
RUN --mount=type=cache,target=/root/.cache/go-build go build ...

Example: cache apt packages

dockerfile
# syntax = docker/dockerfile:1.3
FROM ubuntu
RUN rm -f /etc/apt/apt.conf.d/docker-clean; echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' > /etc/apt/apt.conf.d/keep-cache
RUN --mount=type=cache,target=/var/cache/apt --mount=type=cache,target=/var/lib/apt \
  apt update && apt-get --no-install-recommends install -y gcc

RUN --mount=type=tmpfs

This mount type allows mounting tmpfs in the build container.

RUN --mount=type=secret

This mount type allows the build container to access secure files such as private keys without baking them into the image.

Example: access to S3

dockerfile
# syntax = docker/dockerfile:1.3
FROM python:3
RUN pip install awscli
RUN --mount=type=secret,id=aws,target=/root/.aws/credentials aws s3 cp s3://... ...

console
$ docker build --secret id=aws,src=$HOME/.aws/credentials .

console
$ buildctl build --frontend=dockerfile.v0 --local context=. --local dockerfile=. \
  --secret id=aws,src=$HOME/.aws/credentials

RUN --mount=type=ssh

This mount type allows the build container to access SSH keys via SSH agents, with support for passphrases.

Example: access to Gitlab

dockerfile
# syntax = docker/dockerfile:1.3
FROM alpine
RUN apk add --no-cache openssh-client
RUN mkdir -p -m 0700 ~/.ssh && ssh-keyscan gitlab.com >> ~/.ssh/known_hosts
RUN --mount=type=ssh ssh -q -T git@gitlab.com 2>&1 | tee /hello
# "Welcome to GitLab, @GITLAB_USERNAME_ASSOCIATED_WITH_SSHKEY" should be printed here
# with the type of build progress is defined as `plain`.

console
$ eval $(ssh-agent)
$ ssh-add ~/.ssh/id_rsa
(Input your passphrase here)
$ docker build --ssh default=$SSH_AUTH_SOCK .

$ buildctl build --frontend=dockerfile.v0 --local context=. --local dockerfile=. \
  --ssh default=$SSH_AUTH_SOCK

You can also specify a path to *.pem file on the host directly instead of $SSH_AUTH_SOCK. However, pem files with passphrases are not supported.

Network modes RUN --network=none|host|default

# syntax=docker/dockerfile:1.3

RUN --network allows control over which networking environment the command is run in.

The allowed values are:

• none - The command is run with no network access (lo is still available, but is isolated to this process)
• host - The command is run in the host's network environment (similar to docker build --network=host, but on a per-instruction basis)
• default - Equivalent to not supplying a flag at all, the command is run in the default network for the build

The use of --network=host is protected by the network.host entitlement, which needs to be enabled when starting the buildkitd daemon (--allow-insecure-entitlement network.host) and on the build request (--allow network.host).

Example: isolating external effects

dockerfile
# syntax = docker/dockerfile:1.3
FROM python:3.6
ADD mypackage.tgz wheels/
RUN --network=none pip install --find-links wheels mypackage

pip will only be able to install the packages provided in the tarfile, which can be controlled by an earlier build stage.

Here-Documents

This feature is available since docker/dockerfile:1.4.0 release.

# syntax=docker/dockerfile:1.4

Here-documents allow redirection of subsequent Dockerfile lines to the input of RUN or COPY commands. If such command contains a here-document Dockerfile will *** the next lines until the line only containing a here-doc delimiter as part of the same command.

Example: running a multi-line script

dockerfile
# syntax = docker/dockerfile:1.4
FROM debian
RUN <<eot bash
  apt-get update
  apt-get install -y vim
eot

If the command only contains a here-document, its contents is evaluated with the default shell.

dockerfile
# syntax = docker/dockerfile:1.4
FROM debian
RUN <<eot
  mkdir -p foo/bar
eot

Alternatively, shebang header can be used to define an interpreter.

dockerfile
# syntax = docker/dockerfile:1.4
FROM python:3.6
RUN <<eot
#!/usr/bin/env python
print("hello world")
eot

More complex examples may use multiple here-documents.

dockerfile
# syntax = docker/dockerfile:1.4
FROM alpine
RUN <<FILE1 cat > file1 && <<FILE2 cat > file2
I am
first
FILE1
I am
second
FILE2

Example: creating inline files

In COPY commands source parameters can be replaced with here-doc indicators. Regular here-doc variable expansion and tab stripping rules apply.

dockerfile
# syntax = docker/dockerfile:1.4
FROM alpine
ARG FOO=bar
COPY <<-eot /app/foo
	hello ${FOO}
eot

dockerfile
# syntax = docker/dockerfile:1.4
FROM alpine
COPY <<-"eot" /app/script.sh
	echo hello ${FOO}
eot
RUN FOO=abc ash /app/script.sh

Security context RUN --security=insecure|sandbox

To use this flag, set Dockerfile version to labs channel.

# syntax=docker/dockerfile:1.3-labs

With --security=insecure, builder runs the command without sandbox in insecure mode, which allows to run flows requiring elevated privileges (e.g. containerd). This is equivalent to running docker run --privileged. In order to access this feature, entitlement security.insecure should be enabled when starting the buildkitd daemon (--allow-insecure-entitlement security.insecure) and for a build request (--allow security.insecure).

Default sandbox mode can be activated via --security=sandbox, but that is no-op.

Example: check entitlements

dockerfile
# syntax = docker/dockerfile:1.3-labs
FROM ubuntu
RUN --security=insecure cat /proc/self/status | grep CapEff

#84 0.093 CapEff:	0000003fffffffff