Skip to content

docs: fix guides for docs.docker.com #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crazy-max merged 1 commit into from
May 5, 2022
Merged

docs: fix guides for docs.docker.com #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/guides/cni-networking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
encounter a network port contention during multiple builds. If you're using
Expand All @@ -11,7 +15,7 @@ Now build this image:
$ 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:

```console
Expand Down
30 changes: 10 additions & 20 deletions docs/guides/custom-network.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/)
named `foonet`:
Expand All @@ -7,8 +11,8 @@ named `foonet`:
$ docker network create foonet
```

[Create a `docker-container` builder](../reference/buildx_create.md) named
`mybuilder` that will use this network:
[Create a `docker-container` builder](https://docs.docker.com/engine/reference/commandline/buildx_create/)
named `mybuilder` that will use this network:

```console
$ docker buildx create --use \
Expand All @@ -17,7 +21,7 @@ $ docker buildx create --use \
--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
$ docker buildx inspect --bootstrap
Expand All @@ -26,23 +30,9 @@ $ docker buildx inspect --bootstrap
[Inspect the builder container](https://docs.docker.com/engine/reference/commandline/inspect/)
and see what network is being used:

{% raw %}
```console
$ docker inspect buildx_buildkit_mybuilder0 --format={{.NetworkSettings.Networks}}
map[foonet:0xc00018c0c0]
```

## 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
```
{% endraw %}
14 changes: 9 additions & 5 deletions docs/guides/custom-registry-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# 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),
the files will be copied into the container under `/etc/buildkit/certs` and
configuration will be updated to reflect that.

Take the following `buildkitd.toml` configuration that will be used for
pushing an image to this registry using self-signed certificates:

```toml"
```toml
# /etc/buildkitd.toml
debug = true
[registry."myregistry.com"]
ca=["/etc/certs/myregistry.pem"]
[[registry."myregistry.com".keypair]]
key="/etc/certs/myregistry_key.pem"
cert="/etc/certs/myregistry_cert.pem"
```
> `/etc/buildkitd.toml`

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:

```console
Expand Down
12 changes: 8 additions & 4 deletions docs/guides/opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
`JAEGER_TRACE` environment variable to the collection address using a `driver-opt`.
Expand All @@ -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
```

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:

```console
Expand All @@ -20,12 +24,12 @@ $ docker buildx create --use \
--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
$ docker buildx inspect --bootstrap
```

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 changes: 13 additions & 7 deletions docs/guides/registry-mirror.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
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
# /etc/buildkitd.toml
debug = true
[registry."docker.io"]
mirrors = ["mirror.gcr.io"]
```
> `/etc/buildkitd.toml`

> :information_source: `debug = true` has been added to be able to debug requests
in the BuildKit daemon and see if the mirror is effectively used.
> **Notes**
>
> `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:

```console
Expand All @@ -23,7 +29,7 @@ $ docker buildx create --use \
--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
$ docker buildx inspect --bootstrap
Expand Down
12 changes: 8 additions & 4 deletions docs/guides/resource-limiting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

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)
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
# /etc/buildkitd.toml
[worker.oci]
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.

```console
Expand Down