Merge pull request #15422 from docker-tools-robot/dispatch/buildx-ref-v0.9.1

Update buildx reference to v0.9.1
This commit is contained in:
CrazyMax 2022-09-07 12:03:36 +02:00 committed by GitHub
commit c21f31badf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 2341 additions and 3045 deletions

View File

@ -4,46 +4,46 @@ long: Extended build capabilities with BuildKit
pname: docker pname: docker
plink: docker.yaml plink: docker.yaml
cname: cname:
- docker buildx bake - docker buildx bake
- docker buildx build - docker buildx build
- docker buildx create - docker buildx create
- docker buildx du - docker buildx du
- docker buildx imagetools - docker buildx imagetools
- docker buildx inspect - docker buildx inspect
- docker buildx ls - docker buildx ls
- docker buildx prune - docker buildx prune
- docker buildx rm - docker buildx rm
- docker buildx stop - docker buildx stop
- docker buildx use - docker buildx use
- docker buildx version - docker buildx version
clink: clink:
- docker_buildx_bake.yaml - docker_buildx_bake.yaml
- docker_buildx_build.yaml - docker_buildx_build.yaml
- docker_buildx_create.yaml - docker_buildx_create.yaml
- docker_buildx_du.yaml - docker_buildx_du.yaml
- docker_buildx_imagetools.yaml - docker_buildx_imagetools.yaml
- docker_buildx_inspect.yaml - docker_buildx_inspect.yaml
- docker_buildx_ls.yaml - docker_buildx_ls.yaml
- docker_buildx_prune.yaml - docker_buildx_prune.yaml
- docker_buildx_rm.yaml - docker_buildx_rm.yaml
- docker_buildx_stop.yaml - docker_buildx_stop.yaml
- docker_buildx_use.yaml - docker_buildx_use.yaml
- docker_buildx_version.yaml - docker_buildx_version.yaml
options: options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
You can also use the `BUILDX_BUILDER` environment variable. You can also use the `BUILDX_BUILDER` environment variable.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,237 +1,261 @@
command: docker buildx create command: docker buildx create
short: Create a new builder instance short: Create a new builder instance
long: |- long: |-
Create makes a new builder instance pointing to a docker context or endpoint, Create makes a new builder instance pointing to a docker context or endpoint,
where context is the name of a context from `docker context ls` and endpoint is where context is the name of a context from `docker context ls` and endpoint is
the address for docker socket (eg. `DOCKER_HOST` value). the address for docker socket (eg. `DOCKER_HOST` value).
By default, the current Docker configuration is used for determining the By default, the current Docker configuration is used for determining the
context/endpoint value. context/endpoint value.
Builder instances are isolated environments where builds can be invoked. All Builder instances are isolated environments where builds can be invoked. All
Docker contexts also get the default builder instance. Docker contexts also get the default builder instance.
usage: docker buildx create [OPTIONS] [CONTEXT|ENDPOINT] usage: docker buildx create [OPTIONS] [CONTEXT|ENDPOINT]
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
options: options:
- option: append - option: append
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Append a node to builder instead of changing it description: Append a node to builder instead of changing it
details_url: '#append' details_url: '#append'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: bootstrap - option: bootstrap
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Boot builder after creation description: Boot builder after creation
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: buildkitd-flags - option: buildkitd-flags
value_type: string value_type: string
description: Flags for buildkitd daemon description: Flags for buildkitd daemon
details_url: '#buildkitd-flags' details_url: '#buildkitd-flags'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: config - option: config
value_type: string value_type: string
description: BuildKit config file description: BuildKit config file
details_url: '#config' details_url: '#config'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: driver - option: driver
value_type: string value_type: string
description: | description: |
Driver to use (available: `docker`, `docker-container`, `kubernetes`) Driver to use (available: `docker-container`, `kubernetes`, `remote`)
details_url: '#driver' details_url: '#driver'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: driver-opt - option: driver-opt
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Options for the driver description: Options for the driver
details_url: '#driver-opt' details_url: '#driver-opt'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: leave - option: leave
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Remove a node from builder instead of changing it description: Remove a node from builder instead of changing it
details_url: '#leave' details_url: '#leave'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: name - option: name
value_type: string value_type: string
description: Builder instance name description: Builder instance name
details_url: '#name' details_url: '#name'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: node - option: node
value_type: string value_type: string
description: Create/modify node with given name description: Create/modify node with given name
details_url: '#node' details_url: '#node'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: platform - option: platform
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Fixed platforms for current node description: Fixed platforms for current node
details_url: '#platform' details_url: '#platform'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: use - option: use
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Set the current builder instance description: Set the current builder instance
details_url: '#use' details_url: '#use'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Append a new node to an existing builder (--append) {#append} ### Append a new node to an existing builder (--append) {#append}
The `--append` flag changes the action of the command to append a new node to an The `--append` flag changes the action of the command to append a new node to an
existing builder specified by `--name`. Buildx will choose an appropriate node existing builder specified by `--name`. Buildx will choose an appropriate node
for a build based on the platforms it supports. for a build based on the platforms it supports.
```console ```console
$ docker buildx create mycontext1 $ docker buildx create mycontext1
eager_beaver eager_beaver
$ docker buildx create --name eager_beaver --append mycontext2 $ docker buildx create --name eager_beaver --append mycontext2
eager_beaver eager_beaver
``` ```
### Specify options for the buildkitd daemon (--buildkitd-flags) {#buildkitd-flags} ### Specify options for the buildkitd daemon (--buildkitd-flags) {#buildkitd-flags}
``` ```
--buildkitd-flags FLAGS --buildkitd-flags FLAGS
``` ```
Adds flags when starting the buildkitd daemon. They take precedence over the Adds flags when starting the buildkitd daemon. They take precedence over the
configuration file specified by [`--config`](#config). See `buildkitd --help` configuration file specified by [`--config`](#config). See `buildkitd --help`
for the available flags. for the available flags.
``` ```
--buildkitd-flags '--debug --debugaddr 0.0.0.0:6666' --buildkitd-flags '--debug --debugaddr 0.0.0.0:6666'
``` ```
### Specify a configuration file for the buildkitd daemon (--config) {#config} ### Specify a configuration file for the buildkitd daemon (--config) {#config}
``` ```
--config FILE --config FILE
``` ```
Specifies the configuration file for the buildkitd daemon to use. The configuration Specifies the configuration file for the buildkitd daemon to use. The configuration
can be overridden by [`--buildkitd-flags`](#buildkitd-flags). can be overridden by [`--buildkitd-flags`](#buildkitd-flags).
See an [example buildkitd configuration file](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md). See an [example buildkitd configuration file](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md).
Note that if you create a `docker-container` builder and have specified If the configuration file is not specified, will look for one by default in:
certificates for registries in the `buildkitd.toml` configuration, the files * `$BUILDX_CONFIG/buildkitd.default.toml`
will be copied into the container under `/etc/buildkit/certs` and configuration * `$DOCKER_CONFIG/buildx/buildkitd.default.toml`
will be updated to reflect that. * `~/.docker/buildx/buildkitd.default.toml`
### Set the builder driver to use (--driver) {#driver} Note that if you create a `docker-container` builder and have specified
certificates for registries in the `buildkitd.toml` configuration, the files
will be copied into the container under `/etc/buildkit/certs` and configuration
will be updated to reflect that.
``` ### Set the builder driver to use (--driver) {#driver}
--driver DRIVER
```
Sets the builder driver to be used. There are two available drivers, each have ```
their own specificities. --driver DRIVER
```
#### `docker` driver Sets the builder driver to be used. There are two available drivers, each have
their own specificities.
Uses the builder that is built into the docker daemon. With this driver, #### `docker` driver
the [`--load`](buildx_build.md#load) flag is implied by default on
`buildx build`. However, building multi-platform images or exporting cache is
not currently supported.
#### `docker-container` driver Uses the builder that is built into the docker daemon. With this driver,
the [`--load`](buildx_build.md#load) flag is implied by default on
`buildx build`. However, building multi-platform images or exporting cache is
not currently supported.
Uses a BuildKit container that will be spawned via docker. With this driver, #### `docker-container` driver
both building multi-platform images and exporting cache are supported.
Unlike `docker` driver, built images will not automatically appear in Uses a BuildKit container that will be spawned via docker. With this driver,
`docker images` and [`build --load`](buildx_build.md#load) needs to be used both building multi-platform images and exporting cache are supported.
to achieve that.
#### `kubernetes` driver Unlike `docker` driver, built images will not automatically appear in
`docker images` and [`build --load`](buildx_build.md#load) needs to be used
to achieve that.
Uses a kubernetes pods. With this driver, you can spin up pods with defined #### `kubernetes` driver
BuildKit container image to build your images.
Unlike `docker` driver, built images will not automatically appear in Uses a kubernetes pods. With this driver, you can spin up pods with defined
`docker images` and [`build --load`](buildx_build.md#load) needs to be used BuildKit container image to build your images.
to achieve that.
### Set additional driver-specific options (--driver-opt) {#driver-opt} Unlike `docker` driver, built images will not automatically appear in
`docker images` and [`build --load`](buildx_build.md#load) needs to be used
to achieve that.
``` #### `remote` driver
--driver-opt OPTIONS
```
Passes additional driver-specific options. Details for each driver: Uses a remote instance of buildkitd over an arbitrary connection. With this
driver, you manually create and manage instances of buildkit yourself, and
configure buildx to point at it.
Unlike `docker` driver, built images will not automatically appear in
`docker images` and [`build --load`](buildx_build.md#load) needs to be used
to achieve that.
### Set additional driver-specific options (--driver-opt) {#driver-opt}
```
--driver-opt OPTIONS
```
Passes additional driver-specific options.
Note: When using quoted values for example for the `nodeselector` or
`tolerations` options, ensure that quotes are escaped correctly for your shell.
#### `docker` driver
No driver options.
#### `docker-container` driver
- `docker` - No driver options
- `docker-container`
- `image=IMAGE` - Sets the container image to be used for running buildkit. - `image=IMAGE` - Sets the container image to be used for running buildkit.
- `network=NETMODE` - Sets the network mode for running the buildkit container. - `network=NETMODE` - Sets the network mode for running the buildkit container.
- `cgroup-parent=CGROUP` - Sets the cgroup parent of the buildkit container if docker is using the "cgroupfs" driver. Defaults to `/docker/buildx`. - `cgroup-parent=CGROUP` - Sets the cgroup parent of the buildkit container if docker is using the "cgroupfs" driver. Defaults to `/docker/buildx`.
- `kubernetes`
#### `kubernetes` driver
- `image=IMAGE` - Sets the container image to be used for running buildkit. - `image=IMAGE` - Sets the container image to be used for running buildkit.
- `namespace=NS` - Sets the Kubernetes namespace. Defaults to the current namespace. - `namespace=NS` - Sets the Kubernetes namespace. Defaults to the current namespace.
- `replicas=N` - Sets the number of `Pod` replicas. Defaults to 1. - `replicas=N` - Sets the number of `Pod` replicas. Defaults to 1.
@ -239,62 +263,70 @@ examples: |-
- `requests.memory` - Sets the request memory value specified in bytes or with a valid suffix. Example `requests.memory=500Mi`, `requests.memory=4G` - `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.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` - `limits.memory` - Sets the limit memory value specified in bytes or with a valid suffix. Example `limits.memory=500Mi`, `limits.memory=4G`
- `nodeselector="label1=value1,label2=value2"` - Sets the kv of `Pod` nodeSelector. No Defaults. Example `nodeselector=kubernetes.io/arch=arm64` - `"nodeselector=label1=value1,label2=value2"` - Sets the kv of `Pod` nodeSelector. No Defaults. Example `nodeselector=kubernetes.io/arch=arm64`
- `rootless=(true|false)` - Run the container as a non-root user without `securityContext.privileged`. [Using Ubuntu host kernel is recommended](https://github.com/moby/buildkit/blob/master/docs/rootless.md). Defaults to false. - `"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.
- `loadbalance=(sticky|random)` - Load-balancing strategy. If set to "sticky", the pod is chosen using the hash of the context path. Defaults to "sticky" - `loadbalance=(sticky|random)` - Load-balancing strategy. If set to "sticky", the pod is chosen using the hash of the context path. Defaults to "sticky"
- `qemu.install=(true|false)` - Install QEMU emulation for multi platforms support. - `qemu.install=(true|false)` - Install QEMU emulation for multi platforms support.
- `qemu.image=IMAGE` - Sets the QEMU emulation image. Defaults to `tonistiigi/binfmt:latest` - `qemu.image=IMAGE` - Sets the QEMU emulation image. Defaults to `tonistiigi/binfmt:latest`
### Remove a node from a builder (--leave) {#leave} #### `remote` driver
The `--leave` flag changes the action of the command to remove a node from a - `key=KEY` - Sets the TLS client key.
builder. The builder needs to be specified with `--name` and node that is removed - `cert=CERT` - Sets the TLS client certificate to present to buildkitd.
is set with `--node`. - `cacert=CACERT` - Sets the TLS certificate authority used for validation.
- `servername=SERVER` - Sets the TLS server name to be used in requests (defaults to the endpoint hostname).
```console ### Remove a node from a builder (--leave) {#leave}
$ docker buildx create --name mybuilder --node mybuilder0 --leave
```
### Specify the name of the builder (--name) {#name} The `--leave` flag changes the action of the command to remove a node from a
builder. The builder needs to be specified with `--name` and node that is removed
is set with `--node`.
``` ```console
--name NAME $ docker buildx create --name mybuilder --node mybuilder0 --leave
``` ```
The `--name` flag specifies the name of the builder to be created or modified. ### Specify the name of the builder (--name) {#name}
If none is specified, one will be automatically generated.
### Specify the name of the node (--node) {#node} ```
--name NAME
```
``` The `--name` flag specifies the name of the builder to be created or modified.
--node NODE If none is specified, one will be automatically generated.
```
The `--node` flag specifies the name of the node to be created or modified. If ### Specify the name of the node (--node) {#node}
none is specified, it is the name of the builder it belongs to, with an index
number suffix.
### Set the platforms supported by the node (--platform) {#platform} ```
--node NODE
```
``` The `--node` flag specifies the name of the node to be created or modified. If
--platform PLATFORMS none is specified, it is the name of the builder it belongs to, with an index
``` number suffix.
The `--platform` flag sets the platforms supported by the node. It expects a ### Set the platforms supported by the node (--platform) {#platform}
comma-separated list of platforms of the form OS/architecture/variant. The node
will also automatically detect the platforms it supports, but manual values take
priority over the detected ones and can be used when multiple nodes support
building for the same platform.
```console ```
$ docker buildx create --platform linux/amd64 --platform PLATFORMS
$ docker buildx create --platform linux/arm64,linux/arm/v8 ```
```
### Automatically switch to the newly created builder (--use) {#use} The `--platform` flag sets the platforms supported by the node. It expects a
comma-separated list of platforms of the form OS/architecture/variant. The node
will also automatically detect the platforms it supports, but manual values take
priority over the detected ones and can be used when multiple nodes support
building for the same platform.
The `--use` flag automatically switches the current builder to the newly created ```console
one. Equivalent to running `docker buildx use $(docker buildx create ...)`. $ docker buildx create --platform linux/amd64
$ docker buildx create --platform linux/arm64,linux/arm/v8
```
### Automatically switch to the newly created builder (--use) {#use}
The `--use` flag automatically switches the current builder to the newly created
one. Equivalent to running `docker buildx use $(docker buildx create ...)`.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -5,40 +5,40 @@ usage: docker buildx du
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
options: options:
- option: filter - option: filter
value_type: filter value_type: filter
description: Provide filter values description: Provide filter values
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: verbose - option: verbose
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Provide a more verbose output description: Provide a more verbose output
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,31 +1,31 @@
command: docker buildx imagetools command: docker buildx imagetools
short: Commands to work on images in registry short: Commands to work on images in registry
long: |- long: |-
Imagetools contains commands for working with manifest lists in the registry. Imagetools contains commands for working with manifest lists in the registry.
These commands are useful for inspecting multi-platform build results. These commands are useful for inspecting multi-platform build results.
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
cname: cname:
- docker buildx imagetools create - docker buildx imagetools create
- docker buildx imagetools inspect - docker buildx imagetools inspect
clink: clink:
- docker_buildx_imagetools_create.yaml - docker_buildx_imagetools_create.yaml
- docker_buildx_imagetools_inspect.yaml - docker_buildx_imagetools_inspect.yaml
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,118 +1,129 @@
command: docker buildx imagetools create command: docker buildx imagetools create
short: Create a new image based on source images short: Create a new image based on source images
long: |- long: |-
Create a new manifest list based on source manifests. The source manifests can Create a new manifest list based on source manifests. The source manifests can
be manifest lists or single platform distribution manifests and must already be manifest lists or single platform distribution manifests and must already
exist in the registry where the new manifest is created. If only one source is exist in the registry where the new manifest is created. If only one source is
specified, create performs a carbon copy. specified, create performs a carbon copy.
usage: docker buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...] usage: docker buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]
pname: docker buildx imagetools pname: docker buildx imagetools
plink: docker_buildx_imagetools.yaml plink: docker_buildx_imagetools.yaml
options: options:
- option: append - option: append
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Append to existing manifest description: Append to existing manifest
details_url: '#append' details_url: '#append'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: dry-run - option: dry-run
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Show final image instead of pushing description: Show final image instead of pushing
details_url: '#dry-run' details_url: '#dry-run'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: file - option: file
shorthand: f shorthand: f
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Read source descriptor from file description: Read source descriptor from file
details_url: '#file' details_url: '#file'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: tag - option: progress
shorthand: t value_type: string
value_type: stringArray default_value: auto
default_value: '[]' description: |
description: Set reference for new image Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output
details_url: '#tag' deprecated: false
deprecated: false hidden: false
hidden: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: tag
shorthand: t
value_type: stringArray
default_value: '[]'
description: Set reference for new image
details_url: '#tag'
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Append new sources to an existing manifest list (--append) {#append} ### Append new sources to an existing manifest list (--append) {#append}
Use the `--append` flag to append the new sources to an existing manifest list Use the `--append` flag to append the new sources to an existing manifest list
in the destination. in the destination.
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
### Show final image instead of pushing (--dry-run) {#dry-run} ### Show final image instead of pushing (--dry-run) {#dry-run}
Use the `--dry-run` flag to not push the image, just show it. Use the `--dry-run` flag to not push the image, just show it.
### Read source descriptor from a file (-f, --file) {#file} ### Read source descriptor from a file (-f, --file) {#file}
``` ```
-f FILE or --file FILE -f FILE or --file FILE
``` ```
Reads source from files. A source can be a manifest digest, manifest reference, Reads source from files. A source can be a manifest digest, manifest reference,
or a JSON of OCI descriptor object. or a JSON of OCI descriptor object.
In order to define annotations or additional platform properties like `os.version` and In order to define annotations or additional platform properties like `os.version` and
`os.features` you need to add them in the OCI descriptor object encoded in JSON. `os.features` you need to add them in the OCI descriptor object encoded in JSON.
```console ```console
$ docker buildx imagetools inspect --raw alpine | jq '.manifests[0] | .platform."os.version"="10.1"' > descr.json $ docker buildx imagetools inspect --raw alpine | jq '.manifests[0] | .platform."os.version"="10.1"' > descr.json
$ docker buildx imagetools create -f descr.json myuser/image $ docker buildx imagetools create -f descr.json myuser/image
``` ```
The descriptor in the file is merged with existing descriptor in the registry if it exists. The descriptor in the file is merged with existing descriptor in the registry if it exists.
The supported fields for the descriptor are defined in [OCI spec](https://github.com/opencontainers/image-spec/blob/master/descriptor.md#properties) . The supported fields for the descriptor are defined in [OCI spec](https://github.com/opencontainers/image-spec/blob/master/descriptor.md#properties) .
### Set reference for new image (-t, --tag) {#tag} ### Set reference for new image (-t, --tag) {#tag}
``` ```
-t IMAGE or --tag IMAGE -t IMAGE or --tag IMAGE
``` ```
Use the `-t` or `--tag` flag to set the name of the image to be created. Use the `-t` or `--tag` flag to set the name of the image to be created.
```console ```console
$ docker buildx imagetools create --dry-run alpine@sha256:5c40b3c27b9f13c873fefb2139765c56ce97fd50230f1f2d5c91e55dec171907 sha256:c4ba6347b0e4258ce6a6de2401619316f982b7bcc529f73d2a410d0097730204 $ docker buildx imagetools create --dry-run alpine@sha256:5c40b3c27b9f13c873fefb2139765c56ce97fd50230f1f2d5c91e55dec171907 sha256:c4ba6347b0e4258ce6a6de2401619316f982b7bcc529f73d2a410d0097730204
$ docker buildx imagetools create -t tonistiigi/myapp -f image1 -f image2 $ docker buildx imagetools create -t tonistiigi/myapp -f image1 -f image2
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

File diff suppressed because it is too large Load Diff

View File

@ -5,66 +5,72 @@ usage: docker buildx inspect [NAME]
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
options: options:
- option: bootstrap - option: bootstrap
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Ensure builder has booted before inspecting description: Ensure builder has booted before inspecting
details_url: '#bootstrap' details_url: '#bootstrap'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Ensure that the builder is running before inspecting (--bootstrap) {#bootstrap} ### Ensure that the builder is running before inspecting (--bootstrap) {#bootstrap}
Use the `--bootstrap` option to ensure that the builder is running before Use the `--bootstrap` option to ensure that the builder is running before
inspecting it. If the driver is `docker-container`, then `--bootstrap` starts inspecting it. If the driver is `docker-container`, then `--bootstrap` starts
the buildkit container and waits until it is operational. Bootstrapping is the buildkit container and waits until it is operational. Bootstrapping is
automatically done during build, and therefore not necessary. The same BuildKit automatically done during build, and therefore not necessary. The same BuildKit
container is used during the lifetime of the associated builder node (as container is used during the lifetime of the associated builder node (as
displayed in `buildx ls`). displayed in `buildx ls`).
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
### Get information about a builder instance ### Get information about a builder instance
By default, `inspect` shows information about the current builder. Specify the By default, `inspect` shows information about the current builder. Specify the
name of the builder to inspect to get information about that builder. name of the builder to inspect to get information about that builder.
The following example shows information about a builder instance named The following example shows information about a builder instance named
`elated_tesla`: `elated_tesla`:
```console > **Note**
$ docker buildx inspect elated_tesla >
> Asterisk `*` next to node build platform(s) indicate they had been set manually during `buildx create`. Otherwise, it had been autodetected.
Name: elated_tesla ```console
Driver: docker-container $ docker buildx inspect elated_tesla
Nodes: Name: elated_tesla
Name: elated_tesla0 Driver: docker-container
Endpoint: unix:///var/run/docker.sock
Status: running
Platforms: linux/amd64
Name: elated_tesla1 Nodes:
Endpoint: ssh://ubuntu@1.2.3.4 Name: elated_tesla0
Status: running Endpoint: unix:///var/run/docker.sock
Platforms: linux/arm64, linux/arm/v7, linux/arm/v6 Status: running
``` Buildkit: v0.10.3
Platforms: linux/amd64
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
```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -5,15 +5,15 @@ usage: docker buildx install
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,35 +1,34 @@
command: docker buildx ls command: docker buildx ls
short: List builder instances short: List builder instances
long: |- long: |-
Lists all builder instances and the nodes for each instance Lists all builder instances and the nodes for each instance
```console ```console
$ docker buildx ls $ docker buildx ls
NAME/NODE DRIVER/ENDPOINT STATUS BUILDKIT PLATFORMS
elated_tesla * docker-container
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
```
NAME/NODE DRIVER/ENDPOINT STATUS PLATFORMS Each builder has one or more nodes associated with it. The current builder's
elated_tesla * docker-container name is marked with a `*` in `NAME/NODE` and explicit node to build against for
elated_tesla0 unix:///var/run/docker.sock running linux/amd64 the target platform marked with a `*` in the `PLATFORMS` column.
elated_tesla1 ssh://ubuntu@1.2.3.4 running linux/arm64*, linux/arm/v7, linux/arm/v6
default docker
default default running linux/amd64
```
Each builder has one or more nodes associated with it. The current builder's
name is marked with a `*` in `NAME/NODE` and explicit node to build against for
the target platform marked with a `*` in the `PLATFORMS` column.
usage: docker buildx ls usage: docker buildx ls
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,76 +1,93 @@
command: docker buildx prune command: docker buildx prune
short: Remove build cache short: Remove build cache
long: Remove build cache long: |-
Clears the build cache of the selected builder.
You can finely control what cache data is kept using:
- The `--filter=until=<duration>` flag to keep images that have been used in
the last `<duration>` time.
`<duration>` is a duration string, e.g. `24h` or `2h30m`, with allowable
units of `(h)ours`, `(m)inutes` and `(s)econds`.
- The `--keep-storage=<size>` flag to keep `<size>` bytes of data in the cache.
`<size>` is a human-readable memory string, e.g. `128mb`, `2gb`, etc. Units
are case-insensitive.
- The `--all` flag to allow clearing internal helper images and frontend images
set using the `#syntax=` directive or the `BUILDKIT_SYNTAX` build argument.
usage: docker buildx prune usage: docker buildx prune
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
options: options:
- option: all - option: all
shorthand: a shorthand: a
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Remove all unused images, not just dangling ones description: Include internal/frontend images
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: filter - option: filter
value_type: filter value_type: filter
description: Provide filter values (e.g., `until=24h`) description: Provide filter values (e.g., `until=24h`)
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: force - option: force
shorthand: f shorthand: f
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not prompt for confirmation description: Do not prompt for confirmation
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: keep-storage - option: keep-storage
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Amount of disk space to keep for cache description: Amount of disk space to keep for cache
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: verbose - option: verbose
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Provide a more verbose output description: Provide a more verbose output
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,99 +1,99 @@
command: docker buildx rm command: docker buildx rm
short: Remove a builder instance short: Remove a builder instance
long: |- long: |-
Removes the specified or current builder. It is a no-op attempting to remove the Removes the specified or current builder. It is a no-op attempting to remove the
default builder. default builder.
usage: docker buildx rm [NAME] usage: docker buildx rm [NAME]
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
options: options:
- option: all-inactive - option: all-inactive
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Remove all inactive builders description: Remove all inactive builders
details_url: '#all-inactive' details_url: '#all-inactive'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: force - option: force
shorthand: f shorthand: f
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not prompt for confirmation description: Do not prompt for confirmation
details_url: '#force' details_url: '#force'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: keep-daemon - option: keep-daemon
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Keep the buildkitd daemon running description: Keep the buildkitd daemon running
details_url: '#keep-daemon' details_url: '#keep-daemon'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: keep-state - option: keep-state
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Keep BuildKit state description: Keep BuildKit state
details_url: '#keep-state' details_url: '#keep-state'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Remove all inactive builders (--all-inactive) {#all-inactive} ### Remove all inactive builders (--all-inactive) {#all-inactive}
Remove builders that are not in running state. Remove builders that are not in running state.
```console ```console
$ docker buildx rm --all-inactive $ docker buildx rm --all-inactive
WARNING! This will remove all builders that are not in running state. Are you sure you want to continue? [y/N] y WARNING! This will remove all builders that are not in running state. Are you sure you want to continue? [y/N] y
``` ```
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
### Do not prompt for confirmation (--force) {#force} ### Do not prompt for confirmation (--force) {#force}
Do not prompt for confirmation before removing inactive builders. Do not prompt for confirmation before removing inactive builders.
```console ```console
$ docker buildx rm --all-inactive --force $ docker buildx rm --all-inactive --force
``` ```
### Keep the buildkitd daemon running (--keep-daemon) {#keep-daemon} ### Keep the buildkitd daemon running (--keep-daemon) {#keep-daemon}
Keep the buildkitd daemon running after the buildx context is removed. This is useful when you manage buildkitd daemons and buildx contexts independently. Keep the buildkitd daemon running after the buildx context is removed. This is useful when you manage buildkitd daemons and buildx contexts independently.
Currently, only supported by the [`docker-container` and `kubernetes` drivers](buildx_create.md#driver). Currently, only supported by the [`docker-container` and `kubernetes` drivers](buildx_create.md#driver).
### Keep BuildKit state (--keep-state) {#keep-state} ### Keep BuildKit state (--keep-state) {#keep-state}
Keep BuildKit state, so it can be reused by a new builder with the same name. Keep BuildKit state, so it can be reused by a new builder with the same name.
Currently, only supported by the [`docker-container` driver](buildx_create.md#driver). Currently, only supported by the [`docker-container` driver](buildx_create.md#driver).
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,26 +1,26 @@
command: docker buildx stop command: docker buildx stop
short: Stop builder instance short: Stop builder instance
long: |- long: |-
Stops the specified or current builder. This will not prevent buildx build to Stops the specified or current builder. This will not prevent buildx build to
restart the builder. The implementation of stop depends on the driver. restart the builder. The implementation of stop depends on the driver.
usage: docker buildx stop [NAME] usage: docker buildx stop [NAME]
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -5,15 +5,15 @@ usage: docker buildx uninstall
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,48 +1,48 @@
command: docker buildx use command: docker buildx use
short: Set the current builder instance short: Set the current builder instance
long: |- long: |-
Switches the current builder instance. Build commands invoked after this command Switches the current builder instance. Build commands invoked after this command
will run on a specified builder. Alternatively, a context name can be used to will run on a specified builder. Alternatively, a context name can be used to
switch to the default builder of that context. switch to the default builder of that context.
usage: docker buildx use [OPTIONS] NAME usage: docker buildx use [OPTIONS] NAME
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
options: options:
- option: default - option: default
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Set builder as default for current context description: Set builder as default for current context
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: global - option: global
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Builder persists context changes description: Builder persists context changes
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
details_url: '#builder' details_url: '#builder'
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
### Override the configured builder instance (--builder) {#builder} ### Override the configured builder instance (--builder) {#builder}
Same as [`buildx --builder`](buildx.md#builder). Same as [`buildx --builder`](buildx.md#builder).
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

View File

@ -1,25 +1,25 @@
command: docker buildx version command: docker buildx version
short: Show buildx version information short: Show buildx version information
long: |- long: |-
View version information View version information
```console ```console
$ docker buildx version $ docker buildx version
github.com/docker/buildx v0.5.1-docker 11057da37336192bfc57d81e02359ba7ba848e4a github.com/docker/buildx v0.5.1-docker 11057da37336192bfc57d81e02359ba7ba848e4a
``` ```
usage: docker buildx version usage: docker buildx version
pname: docker buildx pname: docker buildx
plink: docker_buildx.yaml plink: docker_buildx.yaml
inherited_options: inherited_options:
- option: builder - option: builder
value_type: string value_type: string
description: Override the configured builder instance description: Override the configured builder instance
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false