mirror of
https://gitea.com/Lydanne/buildx.git
synced 2025-10-15 00:03:45 +08:00
Merge pull request #506 from thaJeztah/split_docs
Split docs to separate files
This commit is contained in:
Tõnis Tiigi
1
.github/workflows/validate.yml
vendored
1
.github/workflows/validate.yml
vendored
@@ -23,6 +23,7 @@ jobs:
|
|||||||
target:
|
target:
|
||||||
- lint
|
- lint
|
||||||
- validate-vendor
|
- validate-vendor
|
||||||
|
- validate-docs
|
||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
|
|||||||
10
Makefile
10
Makefile
@@ -23,12 +23,18 @@ test:
|
|||||||
validate-vendor:
|
validate-vendor:
|
||||||
./hack/validate-vendor
|
./hack/validate-vendor
|
||||||
|
|
||||||
validate-all: lint test validate-vendor
|
validate-docs:
|
||||||
|
./hack/validate-docs
|
||||||
|
|
||||||
|
validate-all: lint test validate-vendor validate-docs
|
||||||
|
|
||||||
vendor:
|
vendor:
|
||||||
./hack/update-vendor
|
./hack/update-vendor
|
||||||
|
|
||||||
|
docs:
|
||||||
|
./hack/update-docs
|
||||||
|
|
||||||
generate-authors:
|
generate-authors:
|
||||||
./hack/generate-authors
|
./hack/generate-authors
|
||||||
|
|
||||||
.PHONY: vendor lint shell binaries install binaries-cross validate-all generate-authors
|
.PHONY: vendor lint shell binaries install binaries-cross validate-all generate-authors validate-docs docs
|
||||||
|
|||||||
711
README.md
711
README.md
@@ -29,16 +29,16 @@ Key features:
|
|||||||
* [Building multi-platform images](#building-multi-platform-images)
|
* [Building multi-platform images](#building-multi-platform-images)
|
||||||
* [High-level build options](#high-level-build-options)
|
* [High-level build options](#high-level-build-options)
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
+ [`buildx build [OPTIONS] PATH | URL | -`](#buildx-build-options-path--url---)
|
+ [`buildx build [OPTIONS] PATH | URL | -`](docs/reference/buildx_build.md)
|
||||||
+ [`buildx create [OPTIONS] [CONTEXT|ENDPOINT]`](#buildx-create-options-contextendpoint)
|
+ [`buildx create [OPTIONS] [CONTEXT|ENDPOINT]`](docs/reference/buildx_create.md)
|
||||||
+ [`buildx use NAME`](#buildx-use-name)
|
+ [`buildx use NAME`](docs/reference/buildx_use.md)
|
||||||
+ [`buildx inspect [NAME]`](#buildx-inspect-name)
|
+ [`buildx inspect [NAME]`](docs/reference/buildx_inspect.md)
|
||||||
+ [`buildx ls`](#buildx-ls)
|
+ [`buildx ls`](docs/reference/buildx_ls.md)
|
||||||
+ [`buildx stop [NAME]`](#buildx-stop-name)
|
+ [`buildx stop [NAME]`](docs/reference/buildx_stop.md)
|
||||||
+ [`buildx rm [NAME]`](#buildx-rm-name)
|
+ [`buildx rm [NAME]`](docs/reference/buildx_rm.md)
|
||||||
+ [`buildx bake [OPTIONS] [TARGET...]`](#buildx-bake-options-target)
|
+ [`buildx bake [OPTIONS] [TARGET...]`](docs/reference/buildx_bake.md)
|
||||||
+ [`buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]`](#buildx-imagetools-create-options-source-source)
|
+ [`buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]`](docs/reference/buildx_imagetools_create.md)
|
||||||
+ [`buildx imagetools inspect NAME`](#buildx-imagetools-inspect-name)
|
+ [`buildx imagetools inspect NAME`](docs/reference/buildx_imagetools_inspect.md)
|
||||||
- [Setting buildx as default builder in Docker 19.03+](#setting-buildx-as-default-builder-in-docker-1903)
|
- [Setting buildx as default builder in Docker 19.03+](#setting-buildx-as-default-builder-in-docker-1903)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
|
|
||||||
@@ -159,697 +159,6 @@ Currently, the bake command supports building images from compose files, similar
|
|||||||
|
|
||||||
There is also support for custom build rules from HCL/JSON files allowing better code reuse and different target groups. The design of bake is in very early stages and we are looking for feedback from users.
|
There is also support for custom build rules from HCL/JSON files allowing better code reuse and different target groups. The design of bake is in very early stages and we are looking for feedback from users.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Documentation
|
|
||||||
|
|
||||||
### `buildx build [OPTIONS] PATH | URL | -`
|
|
||||||
|
|
||||||
The `buildx build` command starts a build using BuildKit. This command is similar to the UI of `docker build` command and takes the same flags and arguments.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| --add-host [] | Add a custom host-to-IP mapping (host:ip)
|
|
||||||
| --allow [] | Allow extra privileged entitlement, e.g. network.host, security.insecure
|
|
||||||
| --build-arg [] | Set build-time variables
|
|
||||||
| --cache-from [] | External cache sources (eg. user/app:cache, type=local,src=path/to/dir)
|
|
||||||
| --cache-to [] | Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)
|
|
||||||
| --file string | Name of the Dockerfile (Default is 'PATH/Dockerfile')
|
|
||||||
| --iidfile string | Write the image ID to the file
|
|
||||||
| --label [] | Set metadata for an image
|
|
||||||
| --load | Shorthand for --output=type=docker
|
|
||||||
| --network string | Set the networking mode for the RUN instructions during build (default "default")
|
|
||||||
| --no-cache | Do not use cache when building the image
|
|
||||||
| --output [] | Output destination (format: type=local,dest=path)
|
|
||||||
| --platform [] | Set target platform for build
|
|
||||||
| --progress string | Set type of progress output (auto, plain, tty). Use plain to show container output (default "auto")
|
|
||||||
| --pull | Always attempt to pull a newer version of the image
|
|
||||||
| --push | Shorthand for --output=type=registry
|
|
||||||
| --secret [] | Secret file to expose to the build: id=mysecret,src=/local/secret
|
|
||||||
| --ssh [] | SSH agent socket or keys to expose to the build (format: default\|<id>[=<socket>\|<key>[,<key>]])
|
|
||||||
| --tag [] | Name and optionally a tag in the 'name:tag' format
|
|
||||||
| --target string | Set the target build stage to build.
|
|
||||||
|
|
||||||
For documentation on most of these flags refer to `docker build` documentation in https://docs.docker.com/engine/reference/commandline/build/ . In here we’ll document a subset of the new flags.
|
|
||||||
|
|
||||||
#### ` --platform=value[,value]`
|
|
||||||
|
|
||||||
Set the target platform for the build. All `FROM` commands inside the Dockerfile without their own `--platform` flag will pull base images for this platform and this value will also be the platform of the resulting image. The default value will be the current platform of the buildkit daemon.
|
|
||||||
|
|
||||||
When using `docker-container` driver with `buildx`, this flag can accept multiple values as an input separated by a comma. With multiple values the result will be built for all of the specified platforms and joined together into a single manifest list.
|
|
||||||
|
|
||||||
If the`Dockerfile` needs to invoke the `RUN` command, the builder needs runtime support for the specified platform. In a clean setup, you can only execute `RUN` commands for your system architecture. If your kernel supports binfmt_misc https://en.wikipedia.org/wiki/Binfmt_misc launchers for secondary architectures buildx will pick them up automatically. Docker desktop releases come with binfmt_misc automatically configured for `arm64` and `arm` architectures. You can see what runtime platforms your current builder instance supports by running `docker buildx inspect --bootstrap`.
|
|
||||||
|
|
||||||
Inside a `Dockerfile`, you can access the current platform value through `TARGETPLATFORM` build argument. Please refer to `docker build` documentation for the full description of automatic platform argument variants https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope .
|
|
||||||
|
|
||||||
The formatting for the platform specifier is defined in https://github.com/containerd/containerd/blob/v1.2.6/platforms/platforms.go#L63 .
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
```
|
|
||||||
docker buildx build --platform=linux/arm64 .
|
|
||||||
docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v7 .
|
|
||||||
docker buildx build --platform=darwin .
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `-o, --output=[PATH,-,type=TYPE[,KEY=VALUE]`
|
|
||||||
|
|
||||||
Sets the export action for the build result. In `docker build` all builds finish by creating a container image and exporting it to `docker images`. `buildx` makes this step configurable allowing results to be exported directly to the client, oci image tarballs, registry etc.
|
|
||||||
|
|
||||||
Buildx with `docker` driver currently only supports local, tarball exporter and image exporter. `docker-container` driver supports all the exporters.
|
|
||||||
|
|
||||||
If just the path is specified as a value, `buildx` will use the local exporter with this path as the destination. If the value is “-”, `buildx` will use `tar` exporter and write to `stdout`.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker buildx build -o . .
|
|
||||||
docker buildx build -o outdir .
|
|
||||||
docker buildx build -o - - > out.tar
|
|
||||||
docker buildx build -o type=docker .
|
|
||||||
docker buildx build -o type=docker,dest=- . > myimage.tar
|
|
||||||
docker buildx build -t tonistiigi/foo -o type=registry
|
|
||||||
````
|
|
||||||
|
|
||||||
Supported exported types are:
|
|
||||||
|
|
||||||
##### `local`
|
|
||||||
|
|
||||||
The `local` export type writes all result files to a directory on the client. The new files will be owned by the current user. On multi-platform builds, all results will be put in subdirectories by their platform.
|
|
||||||
|
|
||||||
Attribute key:
|
|
||||||
|
|
||||||
- `dest` - destination directory where files will be written
|
|
||||||
|
|
||||||
##### `tar`
|
|
||||||
|
|
||||||
The `tar` export type writes all result files as a single tarball on the client. On multi-platform builds all results will be put in subdirectories by their platform.
|
|
||||||
|
|
||||||
Attribute key:
|
|
||||||
|
|
||||||
- `dest` - destination path where tarball will be written. “-” writes to stdout.
|
|
||||||
|
|
||||||
##### `oci`
|
|
||||||
|
|
||||||
The `oci` export type writes the result image or manifest list as an OCI image layout tarball https://github.com/opencontainers/image-spec/blob/master/image-layout.md on the client.
|
|
||||||
|
|
||||||
Attribute key:
|
|
||||||
|
|
||||||
- `dest` - destination path where tarball will be written. “-” writes to stdout.
|
|
||||||
|
|
||||||
##### `docker`
|
|
||||||
|
|
||||||
The `docker` export type writes the single-platform result image as a Docker image specification tarball https://github.com/moby/moby/blob/master/image/spec/v1.2.md on the client. Tarballs created by this exporter are also OCI compatible.
|
|
||||||
|
|
||||||
Currently, multi-platform images cannot be exported with the `docker` export type. The most common usecase for multi-platform images is to directly push to a registry (see [`registry`](#registry)).
|
|
||||||
|
|
||||||
Attribute keys:
|
|
||||||
|
|
||||||
- `dest` - destination path where tarball will be written. If not specified the tar will be loaded automatically to the current docker instance.
|
|
||||||
- `context` - name for the docker context where to import the result
|
|
||||||
|
|
||||||
##### `image`
|
|
||||||
|
|
||||||
The `image` exporter writes the build result as an image or a manifest list. When using `docker` driver the image will appear in `docker images`. Optionally image can be automatically pushed to a registry by specifying attributes.
|
|
||||||
|
|
||||||
Attribute keys:
|
|
||||||
|
|
||||||
- `name` - name (references) for the new image.
|
|
||||||
- `push` - boolean to automatically push the image.
|
|
||||||
|
|
||||||
##### `registry`
|
|
||||||
|
|
||||||
The `registry` exporter is a shortcut for `type=image,push=true`.
|
|
||||||
|
|
||||||
|
|
||||||
#### `--push`
|
|
||||||
|
|
||||||
Shorthand for [`--output=type=registry`](#registry). Will automatically push the build result to registry.
|
|
||||||
|
|
||||||
#### `--load`
|
|
||||||
|
|
||||||
Shorthand for [`--output=type=docker`](#docker). Will automatically load the single-platform build result to `docker images`.
|
|
||||||
|
|
||||||
#### `--cache-from=[NAME|type=TYPE[,KEY=VALUE]]`
|
|
||||||
|
|
||||||
Use an external cache source for a build. Supported types are `registry` and `local`. The `registry` source can import cache from a cache manifest or (special) image configuration on the registry. The `local` source can import cache from local files previously exported with `--cache-to`.
|
|
||||||
|
|
||||||
If no type is specified, `registry` exporter is used with a specified reference.
|
|
||||||
|
|
||||||
`docker` driver currently only supports importing build cache from the registry.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
```
|
|
||||||
docker buildx build --cache-from=user/app:cache .
|
|
||||||
docker buildx build --cache-from=user/app .
|
|
||||||
docker buildx build --cache-from=type=registry,ref=user/app .
|
|
||||||
docker buildx build --cache-from=type=local,src=path/to/cache .
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--cache-to=[NAME|type=TYPE[,KEY=VALUE]]`
|
|
||||||
|
|
||||||
Export build cache to an external cache destination. Supported types are `registry`, `local` and `inline`. Registry exports build cache to a cache manifest in the registry, local exports cache to a local directory on the client and inline writes the cache metadata into the image configuration.
|
|
||||||
|
|
||||||
`docker` driver currently only supports exporting inline cache metadata to image configuration. Alternatively, `--build-arg BUILDKIT_INLINE_CACHE=1` can be used to trigger inline cache exporter.
|
|
||||||
|
|
||||||
Attribute key:
|
|
||||||
|
|
||||||
- `mode` - Specifies how many layers are exported with the cache. “min” on only exports layers already in the final build stage, “max” exports layers for all stages. Metadata is always exported for the whole build.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
```
|
|
||||||
docker buildx build --cache-to=user/app:cache .
|
|
||||||
docker buildx build --cache-to=type=inline .
|
|
||||||
docker buildx build --cache-to=type=registry,ref=user/app .
|
|
||||||
docker buildx build --cache-to=type=local,dest=path/to/cache .
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--allow=ENTITLEMENT`
|
|
||||||
|
|
||||||
Allow extra privileged entitlement. List of entitlements:
|
|
||||||
|
|
||||||
- `network.host` - Allows executions with host networking.
|
|
||||||
- `security.insecure` - Allows executions without sandbox. See [related Dockerfile extensions](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/experimental.md#run---securityinsecuresandbox).
|
|
||||||
|
|
||||||
For entitlements to be enabled, the `buildkitd` daemon also needs to allow them with `--allow-insecure-entitlement` (see [`create --buildkitd-flags`](#--buildkitd-flags-flags))
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
$ docker buildx create --use --name insecure-builder --buildkitd-flags '--allow-insecure-entitlement security.insecure'
|
|
||||||
$ docker buildx build --allow security.insecure .
|
|
||||||
```
|
|
||||||
|
|
||||||
### `buildx create [OPTIONS] [CONTEXT|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 the address for docker socket (eg. `DOCKER_HOST` value).
|
|
||||||
|
|
||||||
By default, the current docker configuration is used for determining the context/endpoint value.
|
|
||||||
|
|
||||||
Builder instances are isolated environments where builds can be invoked. All docker contexts also get the default builder instance.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| --append | Append a node to builder instead of changing it
|
|
||||||
| --buildkitd-flags string | Flags for buildkitd daemon
|
|
||||||
| --config string | BuildKit config file
|
|
||||||
| --driver string | Driver to use (eg. docker-container)
|
|
||||||
| --driver-opt stringArray | Options for the driver
|
|
||||||
| --leave | Remove a node from builder instead of changing it
|
|
||||||
| --name string | Builder instance name
|
|
||||||
| --node string | Create/modify node with given name
|
|
||||||
| --platform stringArray | Fixed platforms for current node
|
|
||||||
| --use | Set the current builder instance
|
|
||||||
|
|
||||||
#### `--append`
|
|
||||||
|
|
||||||
Changes the action of the command to appends a new node to an existing builder specified by `--name`. Buildx will choose an appropriate node for a build based on the platforms it supports.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
$ docker buildx create mycontext1
|
|
||||||
eager_beaver
|
|
||||||
$ docker buildx create --name eager_beaver --append mycontext2
|
|
||||||
eager_beaver
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--buildkitd-flags FLAGS`
|
|
||||||
|
|
||||||
Adds flags when starting the buildkitd daemon. They take precedence over the configuration file specified by [`--config`](#--config-file). See `buildkitd --help` for the available flags.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
--buildkitd-flags '--debug --debugaddr 0.0.0.0:6666'
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--config FILE`
|
|
||||||
|
|
||||||
Specifies the configuration file for the buildkitd daemon to use. The configuration can be overridden by [`--buildkitd-flags`](#--buildkitd-flags-flags). See an [example buildkitd configuration file](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md).
|
|
||||||
|
|
||||||
#### `--driver DRIVER`
|
|
||||||
|
|
||||||
Sets the builder driver to be used. There are two available drivers, each have their own specificities.
|
|
||||||
|
|
||||||
- `docker` - Uses the builder that is built into the docker daemon. With this driver, the [`--load`](#--load) flag is implied by default on `buildx build`. However, building multi-platform images or exporting cache is not currently supported.
|
|
||||||
|
|
||||||
- `docker-container` - Uses a buildkit container that will be spawned via docker. With this driver, both building multi-platform images and exporting cache are supported. However, images built will not automatically appear in `docker images` (see [`build --load`](#--load)).
|
|
||||||
|
|
||||||
- `kubernetes` - Uses a kubernetes pods. With this driver , you can spin up pods with defined buildkit container image to build your images.
|
|
||||||
|
|
||||||
|
|
||||||
#### `--driver-opt OPTIONS`
|
|
||||||
|
|
||||||
Passes additional driver-specific options. Details for each driver:
|
|
||||||
|
|
||||||
- `docker` - No driver options
|
|
||||||
- `docker-container`
|
|
||||||
- `image=IMAGE` - Sets the container image to be used for running buildkit.
|
|
||||||
- `network=NETMODE` - Sets the network mode for running the buildkit container.
|
|
||||||
- Example:
|
|
||||||
```
|
|
||||||
--driver docker-container --driver-opt image=moby/buildkit:master,network=host
|
|
||||||
```
|
|
||||||
- `kubernetes`
|
|
||||||
- `image=IMAGE` - Sets the container image to be used for running buildkit.
|
|
||||||
- `namespace=NS` - Sets the Kubernetes namespace. Defaults to the current namespace.
|
|
||||||
- `replicas=N` - Sets the number of `Pod` replicas. Defaults to 1.
|
|
||||||
- `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.
|
|
||||||
- `loadbalance=(sticky|random)` - Load-balancing strategy. If set to "sticky", the pod is chosen using the hash of the context path. Defaults to "sticky"
|
|
||||||
|
|
||||||
#### `--leave`
|
|
||||||
|
|
||||||
Changes the action of the command to removes a node from a builder. The builder needs to be specified with `--name` and node that is removed is set with `--node`.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
docker buildx create --name mybuilder --node mybuilder0 --leave
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--name NAME`
|
|
||||||
|
|
||||||
Specifies the name of the builder to be created or modified. If none is specified, one will be automatically generated.
|
|
||||||
|
|
||||||
#### `--node NODE`
|
|
||||||
|
|
||||||
Specifies the name of the node to be created or modified. If none is specified, it is the name of the builder it belongs to, with an index number suffix.
|
|
||||||
|
|
||||||
#### `--platform PLATFORMS`
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
docker buildx create --platform linux/amd64
|
|
||||||
docker buildx create --platform linux/arm64,linux/arm/v8
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--use`
|
|
||||||
|
|
||||||
Automatically switches the current builder to the newly created one. Equivalent to running `docker buildx use $(docker buildx create ...)`.
|
|
||||||
|
|
||||||
### `buildx use NAME`
|
|
||||||
|
|
||||||
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 switch to the default builder of that context.
|
|
||||||
|
|
||||||
### `buildx inspect [NAME]`
|
|
||||||
|
|
||||||
Shows information about the current or specified builder.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
Name: elated_tesla
|
|
||||||
Driver: docker-container
|
|
||||||
|
|
||||||
Nodes:
|
|
||||||
Name: elated_tesla0
|
|
||||||
Endpoint: unix:///var/run/docker.sock
|
|
||||||
Status: running
|
|
||||||
Platforms: linux/amd64
|
|
||||||
|
|
||||||
Name: elated_tesla1
|
|
||||||
Endpoint: ssh://ubuntu@1.2.3.4
|
|
||||||
Status: running
|
|
||||||
Platforms: linux/arm64, linux/arm/v7, linux/arm/v6
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--bootstrap`
|
|
||||||
|
|
||||||
Ensures that the builder is running before inspecting it. If the driver is `docker-container`, then `--bootstrap` starts the buildkit container and waits until it is operational. Bootstrapping is automatically done during build, it is thus not necessary. The same BuildKit container is used during the lifetime of the associated builder node (as displayed in `buildx ls`).
|
|
||||||
|
|
||||||
### `buildx ls`
|
|
||||||
|
|
||||||
Lists all builder instances and the nodes for each instance
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker buildx ls
|
|
||||||
NAME/NODE DRIVER/ENDPOINT STATUS PLATFORMS
|
|
||||||
elated_tesla * docker-container
|
|
||||||
elated_tesla0 unix:///var/run/docker.sock running linux/amd64
|
|
||||||
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 `*`.
|
|
||||||
|
|
||||||
### `buildx stop [NAME]`
|
|
||||||
|
|
||||||
Stops the specified or current builder. This will not prevent buildx build to restart the builder. The implementation of stop depends on the driver.
|
|
||||||
|
|
||||||
### `buildx rm [NAME]`
|
|
||||||
|
|
||||||
Removes the specified or current builder. It is a no-op attempting to remove the default builder.
|
|
||||||
|
|
||||||
### `buildx bake [OPTIONS] [TARGET...]`
|
|
||||||
|
|
||||||
Bake is a high-level build command.
|
|
||||||
|
|
||||||
Each specified target will run in parallel as part of the build.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| -f, --file stringArray | Build definition file
|
|
||||||
| --load | Shorthand for --set=*.output=type=docker
|
|
||||||
| --no-cache | Do not use cache when building the image
|
|
||||||
| --print | Print the options without building
|
|
||||||
| --progress string | Set type of progress output (auto, plain, tty). Use plain to show container output (default "auto")
|
|
||||||
| --pull | Always attempt to pull a newer version of the image
|
|
||||||
| --push | Shorthand for --set=*.output=type=registry
|
|
||||||
| --set stringArray | Override target value (eg: targetpattern.key=value)
|
|
||||||
|
|
||||||
#### `-f, --file FILE`
|
|
||||||
|
|
||||||
Specifies the bake definition file. The file can be a Docker Compose, JSON or HCL file. If multiple files are specified they are all read and configurations are combined. By default, if no files are specified, the following are parsed:
|
|
||||||
docker-compose.yml
|
|
||||||
docker-compose.yaml
|
|
||||||
docker-bake.json
|
|
||||||
docker-bake.override.json
|
|
||||||
docker-bake.hcl
|
|
||||||
docker-bake.override.hcl
|
|
||||||
|
|
||||||
#### `--no-cache`
|
|
||||||
|
|
||||||
Same as `build --no-cache`. Do not use cache when building the image.
|
|
||||||
|
|
||||||
#### `--print`
|
|
||||||
|
|
||||||
Prints the resulting options of the targets desired to be built, in a JSON format, without starting a build.
|
|
||||||
|
|
||||||
```
|
|
||||||
$ docker buildx bake -f docker-bake.hcl --print db
|
|
||||||
{
|
|
||||||
"target": {
|
|
||||||
"db": {
|
|
||||||
"context": "./",
|
|
||||||
"dockerfile": "Dockerfile",
|
|
||||||
"tags": [
|
|
||||||
"docker.io/tiborvass/db"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--progress`
|
|
||||||
|
|
||||||
Same as `build --progress`. Set type of progress output (auto, plain, tty). Use plain to show container output (default "auto").
|
|
||||||
|
|
||||||
#### `--pull`
|
|
||||||
|
|
||||||
Same as `build --pull`.
|
|
||||||
|
|
||||||
#### `--set targetpattern.key[.subkey]=value`
|
|
||||||
|
|
||||||
Override target configurations from command line. The pattern matching syntax is defined in https://golang.org/pkg/path/#Match.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
docker buildx bake --set target.args.mybuildarg=value
|
|
||||||
docker buildx bake --set target.platform=linux/arm64
|
|
||||||
docker buildx bake --set foo*.args.mybuildarg=value # overrides build arg for all targets starting with 'foo'
|
|
||||||
docker buildx bake --set *.platform=linux/arm64 # overrides platform for all targets
|
|
||||||
docker buildx bake --set foo*.no-cache # bypass caching only for targets starting with 'foo'
|
|
||||||
```
|
|
||||||
|
|
||||||
Complete list of overridable fields:
|
|
||||||
args, cache-from, cache-to, context, dockerfile, labels, no-cache, output, platform, pull, secrets, ssh, tags, target
|
|
||||||
|
|
||||||
#### File definition
|
|
||||||
|
|
||||||
In addition to compose files, bake supports a JSON and an equivalent HCL file format for defining build groups and targets.
|
|
||||||
|
|
||||||
A target reflects a single docker build invocation with the same options that you would specify for `docker build`. A group is a grouping of targets.
|
|
||||||
|
|
||||||
Multiple files can include the same target and final build options will be determined by merging them together.
|
|
||||||
|
|
||||||
In the case of compose files, each service corresponds to a target.
|
|
||||||
|
|
||||||
A group can specify its list of targets with the `targets` option. A target can inherit build options by setting the `inherits` option to the list of targets or groups to inherit from.
|
|
||||||
|
|
||||||
Note: Design of bake command is work in progress, the user experience may change based on feedback.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Example HCL definition:
|
|
||||||
|
|
||||||
```
|
|
||||||
group "default" {
|
|
||||||
targets = ["db", "webapp-dev"]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "webapp-dev" {
|
|
||||||
dockerfile = "Dockerfile.webapp"
|
|
||||||
tags = ["docker.io/username/webapp"]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "webapp-release" {
|
|
||||||
inherits = ["webapp-dev"]
|
|
||||||
platforms = ["linux/amd64", "linux/arm64"]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "db" {
|
|
||||||
dockerfile = "Dockerfile.db"
|
|
||||||
tags = ["docker.io/username/db"]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Complete list of valid target fields:
|
|
||||||
args, cache-from, cache-to, context, dockerfile, inherits, labels, no-cache, output, platform, pull, secrets, ssh, tags, target
|
|
||||||
|
|
||||||
#### HCL variables and functions
|
|
||||||
|
|
||||||
Similar to how Terraform provides a way to [define variables](https://www.terraform.io/docs/configuration/variables.html#declaring-an-input-variable), the HCL file format also supports variable block definitions. These can be used to define variables with values provided by the current environment or a default value when unset.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Example of using interpolation to tag an image with the git sha:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cat <<'EOF' > docker-bake.hcl
|
|
||||||
variable "TAG" {
|
|
||||||
default = "latest"
|
|
||||||
}
|
|
||||||
|
|
||||||
group "default" {
|
|
||||||
targets = ["webapp"]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "webapp" {
|
|
||||||
tags = ["docker.io/username/webapp:${TAG}"]
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
$ docker buildx bake --print webapp
|
|
||||||
{
|
|
||||||
"target": {
|
|
||||||
"webapp": {
|
|
||||||
"context": ".",
|
|
||||||
"dockerfile": "Dockerfile",
|
|
||||||
"tags": [
|
|
||||||
"docker.io/username/webapp:latest"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$ TAG=$(git rev-parse --short HEAD) docker buildx bake --print webapp
|
|
||||||
{
|
|
||||||
"target": {
|
|
||||||
"webapp": {
|
|
||||||
"context": ".",
|
|
||||||
"dockerfile": "Dockerfile",
|
|
||||||
"tags": [
|
|
||||||
"docker.io/username/webapp:985e9e9"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
A [set of generally useful functions](https://github.com/docker/buildx/blob/master/bake/hcl.go#L19-L65) provided by [go-cty](https://github.com/zclconf/go-cty/tree/master/cty/function/stdlib) are available for use in HCL files. In addition, [user defined functions](https://github.com/hashicorp/hcl/tree/hcl2/ext/userfunc) are also supported.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Example of using the `add` function:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cat <<'EOF' > docker-bake.hcl
|
|
||||||
variable "TAG" {
|
|
||||||
default = "latest"
|
|
||||||
}
|
|
||||||
|
|
||||||
group "default" {
|
|
||||||
targets = ["webapp"]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "webapp" {
|
|
||||||
args = {
|
|
||||||
buildno = "${add(123, 1)}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
$ docker buildx bake --print webapp
|
|
||||||
{
|
|
||||||
"target": {
|
|
||||||
"webapp": {
|
|
||||||
"context": ".",
|
|
||||||
"dockerfile": "Dockerfile",
|
|
||||||
"args": {
|
|
||||||
"buildno": "124"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Example of defining an `increment` function:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cat <<'EOF' > docker-bake.hcl
|
|
||||||
function "increment" {
|
|
||||||
params = [number]
|
|
||||||
result = number + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
group "default" {
|
|
||||||
targets = ["webapp"]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "webapp" {
|
|
||||||
args = {
|
|
||||||
buildno = "${increment(123)}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
$ docker buildx bake --print webapp
|
|
||||||
{
|
|
||||||
"target": {
|
|
||||||
"webapp": {
|
|
||||||
"context": ".",
|
|
||||||
"dockerfile": "Dockerfile",
|
|
||||||
"args": {
|
|
||||||
"buildno": "124"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Example of only adding tags if a variable is not empty using an `notequal` function:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cat <<'EOF' > docker-bake.hcl
|
|
||||||
variable "TAG" {default="" }
|
|
||||||
|
|
||||||
group "default" {
|
|
||||||
targets = [
|
|
||||||
"webapp",
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
target "webapp" {
|
|
||||||
context="."
|
|
||||||
dockerfile="Dockerfile"
|
|
||||||
tags = [
|
|
||||||
"my-image:latest",
|
|
||||||
notequal("",TAG) ? "my-image:${TAG}": "",
|
|
||||||
]
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
$ docker buildx bake --print webapp
|
|
||||||
{
|
|
||||||
"target": {
|
|
||||||
"webapp": {
|
|
||||||
"context": ".",
|
|
||||||
"dockerfile": "Dockerfile",
|
|
||||||
"tags": [
|
|
||||||
"my-image:latest"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]`
|
|
||||||
|
|
||||||
Imagetools contains commands for working with manifest lists in the registry. These commands are useful for inspecting multi-platform build results.
|
|
||||||
|
|
||||||
Create creates a new manifest list based on source manifests. The source manifests can 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 specified create performs a carbon copy.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| --append | Append to existing manifest
|
|
||||||
| --dry-run | Show final image instead of pushing
|
|
||||||
| -f, --file stringArray | Read source descriptor from file
|
|
||||||
| -t, --tag stringArray | Set reference for new image
|
|
||||||
|
|
||||||
#### `--append`
|
|
||||||
|
|
||||||
Append appends the new sources to an existing manifest list in the destination.
|
|
||||||
|
|
||||||
#### `--dry-run`
|
|
||||||
|
|
||||||
Do not push the image, just show it.
|
|
||||||
|
|
||||||
#### `-f, --file FILE`
|
|
||||||
|
|
||||||
Reads source from files. A source can be a manifest digest, manifest reference or a JSON of OCI descriptor object.
|
|
||||||
|
|
||||||
#### `-t, --tag IMAGE`
|
|
||||||
|
|
||||||
Name of the image to be created.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker buildx imagetools create --dry-run alpine@sha256:5c40b3c27b9f13c873fefb2139765c56ce97fd50230f1f2d5c91e55dec171907 sha256:c4ba6347b0e4258ce6a6de2401619316f982b7bcc529f73d2a410d0097730204
|
|
||||||
|
|
||||||
docker buildx imagetools create -t tonistiigi/myapp -f image1 -f image2
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `buildx imagetools inspect NAME`
|
|
||||||
|
|
||||||
Show details of image in the registry.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```
|
|
||||||
$ docker buildx imagetools inspect alpine
|
|
||||||
Name: docker.io/library/alpine:latest
|
|
||||||
MediaType: application/vnd.docker.distribution.manifest.list.v2+json
|
|
||||||
Digest: sha256:28ef97b8686a0b5399129e9b763d5b7e5ff03576aa5580d6f4182a49c5fe1913
|
|
||||||
|
|
||||||
Manifests:
|
|
||||||
Name: docker.io/library/alpine:latest@sha256:5c40b3c27b9f13c873fefb2139765c56ce97fd50230f1f2d5c91e55dec171907
|
|
||||||
MediaType: application/vnd.docker.distribution.manifest.v2+json
|
|
||||||
Platform: linux/amd64
|
|
||||||
|
|
||||||
Name: docker.io/library/alpine:latest@sha256:c4ba6347b0e4258ce6a6de2401619316f982b7bcc529f73d2a410d0097730204
|
|
||||||
MediaType: application/vnd.docker.distribution.manifest.v2+json
|
|
||||||
Platform: linux/arm/v6
|
|
||||||
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `--raw`
|
|
||||||
|
|
||||||
Raw prints the original JSON bytes instead of the formatted output.
|
|
||||||
|
|
||||||
|
|
||||||
# Setting buildx as default builder in Docker 19.03+
|
# Setting buildx as default builder in Docker 19.03+
|
||||||
|
|
||||||
Running `docker buildx install` sets up `docker builder` command as an alias to `docker buildx`. This results in the ability to have `docker build` use the current buildx builder.
|
Running `docker buildx install` sets up `docker builder` command as an alias to `docker buildx`. This results in the ability to have `docker build` use the current buildx builder.
|
||||||
|
|||||||
@@ -238,8 +238,12 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
|
|||||||
flags.BoolVar(&options.exportLoad, "load", false, "Shorthand for --output=type=docker")
|
flags.BoolVar(&options.exportLoad, "load", false, "Shorthand for --output=type=docker")
|
||||||
|
|
||||||
flags.StringArrayVarP(&options.tags, "tag", "t", []string{}, "Name and optionally a tag in the 'name:tag' format")
|
flags.StringArrayVarP(&options.tags, "tag", "t", []string{}, "Name and optionally a tag in the 'name:tag' format")
|
||||||
|
flags.SetAnnotation("tag", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t"})
|
||||||
flags.StringArrayVar(&options.buildArgs, "build-arg", []string{}, "Set build-time variables")
|
flags.StringArrayVar(&options.buildArgs, "build-arg", []string{}, "Set build-time variables")
|
||||||
|
flags.SetAnnotation("build-arg", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg"})
|
||||||
|
|
||||||
flags.StringVarP(&options.dockerfileName, "file", "f", "", "Name of the Dockerfile (Default is 'PATH/Dockerfile')")
|
flags.StringVarP(&options.dockerfileName, "file", "f", "", "Name of the Dockerfile (Default is 'PATH/Dockerfile')")
|
||||||
|
flags.SetAnnotation("file", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f"})
|
||||||
|
|
||||||
flags.StringArrayVar(&options.labels, "label", []string{}, "Set metadata for an image")
|
flags.StringArrayVar(&options.labels, "label", []string{}, "Set metadata for an image")
|
||||||
|
|
||||||
@@ -247,6 +251,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
|
|||||||
flags.StringArrayVar(&options.cacheTo, "cache-to", []string{}, "Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)")
|
flags.StringArrayVar(&options.cacheTo, "cache-to", []string{}, "Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)")
|
||||||
|
|
||||||
flags.StringVar(&options.target, "target", "", "Set the target build stage to build.")
|
flags.StringVar(&options.target, "target", "", "Set the target build stage to build.")
|
||||||
|
flags.SetAnnotation("target", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target"})
|
||||||
|
|
||||||
flags.StringSliceVar(&options.allow, "allow", []string{}, "Allow extra privileged entitlement, e.g. network.host, security.insecure")
|
flags.StringSliceVar(&options.allow, "allow", []string{}, "Allow extra privileged entitlement, e.g. network.host, security.insecure")
|
||||||
|
|
||||||
@@ -254,6 +259,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
|
|||||||
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Suppress the build output and print image ID on success")
|
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Suppress the build output and print image ID on success")
|
||||||
flags.StringVar(&options.networkMode, "network", "default", "Set the networking mode for the RUN instructions during build")
|
flags.StringVar(&options.networkMode, "network", "default", "Set the networking mode for the RUN instructions during build")
|
||||||
flags.StringSliceVar(&options.extraHosts, "add-host", []string{}, "Add a custom host-to-IP mapping (host:ip)")
|
flags.StringSliceVar(&options.extraHosts, "add-host", []string{}, "Add a custom host-to-IP mapping (host:ip)")
|
||||||
|
flags.SetAnnotation("add-host", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host"})
|
||||||
flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID to the file")
|
flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID to the file")
|
||||||
flags.BoolVar(&options.squash, "squash", false, "Squash newly built layers into a single new layer")
|
flags.BoolVar(&options.squash, "squash", false, "Squash newly built layers into a single new layer")
|
||||||
flags.MarkHidden("quiet")
|
flags.MarkHidden("quiet")
|
||||||
|
|||||||
198
docs/docsgen/generate.go
Normal file
198
docs/docsgen/generate.go
Normal file
@@ -0,0 +1,198 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/docker/buildx/commands"
|
||||||
|
"github.com/docker/cli/cli/command"
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
const descriptionSourcePath = "docs/reference/"
|
||||||
|
|
||||||
|
func generateDocs(opts *options) error {
|
||||||
|
dockerCLI, err := command.NewDockerCli()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "docker [OPTIONS] COMMAND [ARG...]",
|
||||||
|
Short: "The base command for the Docker CLI.",
|
||||||
|
}
|
||||||
|
cmd.AddCommand(commands.NewRootCmd("buildx", true, dockerCLI))
|
||||||
|
return genCmd(cmd, opts.target)
|
||||||
|
}
|
||||||
|
|
||||||
|
func getMDFilename(cmd *cobra.Command) string {
|
||||||
|
name := cmd.CommandPath()
|
||||||
|
if i := strings.Index(name, " "); i >= 0 {
|
||||||
|
name = name[i+1:]
|
||||||
|
}
|
||||||
|
return strings.ReplaceAll(name, " ", "_") + ".md"
|
||||||
|
}
|
||||||
|
|
||||||
|
func genCmd(cmd *cobra.Command, dir string) error {
|
||||||
|
for _, c := range cmd.Commands() {
|
||||||
|
if err := genCmd(c, dir); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !cmd.HasParent() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
mdFile := getMDFilename(cmd)
|
||||||
|
fullPath := filepath.Join(dir, mdFile)
|
||||||
|
|
||||||
|
content, err := ioutil.ReadFile(fullPath)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return errors.Wrapf(err, "%s does not exist", mdFile)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cs := string(content)
|
||||||
|
|
||||||
|
markerStart := "<!---MARKER_GEN_START-->"
|
||||||
|
markerEnd := "<!---MARKER_GEN_END-->"
|
||||||
|
|
||||||
|
start := strings.Index(cs, markerStart)
|
||||||
|
end := strings.Index(cs, markerEnd)
|
||||||
|
|
||||||
|
if start == -1 {
|
||||||
|
return errors.Errorf("no start marker in %s", mdFile)
|
||||||
|
}
|
||||||
|
if end == -1 {
|
||||||
|
return errors.Errorf("no end marker in %s", mdFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
out, err := cmdOutput(cmd, cs)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cont := cs[:start] + markerStart + "\n" + out + "\n" + cs[end:]
|
||||||
|
|
||||||
|
fi, err := os.Stat(fullPath)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := ioutil.WriteFile(fullPath, []byte(cont), fi.Mode()); err != nil {
|
||||||
|
return errors.Wrapf(err, "failed to write %s", fullPath)
|
||||||
|
}
|
||||||
|
log.Printf("updated %s", fullPath)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeLink(txt, link string, f *pflag.Flag, isAnchor bool) string {
|
||||||
|
link = "#" + link
|
||||||
|
annotations, ok := f.Annotations["docs.external.url"]
|
||||||
|
if ok && len(annotations) > 0 {
|
||||||
|
link = annotations[0]
|
||||||
|
} else {
|
||||||
|
if !isAnchor {
|
||||||
|
return txt
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "[" + txt + "](" + link + ")"
|
||||||
|
}
|
||||||
|
|
||||||
|
func cmdOutput(cmd *cobra.Command, old string) (string, error) {
|
||||||
|
b := &strings.Builder{}
|
||||||
|
|
||||||
|
desc := cmd.Short
|
||||||
|
if cmd.Long != "" {
|
||||||
|
desc = cmd.Long
|
||||||
|
}
|
||||||
|
if desc != "" {
|
||||||
|
fmt.Fprintf(b, "%s\n\n", desc)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(cmd.Aliases) != 0 {
|
||||||
|
fmt.Fprintf(b, "### Aliases\n\n`%s`", cmd.Name())
|
||||||
|
for _, a := range cmd.Aliases {
|
||||||
|
fmt.Fprintf(b, ", `%s`", a)
|
||||||
|
}
|
||||||
|
fmt.Fprint(b, "\n\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(cmd.Commands()) != 0 {
|
||||||
|
fmt.Fprint(b, "### Subcommands\n\n")
|
||||||
|
fmt.Fprint(b, "| Name | Description |\n")
|
||||||
|
fmt.Fprint(b, "| --- | --- |\n")
|
||||||
|
for _, c := range cmd.Commands() {
|
||||||
|
fmt.Fprintf(b, "| [`%s`](%s) | %s |\n", c.Name(), getMDFilename(c), c.Short)
|
||||||
|
}
|
||||||
|
fmt.Fprint(b, "\n\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
hasFlags := cmd.Flags().HasAvailableFlags()
|
||||||
|
|
||||||
|
cmd.Flags().AddFlagSet(cmd.InheritedFlags())
|
||||||
|
|
||||||
|
if hasFlags {
|
||||||
|
fmt.Fprint(b, "### Options\n\n")
|
||||||
|
fmt.Fprint(b, "| Name | Description |\n")
|
||||||
|
fmt.Fprint(b, "| --- | --- |\n")
|
||||||
|
|
||||||
|
cmd.Flags().VisitAll(func(f *pflag.Flag) {
|
||||||
|
if f.Hidden {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
isLink := strings.Contains(old, "<a name=\""+f.Name+"\"></a>")
|
||||||
|
fmt.Fprint(b, "| ")
|
||||||
|
if f.Shorthand != "" {
|
||||||
|
name := "`-" + f.Shorthand + "`"
|
||||||
|
name = makeLink(name, f.Name, f, isLink)
|
||||||
|
fmt.Fprintf(b, "%s, ", name)
|
||||||
|
}
|
||||||
|
name := "`--" + f.Name
|
||||||
|
if f.Value.Type() != "bool" {
|
||||||
|
name += " " + f.Value.Type()
|
||||||
|
}
|
||||||
|
name += "`"
|
||||||
|
name = makeLink(name, f.Name, f, isLink)
|
||||||
|
fmt.Fprintf(b, "%s | %s |\n", name, f.Usage)
|
||||||
|
})
|
||||||
|
fmt.Fprintln(b, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.String(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type options struct {
|
||||||
|
target string
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseArgs() (*options, error) {
|
||||||
|
opts := &options{}
|
||||||
|
flags := pflag.NewFlagSet(os.Args[0], pflag.ContinueOnError)
|
||||||
|
flags.StringVar(&opts.target, "target", descriptionSourcePath, "Docs directory")
|
||||||
|
err := flags.Parse(os.Args[1:])
|
||||||
|
return opts, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if err := run(); err != nil {
|
||||||
|
log.Printf("error: %+v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func run() error {
|
||||||
|
opts, err := parseArgs()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := generateDocs(opts); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
31
docs/reference/buildx.md
Normal file
31
docs/reference/buildx.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# buildx
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx [OPTIONS] COMMAND
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Build with BuildKit
|
||||||
|
|
||||||
|
### Subcommands
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`bake`](buildx_bake.md) | Build from a file |
|
||||||
|
| [`build`](buildx_build.md) | Start a build |
|
||||||
|
| [`create`](buildx_create.md) | Create a new builder instance |
|
||||||
|
| [`du`](buildx_du.md) | Disk usage |
|
||||||
|
| [`imagetools`](buildx_imagetools.md) | Commands to work on images in registry |
|
||||||
|
| [`inspect`](buildx_inspect.md) | Inspect current builder instance |
|
||||||
|
| [`install`](buildx_install.md) | Install buildx as a 'docker builder' alias |
|
||||||
|
| [`ls`](buildx_ls.md) | List builder instances |
|
||||||
|
| [`prune`](buildx_prune.md) | Remove build cache |
|
||||||
|
| [`rm`](buildx_rm.md) | Remove a builder instance |
|
||||||
|
| [`stop`](buildx_stop.md) | Stop builder instance |
|
||||||
|
| [`uninstall`](buildx_uninstall.md) | Uninstall the 'docker builder' alias |
|
||||||
|
| [`use`](buildx_use.md) | Set the current builder instance |
|
||||||
|
| [`version`](buildx_version.md) | Show buildx version information |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
369
docs/reference/buildx_bake.md
Normal file
369
docs/reference/buildx_bake.md
Normal file
@@ -0,0 +1,369 @@
|
|||||||
|
# buildx bake
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx bake [OPTIONS] [TARGET...]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Build from a file
|
||||||
|
|
||||||
|
### Aliases
|
||||||
|
|
||||||
|
`bake`, `f`
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| [`-f`](#file), [`--file stringArray`](#file) | Build definition file |
|
||||||
|
| `--load` | Shorthand for --set=*.output=type=docker |
|
||||||
|
| [`--no-cache`](#no-cache) | Do not use cache when building the image |
|
||||||
|
| [`--print`](#print) | Print the options without building |
|
||||||
|
| [`--progress string`](#progress) | Set type of progress output (auto, plain, tty). Use plain to show container output |
|
||||||
|
| [`--pull`](#pull) | Always attempt to pull a newer version of the image |
|
||||||
|
| `--push` | Shorthand for --set=*.output=type=registry |
|
||||||
|
| [`--set stringArray`](#set) | Override target value (eg: targetpattern.key=value) |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Bake is a high-level build command. Each specified target will run in parallel
|
||||||
|
as part of the build.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### <a name="file"></a> Specify a build definition file (-f, --file)
|
||||||
|
|
||||||
|
By default, `buildx bake` looks for build definition files in the current directory,
|
||||||
|
the following are parsed:
|
||||||
|
|
||||||
|
- `docker-compose.yml`
|
||||||
|
- `docker-compose.yaml`
|
||||||
|
- `docker-bake.json`
|
||||||
|
- `docker-bake.override.json`
|
||||||
|
- `docker-bake.hcl`
|
||||||
|
- `docker-bake.override.hcl`
|
||||||
|
|
||||||
|
Use the `-f` / `--file` option to specify the build definition file to use. The
|
||||||
|
file can be a Docker Compose, JSON or HCL file. If multiple files are specified
|
||||||
|
they are all read and configurations are combined.
|
||||||
|
|
||||||
|
The following example uses a Docker Compose file named `docker-compose.dev.yaml`
|
||||||
|
as build definition file, and builds all targets in the file:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx bake -f docker-compose.dev.yaml
|
||||||
|
|
||||||
|
[+] Building 66.3s (30/30) FINISHED
|
||||||
|
=> [frontend internal] load build definition from Dockerfile 0.1s
|
||||||
|
=> => transferring dockerfile: 36B 0.0s
|
||||||
|
=> [backend internal] load build definition from Dockerfile 0.2s
|
||||||
|
=> => transferring dockerfile: 3.73kB 0.0s
|
||||||
|
=> [database internal] load build definition from Dockerfile 0.1s
|
||||||
|
=> => transferring dockerfile: 5.77kB 0.0s
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Pass the names of the targets to build, to build only specific target(s). The
|
||||||
|
following example builds the `backend` and `database` targets that are defined
|
||||||
|
in the `docker-compose.dev.yaml` file, skipping the build for the `frontend`
|
||||||
|
target:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx bake -f docker-compose.dev.yaml backend database
|
||||||
|
|
||||||
|
[+] Building 2.4s (13/13) FINISHED
|
||||||
|
=> [backend internal] load build definition from Dockerfile 0.1s
|
||||||
|
=> => transferring dockerfile: 81B 0.0s
|
||||||
|
=> [database internal] load build definition from Dockerfile 0.2s
|
||||||
|
=> => transferring dockerfile: 36B 0.0s
|
||||||
|
=> [backend internal] load .dockerignore 0.3s
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="no-cache"></a> Do not use cache when building the image (--no-cache)
|
||||||
|
|
||||||
|
Same as `build --no-cache`. Do not use cache when building the image.
|
||||||
|
|
||||||
|
### <a name="print"></a> Print the options without building (--print)
|
||||||
|
|
||||||
|
Prints the resulting options of the targets desired to be built, in a JSON format,
|
||||||
|
without starting a build.
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx bake -f docker-bake.hcl --print db
|
||||||
|
{
|
||||||
|
"target": {
|
||||||
|
"db": {
|
||||||
|
"context": "./",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"tags": [
|
||||||
|
"docker.io/tiborvass/db"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="progress"></a> Set type of progress output (--progress)
|
||||||
|
|
||||||
|
Same as `build --progress`. Set type of progress output (auto, plain, tty). Use
|
||||||
|
plain to show container output (default "auto").
|
||||||
|
|
||||||
|
The following example uses `plain` output during the build:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx bake --progress=plain
|
||||||
|
|
||||||
|
#2 [backend internal] load build definition from Dockerfile.test
|
||||||
|
#2 sha256:de70cb0bb6ed8044f7b9b1b53b67f624e2ccfb93d96bb48b70c1fba562489618
|
||||||
|
#2 ...
|
||||||
|
|
||||||
|
#1 [database internal] load build definition from Dockerfile.test
|
||||||
|
#1 sha256:453cb50abd941762900a1212657a35fc4aad107f5d180b0ee9d93d6b74481bce
|
||||||
|
#1 transferring dockerfile: 36B done
|
||||||
|
#1 DONE 0.1s
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <a name="pull"></a> Always attempt to pull a newer version of the image (--pull)
|
||||||
|
|
||||||
|
Same as `build --pull`.
|
||||||
|
|
||||||
|
### <a name="set"></a> Override target configurations from command line (--set)
|
||||||
|
|
||||||
|
```
|
||||||
|
--set targetpattern.key[.subkey]=value
|
||||||
|
```
|
||||||
|
|
||||||
|
Override target configurations from command line. The pattern matching syntax is
|
||||||
|
defined in https://golang.org/pkg/path/#Match.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx bake --set target.args.mybuildarg=value
|
||||||
|
$ docker buildx bake --set target.platform=linux/arm64
|
||||||
|
$ docker buildx bake --set foo*.args.mybuildarg=value # overrides build arg for all targets starting with 'foo'
|
||||||
|
$ docker buildx bake --set *.platform=linux/arm64 # overrides platform for all targets
|
||||||
|
$ docker buildx bake --set foo*.no-cache # bypass caching only for targets starting with 'foo'
|
||||||
|
```
|
||||||
|
|
||||||
|
Complete list of overridable fields:
|
||||||
|
args, cache-from, cache-to, context, dockerfile, labels, no-cache, output, platform,
|
||||||
|
pull, secrets, ssh, tags, target
|
||||||
|
|
||||||
|
### File definition
|
||||||
|
|
||||||
|
In addition to compose files, bake supports a JSON and an equivalent HCL file
|
||||||
|
format for defining build groups and targets.
|
||||||
|
|
||||||
|
A target reflects a single docker build invocation with the same options that
|
||||||
|
you would specify for `docker build`. A group is a grouping of targets.
|
||||||
|
|
||||||
|
Multiple files can include the same target and final build options will be
|
||||||
|
determined by merging them together.
|
||||||
|
|
||||||
|
In the case of compose files, each service corresponds to a target.
|
||||||
|
|
||||||
|
A group can specify its list of targets with the `targets` option. A target can
|
||||||
|
inherit build options by setting the `inherits` option to the list of targets or
|
||||||
|
groups to inherit from.
|
||||||
|
|
||||||
|
Note: Design of bake command is work in progress, the user experience may change
|
||||||
|
based on feedback.
|
||||||
|
|
||||||
|
|
||||||
|
**Example HCL definition**
|
||||||
|
|
||||||
|
```hcl
|
||||||
|
group "default" {
|
||||||
|
targets = ["db", "webapp-dev"]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "webapp-dev" {
|
||||||
|
dockerfile = "Dockerfile.webapp"
|
||||||
|
tags = ["docker.io/username/webapp"]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "webapp-release" {
|
||||||
|
inherits = ["webapp-dev"]
|
||||||
|
platforms = ["linux/amd64", "linux/arm64"]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "db" {
|
||||||
|
dockerfile = "Dockerfile.db"
|
||||||
|
tags = ["docker.io/username/db"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Complete list of valid target fields:
|
||||||
|
|
||||||
|
`args`, `cache-from`, `cache-to`, `context`, `dockerfile`, `inherits`, `labels`,
|
||||||
|
`no-cache`, `output`, `platform`, `pull`, `secrets`, `ssh`, `tags`, `target`
|
||||||
|
|
||||||
|
### HCL variables and functions
|
||||||
|
|
||||||
|
Similar to how Terraform provides a way to [define variables](https://www.terraform.io/docs/configuration/variables.html#declaring-an-input-variable),
|
||||||
|
the HCL file format also supports variable block definitions. These can be used
|
||||||
|
to define variables with values provided by the current environment, or a default
|
||||||
|
value when unset.
|
||||||
|
|
||||||
|
|
||||||
|
Example of using interpolation to tag an image with the git sha:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ cat <<'EOF' > docker-bake.hcl
|
||||||
|
variable "TAG" {
|
||||||
|
default = "latest"
|
||||||
|
}
|
||||||
|
|
||||||
|
group "default" {
|
||||||
|
targets = ["webapp"]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "webapp" {
|
||||||
|
tags = ["docker.io/username/webapp:${TAG}"]
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
$ docker buildx bake --print webapp
|
||||||
|
{
|
||||||
|
"target": {
|
||||||
|
"webapp": {
|
||||||
|
"context": ".",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"tags": [
|
||||||
|
"docker.io/username/webapp:latest"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$ TAG=$(git rev-parse --short HEAD) docker buildx bake --print webapp
|
||||||
|
{
|
||||||
|
"target": {
|
||||||
|
"webapp": {
|
||||||
|
"context": ".",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"tags": [
|
||||||
|
"docker.io/username/webapp:985e9e9"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
A [set of generally useful functions](https://github.com/docker/buildx/blob/master/bake/hcl.go#L19-L65)
|
||||||
|
provided by [go-cty](https://github.com/zclconf/go-cty/tree/master/cty/function/stdlib)
|
||||||
|
are available for use in HCL files. In addition, [user defined functions](https://github.com/hashicorp/hcl/tree/hcl2/ext/userfunc)
|
||||||
|
are also supported.
|
||||||
|
|
||||||
|
Example of using the `add` function:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ cat <<'EOF' > docker-bake.hcl
|
||||||
|
variable "TAG" {
|
||||||
|
default = "latest"
|
||||||
|
}
|
||||||
|
|
||||||
|
group "default" {
|
||||||
|
targets = ["webapp"]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "webapp" {
|
||||||
|
args = {
|
||||||
|
buildno = "${add(123, 1)}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
$ docker buildx bake --print webapp
|
||||||
|
{
|
||||||
|
"target": {
|
||||||
|
"webapp": {
|
||||||
|
"context": ".",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"args": {
|
||||||
|
"buildno": "124"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example of defining an `increment` function:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ cat <<'EOF' > docker-bake.hcl
|
||||||
|
function "increment" {
|
||||||
|
params = [number]
|
||||||
|
result = number + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
group "default" {
|
||||||
|
targets = ["webapp"]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "webapp" {
|
||||||
|
args = {
|
||||||
|
buildno = "${increment(123)}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
$ docker buildx bake --print webapp
|
||||||
|
{
|
||||||
|
"target": {
|
||||||
|
"webapp": {
|
||||||
|
"context": ".",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"args": {
|
||||||
|
"buildno": "124"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example of only adding tags if a variable is not empty using an `notequal`
|
||||||
|
function:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ cat <<'EOF' > docker-bake.hcl
|
||||||
|
variable "TAG" {default="" }
|
||||||
|
|
||||||
|
group "default" {
|
||||||
|
targets = [
|
||||||
|
"webapp",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
target "webapp" {
|
||||||
|
context="."
|
||||||
|
dockerfile="Dockerfile"
|
||||||
|
tags = [
|
||||||
|
"my-image:latest",
|
||||||
|
notequal("",TAG) ? "my-image:${TAG}": "",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
$ docker buildx bake --print webapp
|
||||||
|
{
|
||||||
|
"target": {
|
||||||
|
"webapp": {
|
||||||
|
"context": ".",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"tags": [
|
||||||
|
"my-image:latest"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
271
docs/reference/buildx_build.md
Normal file
271
docs/reference/buildx_build.md
Normal file
@@ -0,0 +1,271 @@
|
|||||||
|
# buildx build
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx build [OPTIONS] PATH | URL | -
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Start a build
|
||||||
|
|
||||||
|
### Aliases
|
||||||
|
|
||||||
|
`build`, `b`
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`--add-host stringSlice`](https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host) | Add a custom host-to-IP mapping (host:ip) |
|
||||||
|
| [`--allow stringSlice`](#allow) | Allow extra privileged entitlement, e.g. network.host, security.insecure |
|
||||||
|
| [`--build-arg stringArray`](https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg) | Set build-time variables |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| [`--cache-from stringArray`](#cache-from) | External cache sources (eg. user/app:cache, type=local,src=path/to/dir) |
|
||||||
|
| [`--cache-to stringArray`](#cache-to) | Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir) |
|
||||||
|
| [`-f`](https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f), [`--file string`](https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f) | Name of the Dockerfile (Default is 'PATH/Dockerfile') |
|
||||||
|
| `--iidfile string` | Write the image ID to the file |
|
||||||
|
| `--label stringArray` | Set metadata for an image |
|
||||||
|
| [`--load`](#load) | Shorthand for --output=type=docker |
|
||||||
|
| `--network string` | Set the networking mode for the RUN instructions during build |
|
||||||
|
| `--no-cache` | Do not use cache when building the image |
|
||||||
|
| [`-o`](#output), [`--output stringArray`](#output) | Output destination (format: type=local,dest=path) |
|
||||||
|
| [`--platform stringArray`](#platform) | Set target platform for build |
|
||||||
|
| `--progress string` | Set type of progress output (auto, plain, tty). Use plain to show container output |
|
||||||
|
| `--pull` | Always attempt to pull a newer version of the image |
|
||||||
|
| [`--push`](#push) | Shorthand for --output=type=registry |
|
||||||
|
| `--secret stringArray` | Secret file to expose to the build: id=mysecret,src=/local/secret |
|
||||||
|
| `--ssh stringArray` | SSH agent socket or keys to expose to the build (format: default|<id>[=<socket>|<key>[,<key>]]) |
|
||||||
|
| [`-t`](https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t), [`--tag stringArray`](https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t) | Name and optionally a tag in the 'name:tag' format |
|
||||||
|
| [`--target string`](https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target) | Set the target build stage to build. |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The `buildx build` command starts a build using BuildKit. This command is similar
|
||||||
|
to the UI of `docker build` command and takes the same flags and arguments.
|
||||||
|
|
||||||
|
For documentation on most of these flags refer to the [`docker build`
|
||||||
|
documentation](https://docs.docker.com/engine/reference/commandline/build/). In
|
||||||
|
here we’ll document a subset of the new flags.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### <a name="platform"></a> Set the target platforms for the build (--platform)
|
||||||
|
|
||||||
|
```
|
||||||
|
--platform=value[,value]
|
||||||
|
```
|
||||||
|
|
||||||
|
Set the target platform for the build. All `FROM` commands inside the Dockerfile
|
||||||
|
without their own `--platform` flag will pull base images for this platform and
|
||||||
|
this value will also be the platform of the resulting image. The default value
|
||||||
|
will be the current platform of the buildkit daemon.
|
||||||
|
|
||||||
|
When using `docker-container` driver with `buildx`, this flag can accept multiple
|
||||||
|
values as an input separated by a comma. With multiple values the result will be
|
||||||
|
built for all of the specified platforms and joined together into a single manifest
|
||||||
|
list.
|
||||||
|
|
||||||
|
If the`Dockerfile` needs to invoke the `RUN` command, the builder needs runtime
|
||||||
|
support for the specified platform. In a clean setup, you can only execute `RUN`
|
||||||
|
commands for your system architecture.
|
||||||
|
If your kernel supports [`binfmt_misc`](https://en.wikipedia.org/wiki/Binfmt_misc)
|
||||||
|
launchers for secondary architectures buildx will pick them up automatically.
|
||||||
|
Docker desktop releases come with binfmt_misc automatically configured for `arm64`
|
||||||
|
and `arm` architectures. You can see what runtime platforms your current builder
|
||||||
|
instance supports by running `docker buildx inspect --bootstrap`.
|
||||||
|
|
||||||
|
Inside a `Dockerfile`, you can access the current platform value through
|
||||||
|
`TARGETPLATFORM` build argument. Please refer to the [`docker build`
|
||||||
|
documentation](https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope)
|
||||||
|
for the full description of automatic platform argument variants .
|
||||||
|
|
||||||
|
The formatting for the platform specifier is defined in the [containerd source
|
||||||
|
code](https://github.com/containerd/containerd/blob/v1.4.3/platforms/platforms.go#L63).
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx build --platform=linux/arm64 .
|
||||||
|
$ docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v7 .
|
||||||
|
$ docker buildx build --platform=darwin .
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="output"></a> Set the export action for the build result (-o, --output)
|
||||||
|
|
||||||
|
```
|
||||||
|
-o, --output=[PATH,-,type=TYPE[,KEY=VALUE]
|
||||||
|
```
|
||||||
|
|
||||||
|
Sets the export action for the build result. In `docker build` all builds finish
|
||||||
|
by creating a container image and exporting it to `docker images`. `buildx` makes
|
||||||
|
this step configurable allowing results to be exported directly to the client,
|
||||||
|
oci image tarballs, registry etc.
|
||||||
|
|
||||||
|
Buildx with `docker` driver currently only supports local, tarball exporter and
|
||||||
|
image exporter. `docker-container` driver supports all the exporters.
|
||||||
|
|
||||||
|
If just the path is specified as a value, `buildx` will use the local exporter
|
||||||
|
with this path as the destination. If the value is "-", `buildx` will use `tar`
|
||||||
|
exporter and write to `stdout`.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx build -o . .
|
||||||
|
$ docker buildx build -o outdir .
|
||||||
|
$ docker buildx build -o - - > out.tar
|
||||||
|
$ docker buildx build -o type=docker .
|
||||||
|
$ docker buildx build -o type=docker,dest=- . > myimage.tar
|
||||||
|
$ docker buildx build -t tonistiigi/foo -o type=registry
|
||||||
|
```
|
||||||
|
|
||||||
|
Supported exported types are:
|
||||||
|
|
||||||
|
#### `local`
|
||||||
|
|
||||||
|
The `local` export type writes all result files to a directory on the client. The
|
||||||
|
new files will be owned by the current user. On multi-platform builds, all results
|
||||||
|
will be put in subdirectories by their platform.
|
||||||
|
|
||||||
|
Attribute key:
|
||||||
|
|
||||||
|
- `dest` - destination directory where files will be written
|
||||||
|
|
||||||
|
#### `tar`
|
||||||
|
|
||||||
|
The `tar` export type writes all result files as a single tarball on the client.
|
||||||
|
On multi-platform builds all results will be put in subdirectories by their platform.
|
||||||
|
|
||||||
|
Attribute key:
|
||||||
|
|
||||||
|
- `dest` - destination path where tarball will be written. “-” writes to stdout.
|
||||||
|
|
||||||
|
#### `oci`
|
||||||
|
|
||||||
|
The `oci` export type writes the result image or manifest list as an [OCI image
|
||||||
|
layout](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-layout.md)
|
||||||
|
tarball on the client.
|
||||||
|
|
||||||
|
Attribute key:
|
||||||
|
|
||||||
|
- `dest` - destination path where tarball will be written. “-” writes to stdout.
|
||||||
|
|
||||||
|
#### `docker`
|
||||||
|
|
||||||
|
The `docker` export type writes the single-platform result image as a [Docker image
|
||||||
|
specification](https://github.com/docker/docker/blob/v20.10.2/image/spec/v1.2.md)
|
||||||
|
tarball on the client. Tarballs created by this exporter are also OCI compatible.
|
||||||
|
|
||||||
|
Currently, multi-platform images cannot be exported with the `docker` export type.
|
||||||
|
The most common usecase for multi-platform images is to directly push to a registry
|
||||||
|
(see [`registry`](#registry)).
|
||||||
|
|
||||||
|
Attribute keys:
|
||||||
|
|
||||||
|
- `dest` - destination path where tarball will be written. If not specified the
|
||||||
|
tar will be loaded automatically to the current docker instance.
|
||||||
|
- `context` - name for the docker context where to import the result
|
||||||
|
|
||||||
|
#### `image`
|
||||||
|
|
||||||
|
The `image` exporter writes the build result as an image or a manifest list. When
|
||||||
|
using `docker` driver the image will appear in `docker images`. Optionally image
|
||||||
|
can be automatically pushed to a registry by specifying attributes.
|
||||||
|
|
||||||
|
Attribute keys:
|
||||||
|
|
||||||
|
- `name` - name (references) for the new image.
|
||||||
|
- `push` - boolean to automatically push the image.
|
||||||
|
|
||||||
|
#### `registry`
|
||||||
|
|
||||||
|
The `registry` exporter is a shortcut for `type=image,push=true`.
|
||||||
|
|
||||||
|
|
||||||
|
### <a name="push"></a> Push the build result to a registry (--push)
|
||||||
|
|
||||||
|
Shorthand for [`--output=type=registry`](#registry). Will automatically push the
|
||||||
|
build result to registry.
|
||||||
|
|
||||||
|
### <a name="load"></a> Load the single-platform build result to `docker images` (--load)
|
||||||
|
|
||||||
|
Shorthand for [`--output=type=docker`](#docker). Will automatically load the
|
||||||
|
single-platform build result to `docker images`.
|
||||||
|
|
||||||
|
### <a name="cache-from"></a> Use an external cache source for a build (--cache-from)
|
||||||
|
|
||||||
|
```
|
||||||
|
--cache-from=[NAME|type=TYPE[,KEY=VALUE]]
|
||||||
|
```
|
||||||
|
|
||||||
|
Use an external cache source for a build. Supported types are `registry` and `local`.
|
||||||
|
The `registry` source can import cache from a cache manifest or (special) image
|
||||||
|
configuration on the registry. The `local` source can import cache from local
|
||||||
|
files previously exported with `--cache-to`.
|
||||||
|
|
||||||
|
If no type is specified, `registry` exporter is used with a specified reference.
|
||||||
|
|
||||||
|
`docker` driver currently only supports importing build cache from the registry.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx build --cache-from=user/app:cache .
|
||||||
|
$ docker buildx build --cache-from=user/app .
|
||||||
|
$ docker buildx build --cache-from=type=registry,ref=user/app .
|
||||||
|
$ docker buildx build --cache-from=type=local,src=path/to/cache .
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="cache-to"></a> Export build cache to an external cache destination (--cache-to)
|
||||||
|
|
||||||
|
```
|
||||||
|
--cache-to=[NAME|type=TYPE[,KEY=VALUE]]
|
||||||
|
```
|
||||||
|
|
||||||
|
Export build cache to an external cache destination. Supported types are `registry`,
|
||||||
|
`local` and `inline`. Registry exports build cache to a cache manifest in the
|
||||||
|
registry, local exports cache to a local directory on the client and inline writes
|
||||||
|
the cache metadata into the image configuration.
|
||||||
|
|
||||||
|
`docker` driver currently only supports exporting inline cache metadata to image
|
||||||
|
configuration. Alternatively, `--build-arg BUILDKIT_INLINE_CACHE=1` can be used
|
||||||
|
to trigger inline cache exporter.
|
||||||
|
|
||||||
|
Attribute key:
|
||||||
|
|
||||||
|
- `mode` - Specifies how many layers are exported with the cache. “min” on only
|
||||||
|
exports layers already in the final build stage, “max” exports layers for
|
||||||
|
all stages. Metadata is always exported for the whole build.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx build --cache-to=user/app:cache .
|
||||||
|
$ docker buildx build --cache-to=type=inline .
|
||||||
|
$ docker buildx build --cache-to=type=registry,ref=user/app .
|
||||||
|
$ docker buildx build --cache-to=type=local,dest=path/to/cache .
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="allow"></a> Allow extra privileged entitlement (--allow)
|
||||||
|
|
||||||
|
```
|
||||||
|
--allow=ENTITLEMENT
|
||||||
|
```
|
||||||
|
|
||||||
|
Allow extra privileged entitlement. List of entitlements:
|
||||||
|
|
||||||
|
- `network.host` - Allows executions with host networking.
|
||||||
|
- `security.insecure` - Allows executions without sandbox. See
|
||||||
|
[related Dockerfile extensions](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/experimental.md#run---securityinsecuresandbox).
|
||||||
|
|
||||||
|
For entitlements to be enabled, the `buildkitd` daemon also needs to allow them
|
||||||
|
with `--allow-insecure-entitlement` (see [`create --buildkitd-flags`](buildx_create.md#--buildkitd-flags-flags))
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx create --use --name insecure-builder --buildkitd-flags '--allow-insecure-entitlement security.insecure'
|
||||||
|
$ docker buildx build --allow security.insecure .
|
||||||
|
```
|
||||||
185
docs/reference/buildx_create.md
Normal file
185
docs/reference/buildx_create.md
Normal file
@@ -0,0 +1,185 @@
|
|||||||
|
# buildx create
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx create [OPTIONS] [CONTEXT|ENDPOINT]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Create a new builder instance
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`--append`](#append) | Append a node to builder instead of changing it |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| [`--buildkitd-flags string`](#buildkitd-flags) | Flags for buildkitd daemon |
|
||||||
|
| [`--config string`](#config) | BuildKit config file |
|
||||||
|
| [`--driver string`](#driver) | Driver to use (available: []) |
|
||||||
|
| [`--driver-opt stringArray`](#driver-opt) | Options for the driver |
|
||||||
|
| [`--leave`](#leave) | Remove a node from builder instead of changing it |
|
||||||
|
| [`--name string`](#name) | Builder instance name |
|
||||||
|
| [`--node string`](#node) | Create/modify node with given name |
|
||||||
|
| [`--platform stringArray`](#platform) | Fixed platforms for current node |
|
||||||
|
| [`--use`](#use) | Set the current builder instance |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
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
|
||||||
|
the address for docker socket (eg. `DOCKER_HOST` value).
|
||||||
|
|
||||||
|
By default, the current docker configuration is used for determining the
|
||||||
|
context/endpoint value.
|
||||||
|
|
||||||
|
Builder instances are isolated environments where builds can be invoked. All
|
||||||
|
docker contexts also get the default builder instance.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### <a name="append"></a> Append a new node to an existing builder (--append)
|
||||||
|
|
||||||
|
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
|
||||||
|
for a build based on the platforms it supports.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx create mycontext1
|
||||||
|
eager_beaver
|
||||||
|
|
||||||
|
$ docker buildx create --name eager_beaver --append mycontext2
|
||||||
|
eager_beaver
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="buildkitd-flags"></a> Specify options for the buildkitd daemon (--buildkitd-flags)
|
||||||
|
|
||||||
|
```
|
||||||
|
--buildkitd-flags FLAGS
|
||||||
|
```
|
||||||
|
|
||||||
|
Adds flags when starting the buildkitd daemon. They take precedence over the
|
||||||
|
configuration file specified by [`--config`](#--config-file). See `buildkitd --help`
|
||||||
|
for the available flags.
|
||||||
|
|
||||||
|
**Example**
|
||||||
|
|
||||||
|
```
|
||||||
|
--buildkitd-flags '--debug --debugaddr 0.0.0.0:6666'
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="config"></a> Specify a configuration file for the buildkitd daemon (--config)
|
||||||
|
|
||||||
|
```
|
||||||
|
--config FILE
|
||||||
|
```
|
||||||
|
|
||||||
|
Specifies the configuration file for the buildkitd daemon to use. The configuration
|
||||||
|
can be overridden by [`--buildkitd-flags`](#--buildkitd-flags-flags).
|
||||||
|
See an [example buildkitd configuration file](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md).
|
||||||
|
|
||||||
|
### <a name="driver"></a> Set the builder driver to use (--driver)
|
||||||
|
|
||||||
|
```
|
||||||
|
--driver DRIVER
|
||||||
|
```
|
||||||
|
|
||||||
|
Sets the builder driver to be used. There are two available drivers, each have
|
||||||
|
their own specificities.
|
||||||
|
|
||||||
|
- `docker` - 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.
|
||||||
|
- `docker-container` - Uses a buildkit container that will be spawned via docker.
|
||||||
|
With this driver, both building multi-platform images and exporting cache are
|
||||||
|
supported. However, images built will not automatically appear in `docker images`
|
||||||
|
(see [`build --load`](buildx_build.md#--load)).
|
||||||
|
- `kubernetes` - Uses a kubernetes pods. With this driver, you can spin up pods
|
||||||
|
with defined buildkit container image to build your images.
|
||||||
|
|
||||||
|
|
||||||
|
### <a name="driver-opt"></a> Set additional driver-specific options (--driver-opt)
|
||||||
|
|
||||||
|
```
|
||||||
|
--driver-opt OPTIONS
|
||||||
|
```
|
||||||
|
|
||||||
|
Passes additional driver-specific options. Details for each driver:
|
||||||
|
|
||||||
|
- `docker` - No driver options
|
||||||
|
- `docker-container`
|
||||||
|
- `image=IMAGE` - Sets the container image to be used for running buildkit.
|
||||||
|
- `network=NETMODE` - Sets the network mode for running the buildkit container.
|
||||||
|
- Example:
|
||||||
|
|
||||||
|
```console
|
||||||
|
--driver docker-container --driver-opt image=moby/buildkit:master,network=host
|
||||||
|
```
|
||||||
|
- `kubernetes`
|
||||||
|
- `image=IMAGE` - Sets the container image to be used for running buildkit.
|
||||||
|
- `namespace=NS` - Sets the Kubernetes namespace. Defaults to the current namespace.
|
||||||
|
- `replicas=N` - Sets the number of `Pod` replicas. Defaults to 1.
|
||||||
|
- `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.
|
||||||
|
- `loadbalance=(sticky|random)` - Load-balancing strategy. If set to "sticky", the pod is chosen using the hash of the context path. Defaults to "sticky"
|
||||||
|
|
||||||
|
### <a name="leave"></a> Remove a node from a builder (--leave)
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx create --name mybuilder --node mybuilder0 --leave
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="name"></a> Specify the name of the builder (--name)
|
||||||
|
|
||||||
|
```
|
||||||
|
--name NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
The `--name` flag specifies the name of the builder to be created or modified.
|
||||||
|
If none is specified, one will be automatically generated.
|
||||||
|
|
||||||
|
### <a name="node"></a> Specify the name of the node (--node)
|
||||||
|
|
||||||
|
```
|
||||||
|
--node NODE
|
||||||
|
```
|
||||||
|
|
||||||
|
The `--node` flag specifies the name of the node to be created or modified. If
|
||||||
|
none is specified, it is the name of the builder it belongs to, with an index
|
||||||
|
number suffix.
|
||||||
|
|
||||||
|
### <a name="platform"></a> Set the platforms supported by the node
|
||||||
|
|
||||||
|
```
|
||||||
|
--platform PLATFORMS
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx create --platform linux/amd64
|
||||||
|
$ docker buildx create --platform linux/arm64,linux/arm/v8
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="use"></a> Automatically switch to the newly created builder
|
||||||
|
|
||||||
|
The `--use` flag automatically switches the current builder to the newly created
|
||||||
|
one. Equivalent to running `docker buildx use $(docker buildx create ...)`.
|
||||||
19
docs/reference/buildx_du.md
Normal file
19
docs/reference/buildx_du.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# buildx du
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx du
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Disk usage
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| `--filter filter` | Provide filter values |
|
||||||
|
| `--verbose` | Provide a more verbose output |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
24
docs/reference/buildx_imagetools.md
Normal file
24
docs/reference/buildx_imagetools.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# buildx imagetools
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx imagetools [OPTIONS] COMMAND
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Commands to work on images in registry
|
||||||
|
|
||||||
|
### Subcommands
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`create`](buildx_imagetools_create.md) | Create a new image based on source images |
|
||||||
|
| [`inspect`](buildx_imagetools_inspect.md) | Show details of image in the registry |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Imagetools contains commands for working with manifest lists in the registry.
|
||||||
|
These commands are useful for inspecting multi-platform build results.
|
||||||
67
docs/reference/buildx_imagetools_create.md
Normal file
67
docs/reference/buildx_imagetools_create.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
# buildx imagetools create
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Create a new image based on source images
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`--append`](#append) | Append to existing manifest |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| [`--dry-run`](#dry-run) | Show final image instead of pushing |
|
||||||
|
| [`-f`](#file), [`--file stringArray`](#file) | Read source descriptor from file |
|
||||||
|
| [`-t`](#tag), [`--tag stringArray`](#tag) | Set reference for new image |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Imagetools contains commands for working with manifest lists in the registry.
|
||||||
|
These commands are useful for inspecting multi-platform build results.
|
||||||
|
|
||||||
|
Create creates a new manifest list based on source manifests. The source
|
||||||
|
manifests can 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 specified create performs a carbon copy.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### <a name="append"></a> Append new sources to an existing manifest list (--append)
|
||||||
|
|
||||||
|
Use the `--append` flag to append the new sources to an existing manifest list
|
||||||
|
in the destination.
|
||||||
|
|
||||||
|
### <a name="dry-run"></a> Show final image instead of pushing (--dry-run)
|
||||||
|
|
||||||
|
Use the `--dry-run` flag to not push the image, just show it.
|
||||||
|
|
||||||
|
### <a name="file"></a> Read source descriptor from a file (-f, --file)
|
||||||
|
|
||||||
|
```
|
||||||
|
-f FILE or --file FILE
|
||||||
|
```
|
||||||
|
|
||||||
|
Reads source from files. A source can be a manifest digest, manifest reference,
|
||||||
|
or a JSON of OCI descriptor object.
|
||||||
|
|
||||||
|
### <a name="tag"></a> Set reference for new image (-t, --tag)
|
||||||
|
|
||||||
|
```
|
||||||
|
-t IMAGE or --tag IMAGE
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the `-t` or `--tag` flag to set the name of the image to be created.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx imagetools create --dry-run alpine@sha256:5c40b3c27b9f13c873fefb2139765c56ce97fd50230f1f2d5c91e55dec171907 sha256:c4ba6347b0e4258ce6a6de2401619316f982b7bcc529f73d2a410d0097730204
|
||||||
|
|
||||||
|
$ docker buildx imagetools create -t tonistiigi/myapp -f image1 -f image2
|
||||||
|
```
|
||||||
47
docs/reference/buildx_imagetools_inspect.md
Normal file
47
docs/reference/buildx_imagetools_inspect.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# buildx imagetools inspect
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx imagetools inspect [OPTIONS] NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Show details of image in the registry
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| [`--raw`](#raw) | Show original JSON manifest |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Show details of image in the registry.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx imagetools inspect alpine
|
||||||
|
|
||||||
|
Name: docker.io/library/alpine:latest
|
||||||
|
MediaType: application/vnd.docker.distribution.manifest.list.v2+json
|
||||||
|
Digest: sha256:28ef97b8686a0b5399129e9b763d5b7e5ff03576aa5580d6f4182a49c5fe1913
|
||||||
|
|
||||||
|
Manifests:
|
||||||
|
Name: docker.io/library/alpine:latest@sha256:5c40b3c27b9f13c873fefb2139765c56ce97fd50230f1f2d5c91e55dec171907
|
||||||
|
MediaType: application/vnd.docker.distribution.manifest.v2+json
|
||||||
|
Platform: linux/amd64
|
||||||
|
|
||||||
|
Name: docker.io/library/alpine:latest@sha256:c4ba6347b0e4258ce6a6de2401619316f982b7bcc529f73d2a410d0097730204
|
||||||
|
MediaType: application/vnd.docker.distribution.manifest.v2+json
|
||||||
|
Platform: linux/arm/v6
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="raw"></a> Show original, unformatted JSON manifest (--raw)
|
||||||
|
|
||||||
|
Use the `--raw` option to print the original JSON bytes instead of the formatted
|
||||||
|
output.
|
||||||
58
docs/reference/buildx_inspect.md
Normal file
58
docs/reference/buildx_inspect.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
# buildx inspect
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx inspect [NAME]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Inspect current builder instance
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`--bootstrap`](#bootstrap) | Ensure builder has booted before inspecting |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Shows information about the current or specified builder.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Get information about a builder instance
|
||||||
|
|
||||||
|
By default, `inspect` shows information about the current builder. Specify the
|
||||||
|
name of the builder to inspect to get information about that builder.
|
||||||
|
The following example shows information about a builder instance named
|
||||||
|
`elated_tesla`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx inspect elated_tesla
|
||||||
|
|
||||||
|
Name: elated_tesla
|
||||||
|
Driver: docker-container
|
||||||
|
|
||||||
|
Nodes:
|
||||||
|
Name: elated_tesla0
|
||||||
|
Endpoint: unix:///var/run/docker.sock
|
||||||
|
Status: running
|
||||||
|
Platforms: linux/amd64
|
||||||
|
|
||||||
|
Name: elated_tesla1
|
||||||
|
Endpoint: ssh://ubuntu@1.2.3.4
|
||||||
|
Status: running
|
||||||
|
Platforms: linux/arm64, linux/arm/v7, linux/arm/v6
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a name="bootstrap"></a> Ensure that the builder is running before inspecting (--bootstrap)
|
||||||
|
|
||||||
|
Use the `--bootstrap` option to ensures that the builder is running before
|
||||||
|
inspecting it. If the driver is `docker-container`, then `--bootstrap` starts
|
||||||
|
the buildkit container and waits until it is operational. Bootstrapping is
|
||||||
|
automatically done during build, it is thus not necessary. The same BuildKit
|
||||||
|
container is used during the lifetime of the associated builder node (as
|
||||||
|
displayed in `buildx ls`).
|
||||||
11
docs/reference/buildx_install.md
Normal file
11
docs/reference/buildx_install.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# buildx install
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx install
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Install buildx as a 'docker builder' alias
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
31
docs/reference/buildx_ls.md
Normal file
31
docs/reference/buildx_ls.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# buildx ls
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx ls
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
List builder instances
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Lists all builder instances and the nodes for each instance
|
||||||
|
|
||||||
|
**Example**
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx ls
|
||||||
|
|
||||||
|
NAME/NODE DRIVER/ENDPOINT STATUS PLATFORMS
|
||||||
|
elated_tesla * docker-container
|
||||||
|
elated_tesla0 unix:///var/run/docker.sock running linux/amd64
|
||||||
|
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 `*`.
|
||||||
23
docs/reference/buildx_prune.md
Normal file
23
docs/reference/buildx_prune.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# buildx prune
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx prune
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Remove build cache
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `-a`, `--all` | Remove all unused images, not just dangling ones |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| `--filter filter` | Provide filter values (e.g. 'until=24h') |
|
||||||
|
| `-f`, `--force` | Do not prompt for confirmation |
|
||||||
|
| `--keep-storage bytes` | Amount of disk space to keep for cache |
|
||||||
|
| `--verbose` | Provide a more verbose output |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
16
docs/reference/buildx_rm.md
Normal file
16
docs/reference/buildx_rm.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# buildx rm
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx rm [NAME]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Remove a builder instance
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Removes the specified or current builder. It is a no-op attempting to remove the
|
||||||
|
default builder.
|
||||||
16
docs/reference/buildx_stop.md
Normal file
16
docs/reference/buildx_stop.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# buildx stop
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx stop [NAME]
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Stop builder instance
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Stops the specified or current builder. This will not prevent buildx build to
|
||||||
|
restart the builder. The implementation of stop depends on the driver.
|
||||||
11
docs/reference/buildx_uninstall.md
Normal file
11
docs/reference/buildx_uninstall.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# buildx uninstall
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx uninstall
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Uninstall the 'docker builder' alias
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
25
docs/reference/buildx_use.md
Normal file
25
docs/reference/buildx_use.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# buildx use
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx use [OPTIONS] NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Set the current builder instance
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `--builder string` | Override the configured builder instance |
|
||||||
|
| `--default` | Set builder as default for current context |
|
||||||
|
| `--global` | Builder persists context changes |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
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
|
||||||
|
switch to the default builder of that context.
|
||||||
21
docs/reference/buildx_version.md
Normal file
21
docs/reference/buildx_version.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# buildx version
|
||||||
|
|
||||||
|
```
|
||||||
|
docker buildx version
|
||||||
|
```
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
Show buildx version information
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### View version information
|
||||||
|
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker buildx version
|
||||||
|
github.com/docker/buildx v0.5.1-docker 11057da37336192bfc57d81e02359ba7ba848e4a
|
||||||
|
```
|
||||||
29
hack/dockerfiles/docs.Dockerfile
Normal file
29
hack/dockerfiles/docs.Dockerfile
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# syntax = docker/dockerfile:1.2
|
||||||
|
|
||||||
|
FROM golang:1.16-alpine AS docsgen
|
||||||
|
WORKDIR /src
|
||||||
|
RUN --mount=target=. \
|
||||||
|
--mount=target=/root/.cache,type=cache \
|
||||||
|
go build -mod=vendor -o /out/docsgen ./docs/docsgen
|
||||||
|
|
||||||
|
FROM alpine AS gen
|
||||||
|
RUN apk add --no-cache rsync git
|
||||||
|
WORKDIR /src
|
||||||
|
COPY --from=docsgen /out/docsgen /usr/bin
|
||||||
|
RUN --mount=target=/context \
|
||||||
|
--mount=target=.,type=tmpfs,readwrite \
|
||||||
|
rsync -a /context/. . && \
|
||||||
|
docsgen && \
|
||||||
|
mkdir /out && cp -r docs/reference /out
|
||||||
|
|
||||||
|
FROM scratch AS update
|
||||||
|
COPY --from=gen /out /out
|
||||||
|
|
||||||
|
FROM gen AS validate
|
||||||
|
RUN --mount=target=/context \
|
||||||
|
--mount=target=.,type=tmpfs,readwrite \
|
||||||
|
rsync -a /context/. . && \
|
||||||
|
git add -A && \
|
||||||
|
rm -rf docs/reference/* && \
|
||||||
|
cp -rf /out/* ./docs/ && \
|
||||||
|
./hack/validate-docs check
|
||||||
16
hack/update-docs
Executable file
16
hack/update-docs
Executable file
@@ -0,0 +1,16 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
. $(dirname $0)/util
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
output=$(mktemp -d -t buildx-output.XXXXXXXXXX)
|
||||||
|
|
||||||
|
buildxCmd build \
|
||||||
|
--target "update" \
|
||||||
|
--output "type=local,dest=$output" \
|
||||||
|
--file "./hack/dockerfiles/docs.Dockerfile" \
|
||||||
|
.
|
||||||
|
|
||||||
|
rm -rf ./docs/reference/*
|
||||||
|
cp -R "$output"/out/* ./docs/
|
||||||
|
rm -rf $output
|
||||||
29
hack/validate-docs
Executable file
29
hack/validate-docs
Executable file
@@ -0,0 +1,29 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
case ${1:-} in
|
||||||
|
'')
|
||||||
|
. $(dirname $0)/util
|
||||||
|
buildxCmd build \
|
||||||
|
--target validate \
|
||||||
|
--file ./hack/dockerfiles/docs.Dockerfile \
|
||||||
|
.
|
||||||
|
;;
|
||||||
|
check)
|
||||||
|
status="$(git status --porcelain -- docs/reference 2>/dev/null)"
|
||||||
|
diffs=$(echo "$status" | grep -v '^[RAD] ' || true)
|
||||||
|
if [ "$diffs" ]; then
|
||||||
|
{
|
||||||
|
set +x
|
||||||
|
echo 'The result of ./hack/update-docs differs'
|
||||||
|
echo
|
||||||
|
echo "$diffs"
|
||||||
|
echo
|
||||||
|
echo 'Please vendor your package with ./hack/update-docs'
|
||||||
|
echo
|
||||||
|
} >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo 'Congratulations! All docs changes are done the right way.'
|
||||||
|
;;
|
||||||
|
esac
|
||||||
Reference in New Issue
Block a user