1
- # buildx
1
+ # Buildx
2
2
3
3
[ ![ GitHub release] ( https://img.shields.io/github/release/docker/buildx.svg?style=flat-square )] ( https://github.com/docker/buildx/releases/latest )
4
4
[ ![ PkgGoDev] ( https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white )] ( https://pkg.go.dev/github.com/docker/buildx )
9
9
Buildx is a Docker CLI plugin for extended build capabilities with
10
10
[ BuildKit] ( https://github.com/moby/buildkit ) .
11
11
12
- Key features:
12
+ > [ !TIP]
13
+ > ** Key features**
14
+ > - Familiar UI from ` docker build `
15
+ > - Full BuildKit capabilities with container driver
16
+ > - Multiple builder instance support
17
+ > - Multi-node builds for cross-platform images
18
+ > - Compose build support
19
+ > - High-level builds with [ Bake] ( https://docs.docker.com/build/bake/ )
20
+ > - In-container driver support (both Docker and Kubernetes)
13
21
14
- - Familiar UI from ` docker build `
15
- - Full BuildKit capabilities with container driver
16
- - Multiple builder instance support
17
- - Multi-node builds for cross-platform images
18
- - Compose build support
19
- - High-level build options (` bake ` )
20
- - In-container driver support (both Docker and Kubernetes)
21
-
22
- # Table of Contents
22
+ ___
23
23
24
24
- [ Installing] ( #installing )
25
25
- [ Windows and macOS] ( #windows-and-macos )
@@ -32,23 +32,9 @@ Key features:
32
32
- [ Working with builder instances] ( #working-with-builder-instances )
33
33
- [ Building multi-platform images] ( #building-multi-platform-images )
34
34
- [ Reference] ( docs/reference/buildx.md )
35
- - [ ` buildx bake ` ] ( docs/reference/buildx_bake.md )
36
- - [ ` buildx build ` ] ( docs/reference/buildx_build.md )
37
- - [ ` buildx create ` ] ( docs/reference/buildx_create.md )
38
- - [ ` buildx du ` ] ( docs/reference/buildx_du.md )
39
- - [ ` buildx imagetools ` ] ( docs/reference/buildx_imagetools.md )
40
- - [ ` buildx imagetools create ` ] ( docs/reference/buildx_imagetools_create.md )
41
- - [ ` buildx imagetools inspect ` ] ( docs/reference/buildx_imagetools_inspect.md )
42
- - [ ` buildx inspect ` ] ( docs/reference/buildx_inspect.md )
43
- - [ ` buildx ls ` ] ( docs/reference/buildx_ls.md )
44
- - [ ` buildx prune ` ] ( docs/reference/buildx_prune.md )
45
- - [ ` buildx rm ` ] ( docs/reference/buildx_rm.md )
46
- - [ ` buildx stop ` ] ( docs/reference/buildx_stop.md )
47
- - [ ` buildx use ` ] ( docs/reference/buildx_use.md )
48
- - [ ` buildx version ` ] ( docs/reference/buildx_version.md )
49
35
- [ Contributing] ( #contributing )
50
36
51
- # Installing
37
+ ## Installing
52
38
53
39
Using Buildx with Docker requires Docker engine 19.03 or newer.
54
40
@@ -57,18 +43,18 @@ Using Buildx with Docker requires Docker engine 19.03 or newer.
57
43
> and will likely cause issues, especially when using Buildx builders with more
58
44
> recent versions of BuildKit.
59
45
60
- ## Windows and macOS
46
+ ### Windows and macOS
61
47
62
48
Docker Buildx is included in [ Docker Desktop] ( https://docs.docker.com/desktop/ )
63
49
for Windows and macOS.
64
50
65
- ## Linux packages
51
+ ### Linux packages
66
52
67
53
Docker Engine package repositories contain Docker Buildx packages when installed according to the
68
54
[ Docker Engine install documentation] ( https://docs.docker.com/engine/install/ ) . Install the
69
55
` docker-buildx-plugin ` package to install the Buildx plugin.
70
56
71
- ## Manual download
57
+ ### Manual download
72
58
73
59
> [ !IMPORTANT]
74
60
> This section is for unattended installation of the Buildx component. These
@@ -107,7 +93,7 @@ On Windows:
107
93
> $ chmod +x ~ /.docker/cli-plugins/docker-buildx
108
94
> ` ` `
109
95
110
- # # Dockerfile
96
+ # ## Dockerfile
111
97
112
98
Here is how to install and use Buildx inside a Dockerfile through the
113
99
[` docker/buildx-bin` ](https://hub.docker.com/r/docker/buildx-bin) image:
@@ -119,7 +105,7 @@ COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-bui
119
105
RUN docker buildx version
120
106
```
121
107
122
- # Building
108
+ ## Building
123
109
124
110
``` console
125
111
# Buildx 0.6+
@@ -137,9 +123,9 @@ $ git clone https://github.com/docker/buildx.git && cd buildx
137
123
$ make install
138
124
```
139
125
140
- # Getting started
126
+ ## Getting started
141
127
142
- ## Building with Buildx
128
+ ### Building with Buildx
143
129
144
130
Buildx is a Docker CLI plugin that extends the ` docker build ` command with the
145
131
full support of the features provided by [ Moby BuildKit] ( https://docs.docker.com/build/buildkit/ )
@@ -184,7 +170,7 @@ and [drivers](https://docs.docker.com/build/builders/drivers/) guide.
184
170
> [ !NOTE]
185
171
> For more information, see [ Docker Build docs] ( https://docs.docker.com/build/concepts/overview/ ) .
186
172
187
- ## Working with builder instances
173
+ ### Working with builder instances
188
174
189
175
By default, Buildx will initially use the ` docker ` driver if it is supported,
190
176
providing a very similar user experience to the native ` docker build ` . Note that
@@ -222,7 +208,7 @@ target.
222
208
> [ !NOTE]
223
209
> For more information, see [ Builders docs] ( https://docs.docker.com/build/builders/ ) .
224
210
225
- ## Building multi-platform images
211
+ ### Building multi-platform images
226
212
227
213
BuildKit is designed to work well for building for multiple platforms and not
228
214
only for the architecture and operating system that the user invoking the build
@@ -303,11 +289,7 @@ cross-compilation helpers for more advanced use-cases.
303
289
> [ !NOTE]
304
290
> For more information, see [ Multi-platform builds docs] ( https://docs.docker.com/build/building/multi-platform/ ) .
305
291
306
- ## High-level build options
307
-
308
- See [ High-level builds with Bake] ( https://docs.docker.com/build/bake/ ) for more details.
309
-
310
- # Contributing
292
+ ## Contributing
311
293
312
294
Want to contribute to Buildx? Awesome! You can find information about
313
295
contributing to this project in the [ CONTRIBUTING.md] ( /.github/CONTRIBUTING.md )
0 commit comments