Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ fetch-remote:

- repo: "https://github.com/docker/buildx"
default_branch: "master"
ref: "v0.10"
ref: "v0.11"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already done on main

paths:
- dest: "build/bake/reference.md"
src:
Expand Down
2 changes: 2 additions & 0 deletions _data/buildx/docker_buildx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ cname:
- docker buildx bake
- docker buildx build
- docker buildx create
- docker buildx debug-shell
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum yeah I don't think we should have this command here. Let me check.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it's fine, we also display experimental cmds and flags such as --invoke:

image

Maybe we could mark this flag as experimental and display the label instead of adding this to the description.

- docker buildx du
- docker buildx imagetools
- docker buildx inspect
Expand All @@ -20,6 +21,7 @@ clink:
- docker_buildx_bake.yaml
- docker_buildx_build.yaml
- docker_buildx_create.yaml
- docker_buildx_debug-shell.yaml
- docker_buildx_du.yaml
- docker_buildx_imagetools.yaml
- docker_buildx_inspect.yaml
Expand Down
31 changes: 30 additions & 1 deletion _data/buildx/docker_buildx_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,16 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: detach
value_type: bool
default_value: "false"
description: Detach buildx server (supported only on linux) [experimental]
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: string
Expand Down Expand Up @@ -337,7 +347,7 @@ options:
swarm: false
- option: provenance
value_type: string
description: Shortand for `--attest=type=provenance`
description: Shorthand for `--attest=type=provenance`
details_url: '#provenance'
deprecated: false
hidden: false
Expand Down Expand Up @@ -387,6 +397,15 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: root
value_type: string
description: Specify root directory of server to connect [experimental]
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sbom
value_type: string
description: Shorthand for `--attest=type=sbom`
Expand Down Expand Up @@ -419,6 +438,16 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: server-config
value_type: string
description: |
Specify buildx server config file (used only when launching new server) [experimental]
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
Expand Down
1 change: 1 addition & 0 deletions _data/buildx/docker_buildx_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ examples: |-
- `requests.memory` - Sets the request memory value specified in bytes or with a valid suffix. Example `requests.memory=500Mi`, `requests.memory=4G`
- `limits.cpu` - Sets the limit CPU value specified in units of Kubernetes CPU. Example `limits.cpu=100m`, `limits.cpu=2`
- `limits.memory` - Sets the limit memory value specified in bytes or with a valid suffix. Example `limits.memory=500Mi`, `limits.memory=4G`
- `serviceaccount` - Sets the created pod's service account. Example `serviceaccount=example-sa`
- `"nodeselector=label1=value1,label2=value2"` - Sets the kv of `Pod` nodeSelector. No Defaults. Example `nodeselector=kubernetes.io/arch=arm64`
- `"tolerations=key=foo,value=bar;key=foo2,operator=exists;key=foo3,effect=NoSchedule"` - Sets the `Pod` tolerations. Accepts the same values as the kube manifest tolera>tions. Key-value pairs are separated by `,`, tolerations are separated by `;`. No Defaults. Example `tolerations=operator=exists`
- `rootless=(true|false)` - Run the container as a non-root user without `securityContext.privileged`. Needs Kubernetes 1.19 or later. [Using Ubuntu host kernel is recommended](https://github.com/moby/buildkit/blob/master/docs/rootless.md). Defaults to false.
Expand Down
63 changes: 63 additions & 0 deletions _data/buildx/docker_buildx_debug-shell.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
command: docker buildx debug-shell
short: Start a monitor
long: Start a monitor
usage: docker buildx debug-shell
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: detach
value_type: bool
default_value: "true"
description: Detach buildx server (supported only on linux) [experimental]
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
value_type: string
default_value: auto
description: |
Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: root
value_type: string
description: Specify root directory of server to connect [experimental]
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: server-config
value_type: string
description: |
Specify buildx server config file (used only when launching new server) [experimental]
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

50 changes: 37 additions & 13 deletions _data/buildx/docker_buildx_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,46 @@ examples: |-

```console
$ docker buildx inspect elated_tesla

Name: elated_tesla
Driver: docker-container
Name: elated_tesla
Driver: docker-container
Last Activity: 2022-11-30 12:42:47 +0100 CET

Nodes:
Name: elated_tesla0
Endpoint: unix:///var/run/docker.sock
Status: running
Buildkit: v0.10.3
Platforms: linux/amd64
Name: elated_tesla0
Endpoint: unix:///var/run/docker.sock
Driver Options: env.BUILDKIT_STEP_LOG_MAX_SPEED="10485760" env.JAEGER_TRACE="localhost:6831" image="moby/buildkit:latest" network="host" env.BUILDKIT_STEP_LOG_MAX_SIZE="10485760"
Status: running
Flags: --debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host
BuildKit: v0.10.6
Platforms: linux/arm64*, linux/arm/v7, linux/arm/v6
Labels:
org.mobyproject.buildkit.worker.executor: oci
org.mobyproject.buildkit.worker.hostname: docker-desktop
org.mobyproject.buildkit.worker.network: host
org.mobyproject.buildkit.worker.oci.process-mode: sandbox
org.mobyproject.buildkit.worker.selinux.enabled: false
org.mobyproject.buildkit.worker.snapshotter: overlayfs
GC Policy rule#0:
All: false
Filters: type==source.local,type==exec.cachemount,type==source.git.checkout
Keep Duration: 48h0m0s
Keep Bytes: 488.3MiB
GC Policy rule#1:
All: false
Keep Duration: 1440h0m0s
Keep Bytes: 24.21GiB
GC Policy rule#2:
All: false
Keep Bytes: 24.21GiB
GC Policy rule#3:
All: true
Keep Bytes: 24.21GiB
```

Name: elated_tesla1
Endpoint: ssh://ubuntu@1.2.3.4
Status: running
Buildkit: v0.10.3
Platforms: linux/arm64*, linux/arm/v7, linux/arm/v6
`debug` flag can also be used to get more information about the builder:

```console
$ docker --debug buildx inspect elated_tesla
```
deprecated: false
experimental: false
Expand Down
2 changes: 1 addition & 1 deletion _data/buildx/docker_buildx_ls.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ long: |-
elated_tesla0 unix:///var/run/docker.sock running v0.10.3 linux/amd64
elated_tesla1 ssh://ubuntu@1.2.3.4 running v0.10.3 linux/arm64*, linux/arm/v7, linux/arm/v6
default docker
default default running 20.10.14 linux/amd64
default default running v0.8.2 linux/amd64
```

Each builder has one or more nodes associated with it. The current builder's
Expand Down
2 changes: 2 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,8 @@ reference:
title: docker buildx build
- path: /engine/reference/commandline/buildx_create/
title: docker buildx create
- path: /engine/reference/commandline/buildx_debug-shell/
title: docker buildx debug-shell
- path: /engine/reference/commandline/buildx_du/
title: docker buildx du
- path: /engine/reference/commandline/buildx_imagetools/
Expand Down
13 changes: 13 additions & 0 deletions engine/reference/commandline/buildx_debug-shell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
datafolder: buildx
datafile: docker_buildx_debug-shell
title: docker buildx debug-shell
---
<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}