How do you enable BuildKit with docker-compose?

Viewed 24716

I tried export DOCKER_BUILDKIT=1 before a docker-compose build command and I did not see the expected BuildKit output. What did I miss?

3 Answers

Support for BuildKit was just released in docker-compose 1.25.0. To enable:

export DOCKER_BUILDKIT=1 # or configure in daemon.json
export COMPOSE_DOCKER_CLI_BUILD=1

With those variables set in your shell, you can now run docker-compose build using BuildKit.

In windows you can execute in your console:

setx DOCKER_BUILDKIT 1 # or configure in daemon.json
setx COMPOSE_DOCKER_CLI_BUILD 1

after will need restart your console

You can use this command to tell docker-compose to use the Docker CLI when executing a build.

COMPOSE_DOCKER_CLI_BUILD=1 docker-compose build

You should see the same build as usual, but with this warning:

WARNING: Native build is an experimental feature and could change at any time

And you can go like that to parametrize the CLI to use BuildKit instead of the default builder:

COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose build

Windows version:

set "COMPOSE_DOCKER_CLI_BUILD=1" & set "DOCKER_BUILDKIT=1" & docker-compose build

You can also enable BuildKit globally, editing /etc/docker/daemon.json file, adding:

{ "features": { "buildkit": true } }

For more informations: https://docs.docker.com/develop/develop-images/build_enhancements/

Docker Compose v2 supports BuildKit by default: link

While most migrations should be straightforward, Compose v2 does introduce a few breaking changes which could impact specific use cases:

  • Containers are now created with hyphens in their names instead of underscores.
  • docker compose build builds with BuildKit by default.
  • Some deprecated command flags have been removed.

After reading this and this tutorial, I put together the following script to install Docker Compose v2 for Ubuntu 20.04:

sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"
sudo apt update
sudo apt install docker-compose-plugin
Related