docker/buildx
1
0
Fork 0
mirror of https://gitea.com/Lydanne/buildx.git synced 2025-07-05 11:07:42 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: fix guides for docs.docker.com

Browse Source 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax 2022-05-02 13:10:41 +02:00
parent 92009ed03c
commit cf298ee01c
No known key found for this signature in database
GPG Key ID: 3248E46B6BB8C7F7
6 changed files with 54 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/guides/cni-networking.md
View File

@ -1,4 +1,8 @@
# CNI networking ---
title: "CNI networking"
description: "Enhance your builder with CNI networking"
keywords: build, buildx, buildkit, cni, network
---
It can be useful to use a bridge network for your builder if for example you It can be useful to use a bridge network for your builder if for example you
encounter a network port contention during multiple builds. If you're using encounter a network port contention during multiple builds. If you're using
@ -11,7 +15,7 @@ Now build this image:
$ docker buildx build --tag buildkit-cni:local --load . $ docker buildx build --tag buildkit-cni:local --load .
``` ```
Then [create a `docker-container` builder](../reference/buildx_create.md) that Then [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) that
will use this image: will use this image:
```console ```console

30
docs/guides/custom-network.md
View File

@ -1,4 +1,8 @@
# Using a custom network ---
title: "Using a custom network"
description: "Create and use a custom network for your build"
keywords: build, buildx, buildkit, network
---
[Create a network](https://docs.docker.com/engine/reference/commandline/network_create/) [Create a network](https://docs.docker.com/engine/reference/commandline/network_create/)
named `foonet`: named `foonet`:
@ -7,8 +11,8 @@ named `foonet`:
$ docker network create foonet $ docker network create foonet
``` ```
[Create a `docker-container` builder](../reference/buildx_create.md) named [Create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/)
`mybuilder` that will use this network: named `mybuilder` that will use this network:
```console ```console
$ docker buildx create --use \ $ docker buildx create --use \
@ -17,7 +21,7 @@ $ docker buildx create --use \
--driver-opt "network=foonet" --driver-opt "network=foonet"
``` ```
Boot and [inspect `mybuilder`](../reference/buildx_inspect.md): Boot and [inspect `mybuilder`](https://docs.docker.com/engine/reference/commandline/buildx_inspect/):
```console ```console
$ docker buildx inspect --bootstrap $ docker buildx inspect --bootstrap
@ -26,23 +30,9 @@ $ docker buildx inspect --bootstrap
[Inspect the builder container](https://docs.docker.com/engine/reference/commandline/inspect/) [Inspect the builder container](https://docs.docker.com/engine/reference/commandline/inspect/)
and see what network is being used: and see what network is being used:
{% raw %}
```console ```console
$ docker inspect buildx_buildkit_mybuilder0 --format={{.NetworkSettings.Networks}} $ docker inspect buildx_buildkit_mybuilder0 --format={{.NetworkSettings.Networks}}
map[foonet:0xc00018c0c0] map[foonet:0xc00018c0c0]
``` ```
{% endraw %}
## What's `buildx_buildkit_mybuilder0`?
`buildx_buildkit_mybuilder0` is the container name. It can be broken down like this:
* `buildx_buildkit_` is a hardcoded prefix
* `mybuilder0` is the name of the node (defaults to builder name + position in the list of nodes)
```console
$ docker buildx ls
NAME/NODE DRIVER/ENDPOINT STATUS PLATFORMS
mybuilder * docker-container
mybuilder0 unix:///var/run/docker.sock running linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/mips64le, linux/mips64, linux/arm/v7, linux/arm/v6
default docker
default default running linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7, linux/arm/v6
```

14
docs/guides/custom-registry-config.md
View File

@ -1,6 +1,10 @@
# Using a custom registry configuration ---
title: "Using a custom registry configuration"
description: "Set registry configuration in your builder"
keywords: build, buildx, buildkit, registry
---
If you [create a `docker-container` or `kubernetes` builder](../reference/buildx_create.md) and If you [create a `docker-container` or `kubernetes` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/) and
have specified certificates for registries in the [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md), have specified certificates for registries in the [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md),
the files will be copied into the container under `/etc/buildkit/certs` and the files will be copied into the container under `/etc/buildkit/certs` and
configuration will be updated to reflect that. configuration will be updated to reflect that.
@ -8,7 +12,8 @@ configuration will be updated to reflect that.
Take the following `buildkitd.toml` configuration that will be used for Take the following `buildkitd.toml` configuration that will be used for
pushing an image to this registry using self-signed certificates: pushing an image to this registry using self-signed certificates:
```toml" ```toml
# /etc/buildkitd.toml
debug = true debug = true
[registry."myregistry.com"] [registry."myregistry.com"]
ca=["/etc/certs/myregistry.pem"] ca=["/etc/certs/myregistry.pem"]
@ -16,11 +21,10 @@ debug = true
key="/etc/certs/myregistry_key.pem" key="/etc/certs/myregistry_key.pem"
cert="/etc/certs/myregistry_cert.pem" cert="/etc/certs/myregistry_cert.pem"
``` ```
> `/etc/buildkitd.toml`
Here we have configured a self-signed certificate for `myregistry.com` registry. Here we have configured a self-signed certificate for `myregistry.com` registry.
Now [create a `docker-container` builder](../reference/buildx_create.md) Now [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/)
that will use this BuildKit configuration: that will use this BuildKit configuration:
```console ```console

12
docs/guides/opentelemetry.md
View File

@ -1,4 +1,8 @@
# OpenTelemetry support ---
title: "OpenTelemetry support"
description: "OpenTelemetry support for your builder"
keywords: build, buildx, buildkit, opentelemetry, tracing
---
To capture the trace to [Jaeger](https://github.com/jaegertracing/jaeger), set To capture the trace to [Jaeger](https://github.com/jaegertracing/jaeger), set
`JAEGER_TRACE` environment variable to the collection address using a `driver-opt`. `JAEGER_TRACE` environment variable to the collection address using a `driver-opt`.
@ -9,7 +13,7 @@ First create a Jaeger container:
$ docker run -d --name jaeger -p "6831:6831/udp" -p "16686:16686" jaegertracing/all-in-one $ docker run -d --name jaeger -p "6831:6831/udp" -p "16686:16686" jaegertracing/all-in-one
``` ```
Then [create a `docker-container` builder](../reference/buildx_create.md) Then [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/)
that will use the Jaeger instance via the `JAEGER_TRACE` env var: that will use the Jaeger instance via the `JAEGER_TRACE` env var:
```console ```console
@ -20,7 +24,7 @@ $ docker buildx create --use \
--driver-opt "env.JAEGER_TRACE=localhost:6831" --driver-opt "env.JAEGER_TRACE=localhost:6831"
``` ```
Boot and [inspect `mybuilder`](../reference/buildx_inspect.md): Boot and [inspect `mybuilder`](https://docs.docker.com/engine/reference/commandline/buildx_inspect/):
```console ```console
$ docker buildx inspect --bootstrap $ docker buildx inspect --bootstrap
@ -28,4 +32,4 @@ $ docker buildx inspect --bootstrap
Buildx commands should be traced at `http://127.0.0.1:16686/`: Buildx commands should be traced at `http://127.0.0.1:16686/`:
![](https://user-images.githubusercontent.com/1951866/124468052-ef085400-dd98-11eb-84ab-7ac8e261dd52.png) ![OpenTelemetry Buildx Bake](https://user-images.githubusercontent.com/1951866/124468052-ef085400-dd98-11eb-84ab-7ac8e261dd52.png)

20
docs/guides/registry-mirror.md
View File

@ -1,19 +1,25 @@
# Registry mirror ---
title: "Registry mirror"
description: "Using a registry mirror in your build"
keywords: build, buildx, buildkit, registry
---
You can define a registry mirror to use for your builds by providing a [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md) You can define a registry mirror to use for your builds by providing a [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md)
while creating a builder with the [`--config` flags](../reference/buildx_create.md#config). while creating a builder with the [`--config` flags](https://docs.docker.com/engine/reference/commandline/buildx_create/#config).
```toml ```toml
# /etc/buildkitd.toml
debug = true debug = true
[registry."docker.io"] [registry."docker.io"]
mirrors = ["mirror.gcr.io"] mirrors = ["mirror.gcr.io"]
``` ```
> `/etc/buildkitd.toml`
> :information_source: `debug = true` has been added to be able to debug requests > **Notes**
in the BuildKit daemon and see if the mirror is effectively used. >
> `debug = true` has been added to be able to debug requests
> in the BuildKit daemon and see if the mirror is effectively used.
Then [create a `docker-container` builder](../reference/buildx_create.md) Then [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/)
that will use this BuildKit configuration: that will use this BuildKit configuration:
```console ```console
@ -23,7 +29,7 @@ $ docker buildx create --use \
--config /etc/buildkitd.toml --config /etc/buildkitd.toml
``` ```
Boot and [inspect `mybuilder`](../reference/buildx_inspect.md): Boot and [inspect `mybuilder`](https://docs.docker.com/engine/reference/commandline/buildx_inspect/):
```console ```console
$ docker buildx inspect --bootstrap $ docker buildx inspect --bootstrap

12
docs/guides/resource-limiting.md
View File

@ -1,18 +1,22 @@
# Resource limiting ---
title: "Resource limiting"
description: "Max parallelism and limit on TCP connection in your build"
keywords: build, buildx, buildkit, compute, network
---
## Max parallelism ## Max parallelism
You can limit the parallelism of the BuildKit solver, which is particularly useful You can limit the parallelism of the BuildKit solver, which is particularly useful
for low-powered machines, using a [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md) for low-powered machines, using a [BuildKit daemon configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md)
while creating a builder with the [`--config` flags](../reference/buildx_create.md#config). while creating a builder with the [`--config` flags](https://docs.docker.com/engine/reference/commandline/buildx_create/#config).
```toml ```toml
# /etc/buildkitd.toml
[worker.oci] [worker.oci]
max-parallelism = 4 max-parallelism = 4
``` ```
> `/etc/buildkitd.toml`
Now you can [create a `docker-container` builder](../reference/buildx_create.md) Now you can [create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/)
that will use this BuildKit configuration to limit parallelism. that will use this BuildKit configuration to limit parallelism.
```console ```console