From 9bc9291fc99f9db42e20d52c97884e965fa17790 Mon Sep 17 00:00:00 2001 From: Tonis Tiigi Date: Mon, 17 May 2021 22:33:08 -0700 Subject: [PATCH 1/2] readme: update installation instructions Signed-off-by: Tonis Tiigi --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 10256a2fdf6..5249d3caba1 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,11 @@ Key features: # Installing -Using `buildx` as a docker CLI plugin requires using Docker 19.03. A limited set of functionality works with older versions of Docker when invoking the binary directly. +Using `buildx` as a docker CLI plugin requires using Docker 19.03 or newer. A limited set of functionality works with older versions of Docker when invoking the binary directly. -### Docker CE +### Docker -`buildx` comes bundled with Docker CE starting with 19.03, but requires experimental mode to be enabled on the Docker CLI. -To enable it, `"experimental": "enabled"` can be added to the CLI configuration file `~/.docker/config.json`. An alternative is to set the `DOCKER_CLI_EXPERIMENTAL=enabled` environment variable. +`buildx` comes bundled with Docker Desktop and in latest Docker CE packages. ### Binary release @@ -63,13 +62,8 @@ chmod a+x ~/.docker/cli-plugins/docker-buildx # Building -### with Docker 18.09+ -``` -$ git clone git://github.com/docker/buildx && cd buildx -$ make install -``` -### with buildx or Docker 19.03 +### with buildx or Docker 19.03+ ``` $ export DOCKER_BUILDKIT=1 $ docker build --platform=local -o . git://github.com/docker/buildx @@ -77,6 +71,12 @@ $ mkdir -p ~/.docker/cli-plugins $ mv buildx ~/.docker/cli-plugins/docker-buildx ``` +### with Docker 18.09+ +``` +$ git clone git://github.com/docker/buildx && cd buildx +$ make install +``` + # Getting started ## Building with buildx From d7b28fb4d340528926e17a29c4a6f0e352155055 Mon Sep 17 00:00:00 2001 From: Tonis Tiigi Date: Mon, 17 May 2021 22:53:56 -0700 Subject: [PATCH 2/2] docs: update bake notes Signed-off-by: Tonis Tiigi --- README.md | 4 +++- docs/reference/buildx_bake.md | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5249d3caba1..dcbbc165184 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Key features: - Multiple builder instance support - Multi-node builds for cross-platform images - Compose build support -- WIP: High-level build constructs (`bake`) +- High-level build constructs (`bake`) - In-container driver support (both Docker and Kubernetes) # Table of Contents @@ -159,6 +159,8 @@ Currently, the bake command supports building images from compose files, similar There is also support for custom build rules from HCL/JSON files allowing better code reuse and different target groups. The design of bake is in very early stages and we are looking for feedback from users. +[`buildx bake` Reference Docs](docs/reference/buildx_bake.md) + # Setting buildx as default builder in Docker 19.03+ Running `docker buildx install` sets up `docker builder` command as an alias to `docker buildx`. This results in the ability to have `docker build` use the current buildx builder. diff --git a/docs/reference/buildx_bake.md b/docs/reference/buildx_bake.md index 55821153b70..f23fe8393c5 100644 --- a/docs/reference/buildx_bake.md +++ b/docs/reference/buildx_bake.md @@ -33,6 +33,10 @@ Build from a file Bake is a high-level build command. Each specified target will run in parallel as part of the build. +Read [High-level build options](https://github.com/docker/buildx#high-level-build-options) for introduction. + +Please note that `buildx bake` command may receive backwards incompatible features in the future if needed. We are looking for feedback on improving the command and extending the functionality further. + ## Examples ### Specify a build definition file (-f, --file)