From 68c3ac4f66f7847b47f926e5d44f707d391f9a5b Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 11 Jan 2024 17:35:23 +0100 Subject: [PATCH] docs: update link to `docker build` reference Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- commands/build.go | 10 ++-- docs/bake-reference.md | 8 +-- docs/reference/buildx_build.md | 80 ++++++++++++++-------------- docs/reference/buildx_debug_build.md | 76 +++++++++++++------------- 4 files changed, 87 insertions(+), 87 deletions(-) diff --git a/commands/build.go b/commands/build.go index 2cbf8fb6c2f..a13446845b7 100644 --- a/commands/build.go +++ b/commands/build.go @@ -502,7 +502,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions, debugConfig *debug.D flags := cmd.Flags() flags.StringSliceVar(&options.extraHosts, "add-host", []string{}, `Add a custom host-to-IP mapping (format: "host:ip")`) - flags.SetAnnotation("add-host", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#add-host"}) + flags.SetAnnotation("add-host", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/image_build/#add-host"}) flags.StringSliceVar(&options.allow, "allow", []string{}, `Allow extra privileged entitlement (e.g., "network.host", "security.insecure")`) @@ -515,12 +515,12 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions, debugConfig *debug.D flags.StringArrayVar(&options.cacheTo, "cache-to", []string{}, `Cache export destinations (e.g., "user/app:cache", "type=local,dest=path/to/dir")`) flags.StringVar(&options.cgroupParent, "cgroup-parent", "", `Set the parent cgroup for the "RUN" instructions during build`) - flags.SetAnnotation("cgroup-parent", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#cgroup-parent"}) + flags.SetAnnotation("cgroup-parent", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/image_build/#cgroup-parent"}) flags.StringArrayVar(&options.contexts, "build-context", []string{}, "Additional build contexts (e.g., name=path)") flags.StringVarP(&options.dockerfileName, "file", "f", "", `Name of the Dockerfile (default: "PATH/Dockerfile")`) - flags.SetAnnotation("file", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#file"}) + flags.SetAnnotation("file", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/image_build/#file"}) flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID to the file") @@ -552,10 +552,10 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions, debugConfig *debug.D flags.StringArrayVar(&options.ssh, "ssh", []string{}, `SSH agent socket or keys to expose to the build (format: "default|[=|[,]]")`) flags.StringArrayVarP(&options.tags, "tag", "t", []string{}, `Name and optionally a tag (format: "name:tag")`) - flags.SetAnnotation("tag", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#tag"}) + flags.SetAnnotation("tag", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/image_build/#tag"}) flags.StringVar(&options.target, "target", "", "Set the target build stage to build") - flags.SetAnnotation("target", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#target"}) + flags.SetAnnotation("target", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/image_build/#target"}) options.ulimits = dockeropts.NewUlimitOpt(nil) flags.Var(options.ulimits, "ulimit", "Ulimit options") diff --git a/docs/bake-reference.md b/docs/bake-reference.md index 50cf90f9d0a..afe87d4ba9f 100644 --- a/docs/bake-reference.md +++ b/docs/bake-reference.md @@ -1069,13 +1069,13 @@ target "webapp-dev" { [attestations]: https://docs.docker.com/build/attestations/ [bake_stdlib]: https://github.com/docker/buildx/blob/master/bake/hclparser/stdlib.go -[build-arg]: https://docs.docker.com/engine/reference/commandline/build/#build-arg +[build-arg]: https://docs.docker.com/engine/reference/commandline/image_build/#build-arg [build-context]: https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context [cache-backends]: https://docs.docker.com/build/cache/backends/ [cache-from]: https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-from [cache-to]: https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-to [context]: https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context -[file]: https://docs.docker.com/engine/reference/commandline/build/#file +[file]: https://docs.docker.com/engine/reference/commandline/image_build/#file [go-cty]: https://github.com/zclconf/go-cty/tree/main/cty/function/stdlib [hcl-funcs]: https://docs.docker.com/build/bake/hcl-funcs/ [output]: https://docs.docker.com/engine/reference/commandline/buildx_build/#output @@ -1083,6 +1083,6 @@ target "webapp-dev" { [run_mount_secret]: https://docs.docker.com/engine/reference/builder/#run---mounttypesecret [secret]: https://docs.docker.com/engine/reference/commandline/buildx_build/#secret [ssh]: https://docs.docker.com/engine/reference/commandline/buildx_build/#ssh -[tag]: https://docs.docker.com/engine/reference/commandline/build/#tag -[target]: https://docs.docker.com/engine/reference/commandline/build/#target +[tag]: https://docs.docker.com/engine/reference/commandline/image_build/#tag +[target]: https://docs.docker.com/engine/reference/commandline/image_build/#target [userfunc]: https://github.com/hashicorp/hcl/tree/main/ext/userfunc diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md index 5d4e916e153..0b053b7f58a 100644 --- a/docs/reference/buildx_build.md +++ b/docs/reference/buildx_build.md @@ -13,44 +13,44 @@ Start a build ### Options -| Name | Type | Default | Description | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| -| [`--add-host`](https://docs.docker.com/engine/reference/commandline/build/#add-host) | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | -| [`--allow`](#allow) | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | -| [`--annotation`](#annotation) | `stringArray` | | Add annotation to the image | -| [`--attest`](#attest) | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | -| [`--build-arg`](#build-arg) | `stringArray` | | Set build-time variables | -| [`--build-context`](#build-context) | `stringArray` | | Additional build contexts (e.g., name=path) | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| [`--cache-from`](#cache-from) | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | -| [`--cache-to`](#cache-to) | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | -| [`--cgroup-parent`](https://docs.docker.com/engine/reference/commandline/build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--detach` | | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | -| [`-f`](https://docs.docker.com/engine/reference/commandline/build/#file), [`--file`](https://docs.docker.com/engine/reference/commandline/build/#file) | `string` | | Name of the Dockerfile (default: `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` | -| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to the file | -| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build | -| `--no-cache` | | | Do not use cache when building the image | -| [`--no-cache-filter`](#no-cache-filter) | `stringArray` | | Do not cache specified stages | -| [`-o`](#output), [`--output`](#output) | `stringArray` | | Output destination (format: `type=local,dest=path`) | -| [`--platform`](#platform) | `stringArray` | | Set target platform for build | -| `--print` | `string` | | Print result of information request (e.g., outline, targets) (EXPERIMENTAL) | -| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output | -| [`--provenance`](#provenance) | `string` | | Shorthand for `--attest=type=provenance` | -| `--pull` | | | Always attempt to pull all referenced images | -| [`--push`](#push) | | | Shorthand for `--output=type=registry` | -| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | -| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | -| [`--sbom`](#sbom) | `string` | | Shorthand for `--attest=type=sbom` | -| [`--secret`](#secret) | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | -| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | -| [`--shm-size`](#shm-size) | `bytes` | `0` | Size of `/dev/shm` | -| [`--ssh`](#ssh) | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | -| [`-t`](https://docs.docker.com/engine/reference/commandline/build/#tag), [`--tag`](https://docs.docker.com/engine/reference/commandline/build/#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | -| [`--target`](https://docs.docker.com/engine/reference/commandline/build/#target) | `string` | | Set the target build stage to build | -| [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | +| Name | Type | Default | Description | +|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| +| [`--add-host`](https://docs.docker.com/engine/reference/commandline/image_build/#add-host) | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | +| [`--allow`](#allow) | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | +| [`--annotation`](#annotation) | `stringArray` | | Add annotation to the image | +| [`--attest`](#attest) | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | +| [`--build-arg`](#build-arg) | `stringArray` | | Set build-time variables | +| [`--build-context`](#build-context) | `stringArray` | | Additional build contexts (e.g., name=path) | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| [`--cache-from`](#cache-from) | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | +| [`--cache-to`](#cache-to) | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | +| [`--cgroup-parent`](https://docs.docker.com/engine/reference/commandline/image_build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | +| `--detach` | | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | +| [`-f`](https://docs.docker.com/engine/reference/commandline/image_build/#file), [`--file`](https://docs.docker.com/engine/reference/commandline/image_build/#file) | `string` | | Name of the Dockerfile (default: `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` | +| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to the file | +| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build | +| `--no-cache` | | | Do not use cache when building the image | +| [`--no-cache-filter`](#no-cache-filter) | `stringArray` | | Do not cache specified stages | +| [`-o`](#output), [`--output`](#output) | `stringArray` | | Output destination (format: `type=local,dest=path`) | +| [`--platform`](#platform) | `stringArray` | | Set target platform for build | +| `--print` | `string` | | Print result of information request (e.g., outline, targets) (EXPERIMENTAL) | +| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output | +| [`--provenance`](#provenance) | `string` | | Shorthand for `--attest=type=provenance` | +| `--pull` | | | Always attempt to pull all referenced images | +| [`--push`](#push) | | | Shorthand for `--output=type=registry` | +| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | +| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | +| [`--sbom`](#sbom) | `string` | | Shorthand for `--attest=type=sbom` | +| [`--secret`](#secret) | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | +| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | +| [`--shm-size`](#shm-size) | `bytes` | `0` | Size of `/dev/shm` | +| [`--ssh`](#ssh) | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | +| [`-t`](https://docs.docker.com/engine/reference/commandline/image_build/#tag), [`--tag`](https://docs.docker.com/engine/reference/commandline/image_build/#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | +| [`--target`](https://docs.docker.com/engine/reference/commandline/image_build/#target) | `string` | | Set the target build stage to build | +| [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | @@ -64,7 +64,7 @@ The `buildx build` command starts a build using BuildKit. This command is simila 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/). +documentation](https://docs.docker.com/engine/reference/commandline/image_build/). This page describes a subset of the new flags. ## Examples @@ -164,7 +164,7 @@ $ docker buildx build --allow security.insecure . ### Set build-time variables (--build-arg) -Same as [`docker build` command](https://docs.docker.com/engine/reference/commandline/build/#build-arg). +Same as [`docker build` command](https://docs.docker.com/engine/reference/commandline/image_build/#build-arg). There are also useful built-in build arguments, such as: diff --git a/docs/reference/buildx_debug_build.md b/docs/reference/buildx_debug_build.md index 78633d92b29..9afdafd96d7 100644 --- a/docs/reference/buildx_debug_build.md +++ b/docs/reference/buildx_debug_build.md @@ -9,44 +9,44 @@ Start a build ### Options -| Name | Type | Default | Description | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| -| [`--add-host`](https://docs.docker.com/engine/reference/commandline/build/#add-host) | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | -| `--allow` | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | -| `--annotation` | `stringArray` | | Add annotation to the image | -| `--attest` | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | -| `--build-arg` | `stringArray` | | Set build-time variables | -| `--build-context` | `stringArray` | | Additional build contexts (e.g., name=path) | -| `--builder` | `string` | | Override the configured builder instance | -| `--cache-from` | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | -| `--cache-to` | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | -| [`--cgroup-parent`](https://docs.docker.com/engine/reference/commandline/build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--detach` | | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | -| [`-f`](https://docs.docker.com/engine/reference/commandline/build/#file), [`--file`](https://docs.docker.com/engine/reference/commandline/build/#file) | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | -| `--iidfile` | `string` | | Write the image ID to the file | -| `--label` | `stringArray` | | Set metadata for an image | -| `--load` | | | Shorthand for `--output=type=docker` | -| `--metadata-file` | `string` | | Write build result metadata to the file | -| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build | -| `--no-cache` | | | Do not use cache when building the image | -| `--no-cache-filter` | `stringArray` | | Do not cache specified stages | -| `-o`, `--output` | `stringArray` | | Output destination (format: `type=local,dest=path`) | -| `--platform` | `stringArray` | | Set target platform for build | -| `--print` | `string` | | Print result of information request (e.g., outline, targets) (EXPERIMENTAL) | -| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output | -| `--provenance` | `string` | | Shorthand for `--attest=type=provenance` | -| `--pull` | | | Always attempt to pull all referenced images | -| `--push` | | | Shorthand for `--output=type=registry` | -| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | -| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | -| `--sbom` | `string` | | Shorthand for `--attest=type=sbom` | -| `--secret` | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | -| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | -| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | -| `--ssh` | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | -| [`-t`](https://docs.docker.com/engine/reference/commandline/build/#tag), [`--tag`](https://docs.docker.com/engine/reference/commandline/build/#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | -| [`--target`](https://docs.docker.com/engine/reference/commandline/build/#target) | `string` | | Set the target build stage to build | -| `--ulimit` | `ulimit` | | Ulimit options | +| Name | Type | Default | Description | +|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| +| [`--add-host`](https://docs.docker.com/engine/reference/commandline/image_build/#add-host) | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | +| `--allow` | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | +| `--annotation` | `stringArray` | | Add annotation to the image | +| `--attest` | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | +| `--build-arg` | `stringArray` | | Set build-time variables | +| `--build-context` | `stringArray` | | Additional build contexts (e.g., name=path) | +| `--builder` | `string` | | Override the configured builder instance | +| `--cache-from` | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | +| `--cache-to` | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | +| [`--cgroup-parent`](https://docs.docker.com/engine/reference/commandline/image_build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | +| `--detach` | | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | +| [`-f`](https://docs.docker.com/engine/reference/commandline/image_build/#file), [`--file`](https://docs.docker.com/engine/reference/commandline/image_build/#file) | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | +| `--iidfile` | `string` | | Write the image ID to the file | +| `--label` | `stringArray` | | Set metadata for an image | +| `--load` | | | Shorthand for `--output=type=docker` | +| `--metadata-file` | `string` | | Write build result metadata to the file | +| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build | +| `--no-cache` | | | Do not use cache when building the image | +| `--no-cache-filter` | `stringArray` | | Do not cache specified stages | +| `-o`, `--output` | `stringArray` | | Output destination (format: `type=local,dest=path`) | +| `--platform` | `stringArray` | | Set target platform for build | +| `--print` | `string` | | Print result of information request (e.g., outline, targets) (EXPERIMENTAL) | +| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output | +| `--provenance` | `string` | | Shorthand for `--attest=type=provenance` | +| `--pull` | | | Always attempt to pull all referenced images | +| `--push` | | | Shorthand for `--output=type=registry` | +| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | +| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | +| `--sbom` | `string` | | Shorthand for `--attest=type=sbom` | +| `--secret` | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | +| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | +| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | +| `--ssh` | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | +| [`-t`](https://docs.docker.com/engine/reference/commandline/image_build/#tag), [`--tag`](https://docs.docker.com/engine/reference/commandline/image_build/#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | +| [`--target`](https://docs.docker.com/engine/reference/commandline/image_build/#target) | `string` | | Set the target build stage to build | +| `--ulimit` | `ulimit` | | Ulimit options |