From af0fad132be8cbf8a50246d35aa373b993bc0c79 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 27 Jul 2022 18:58:24 +0200 Subject: [PATCH] build: add bake section Signed-off-by: CrazyMax --- _config.yml | 8 ++++++++ _data/toc.yaml | 16 +++++++++++++++- build/bake/build-contexts.md | 7 +++++++ build/bake/compose-file.md | 7 +++++++ build/bake/configuring-build.md | 7 +++++++ build/bake/file-definition.md | 7 +++++++ build/bake/hcl-funcs.md | 7 +++++++ build/bake/index.md | 7 +++++++ build/buildx/index.md | 24 +++--------------------- build/index.md | 3 +-- compose/compose-file/build.md | 2 +- 11 files changed, 70 insertions(+), 25 deletions(-) create mode 100644 build/bake/build-contexts.md create mode 100644 build/bake/compose-file.md create mode 100644 build/bake/configuring-build.md create mode 100644 build/bake/file-definition.md create mode 100644 build/bake/hcl-funcs.md create mode 100644 build/bake/index.md diff --git a/_config.yml b/_config.yml index b645ace379..5239a2e033 100644 --- a/_config.yml +++ b/_config.yml @@ -163,6 +163,14 @@ fetch-remote: - "!docs/README.md" # readme to make things nice in the compose-cli repo, but meaningless here - "!docs/architecture.md" # Compose-CLI architecture, unrelated to cloud integration + - repo: "https://github.com/docker/buildx" + default_branch: "master" + ref: "master" + paths: + - dest: "build/bake" + src: + - "docs/guides/bake/**" + - repo: "https://github.com/distribution/distribution" default_branch: "main" ref: "release/2.7" diff --git a/_data/toc.yaml b/_data/toc.yaml index 84b31399a4..ff94d0879f 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1401,7 +1401,21 @@ manuals: - path: /build/buildx/multiple-builders/ title: Using multiple builders - path: /build/buildx/multiplatform-images/ - title: Building multi-platform images + title: Building multi-platform images + - sectiontitle: Bake + section: + - path: /build/bake/ + title: Bake overview + - path: /build/bake/file-definition/ + title: File definition + - path: /build/bake/configuring-build/ + title: Configuring builds + - path: /build/bake/hcl-funcs/ + title: User defined HCL functions + - path: /build/bake/build-contexts/ + title: Build contexts and linking targets + - path: /build/bake/compose-file/ + title: Building from Compose file - sectiontitle: Docker Compose section: - path: /compose/ diff --git a/build/bake/build-contexts.md b/build/bake/build-contexts.md new file mode 100644 index 0000000000..7026e6f005 --- /dev/null +++ b/build/bake/build-contexts.md @@ -0,0 +1,7 @@ +--- +title: "Defining additional build contexts and linking targets" +keywords: build, buildx, bake, buildkit, hcl +fetch_remote: + line_start: 2 + line_end: -1 +--- diff --git a/build/bake/compose-file.md b/build/bake/compose-file.md new file mode 100644 index 0000000000..d38ef185bd --- /dev/null +++ b/build/bake/compose-file.md @@ -0,0 +1,7 @@ +--- +title: "Building from Compose file" +keywords: build, buildx, bake, buildkit, compose +fetch_remote: + line_start: 2 + line_end: -1 +--- diff --git a/build/bake/configuring-build.md b/build/bake/configuring-build.md new file mode 100644 index 0000000000..f56cc62bba --- /dev/null +++ b/build/bake/configuring-build.md @@ -0,0 +1,7 @@ +--- +title: "Configuring builds" +keywords: build, buildx, bake, buildkit, hcl, json +fetch_remote: + line_start: 2 + line_end: -1 +--- diff --git a/build/bake/file-definition.md b/build/bake/file-definition.md new file mode 100644 index 0000000000..02fdb5c8b6 --- /dev/null +++ b/build/bake/file-definition.md @@ -0,0 +1,7 @@ +--- +title: "Bake file definition" +keywords: build, buildx, bake, buildkit, hcl, json, compose +fetch_remote: + line_start: 2 + line_end: -1 +--- diff --git a/build/bake/hcl-funcs.md b/build/bake/hcl-funcs.md new file mode 100644 index 0000000000..c4dde8f340 --- /dev/null +++ b/build/bake/hcl-funcs.md @@ -0,0 +1,7 @@ +--- +title: "User defined HCL functions" +keywords: build, buildx, bake, buildkit, hcl +fetch_remote: + line_start: 2 + line_end: -1 +--- diff --git a/build/bake/index.md b/build/bake/index.md new file mode 100644 index 0000000000..9f61a12efc --- /dev/null +++ b/build/bake/index.md @@ -0,0 +1,7 @@ +--- +title: "High-level build options with Bake" +keywords: build, buildx, bake, buildkit, hcl, json, compose +fetch_remote: + line_start: 2 + line_end: -1 +--- diff --git a/build/buildx/index.md b/build/buildx/index.md index e21f0e12e3..775b92a26a 100644 --- a/build/buildx/index.md +++ b/build/buildx/index.md @@ -48,25 +48,7 @@ other drivers, the method for outputting an image needs to be selected with `--output`. -## High-level build options +## High-level build options with Bake -Buildx also aims to provide support for high-level build concepts that go beyond -invoking a single build command. - -BuildKit efficiently handles multiple concurrent build requests and de-duplicating -work. The build commands can be combined with general-purpose command runners -(for example, `make`). However, these tools generally invoke builds in sequence -and therefore cannot leverage the full potential of BuildKit parallelization, -or combine BuildKit’s output for the user. For this use case, we have added a -command called [`docker buildx bake`](../../engine/reference/commandline/buildx_bake.md). - -The `bake` command supports building images from compose files, similar to -[`docker-compose build`](../../engine/reference/commandline/compose_build.md), -but allowing all the services to be built concurrently as part of a single -request. - -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. Let us know your -feedback by creating an issue in the [Docker Buildx](https://github.com/docker/buildx/issues){:target="_blank" rel="noopener" class="_"} -GitHub repository. +Check out our guide about [Bake](../bake/index.md) to get started with the +[`docker buildx bake` command](../../engine/reference/commandline/buildx_bake.md). diff --git a/build/index.md b/build/index.md index 40fa7fd6cd..529cd1e406 100644 --- a/build/index.md +++ b/build/index.md @@ -64,8 +64,7 @@ Automate your image builds to run in GitHub actions using the official docker bu * **Orchestrating builds across complex projects together** Connect your builds together and easily parameterize your images using buildx bake. - -See [High-level build options](buildx/index.md/#high-level-build-options) +See [High-level build options with Bake](bake/index.md). ### Customizing your Builds diff --git a/compose/compose-file/build.md b/compose/compose-file/build.md index b57bc76d48..9432f0d3d5 100644 --- a/compose/compose-file/build.md +++ b/compose/compose-file/build.md @@ -302,4 +302,4 @@ build: ## Implementations * [docker-compose](https://docs.docker.com/compose) -* [buildX bake](https://docs.docker.com/buildx/working-with-buildx/) +* [buildx bake](../../build/bake/index.md)