From ce66d8830da8750d27ab4016d499368f77dbd7ac Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 20 Feb 2024 08:33:48 +0100 Subject: [PATCH 1/2] vendor: github.com/docker/cli-docs-tool v0.7.0 Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- go.mod | 2 +- go.sum | 4 ++-- .../docker/cli-docs-tool/clidocstool_md.go | 4 ++-- vendor/github.com/docker/cli-docs-tool/markdown.go | 13 +++++++++++++ vendor/modules.txt | 2 +- 5 files changed, 19 insertions(+), 6 deletions(-) diff --git a/go.mod b/go.mod index e48edb2d66f..cc2f441714d 100644 --- a/go.mod +++ b/go.mod @@ -14,7 +14,7 @@ require ( github.com/creack/pty v1.1.18 github.com/distribution/reference v0.5.0 github.com/docker/cli v25.0.2+incompatible - github.com/docker/cli-docs-tool v0.6.0 + github.com/docker/cli-docs-tool v0.7.0 github.com/docker/docker v25.0.2+incompatible github.com/docker/go-units v0.5.0 github.com/gofrs/flock v0.8.1 diff --git a/go.sum b/go.sum index 822ec52cb91..1e6b8f044c7 100644 --- a/go.sum +++ b/go.sum @@ -123,8 +123,8 @@ github.com/distribution/reference v0.5.0 h1:/FUIFXtfc/x2gpa5/VGfiGLuOIdYa1t65IKK github.com/distribution/reference v0.5.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E= github.com/docker/cli v25.0.2+incompatible h1:6GEdvxwEA451/+Y3GtqIGn/MNjujQazUlxC6uGu8Tog= github.com/docker/cli v25.0.2+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/cli-docs-tool v0.6.0 h1:Z9x10SaZgFaB6jHgz3OWooynhSa40CsWkpe5hEnG/qA= -github.com/docker/cli-docs-tool v0.6.0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= +github.com/docker/cli-docs-tool v0.7.0 h1:M2Da98Unz2kz3A5d4yeSGbhyOge2mfYSNjAFt01Rw0M= +github.com/docker/cli-docs-tool v0.7.0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go b/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go index 1dee58c06ca..0b08d9ee185 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go @@ -241,7 +241,7 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) { name += mdMakeLink("`--"+f.Name+"`", f.Name, f, isLink) var ftype string - if f.Value.Type() != "bool" { + if f.Value.Type() != "bool" || (f.Value.Type() == "bool" && f.DefValue == "true") { ftype = "`" + f.Value.Type() + "`" } @@ -253,7 +253,7 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) { } else if cd, ok := cmd.Annotations[annotation.CodeDelimiter]; ok { defval = strings.ReplaceAll(defval, cd, "`") } - } else if f.DefValue != "" && (f.Value.Type() != "bool" && f.DefValue != "true") && f.DefValue != "[]" { + } else if f.DefValue != "" && ((f.Value.Type() != "bool" && f.DefValue != "true") || (f.Value.Type() == "bool" && f.DefValue == "true")) && f.DefValue != "[]" { defval = "`" + f.DefValue + "`" } diff --git a/vendor/github.com/docker/cli-docs-tool/markdown.go b/vendor/github.com/docker/cli-docs-tool/markdown.go index 32849236ed9..bd854870740 100644 --- a/vendor/github.com/docker/cli-docs-tool/markdown.go +++ b/vendor/github.com/docker/cli-docs-tool/markdown.go @@ -29,6 +29,9 @@ var ( // for our use-case; DO NOT consider using this as a generic regex, or at least // not before reading https://stackoverflow.com/a/1732454/1811501. htmlAnchor = regexp.MustCompile(`\s*`) + // relativeLink matches parts of internal links between .md documents + // e.g. "](buildx_build.md)" + relativeLink = regexp.MustCompile(`\]\((\.\/)?[a-z-_]+\.md(#.*)?\)`) ) // getSections returns all H2 sections by title (lowercase) @@ -58,6 +61,16 @@ func cleanupMarkDown(mdString string) (md string, anchors []string) { mdString = strings.ReplaceAll(mdString, "\t", " ") mdString = strings.ReplaceAll(mdString, "https://docs.docker.com", "") + // Rewrite internal links, replacing relative paths with absolute path + // e.g. from [docker buildx build](buildx_build.md#build-arg) + // to [docker buildx build](/reference/cli/docker/buildx/build/#build-arg) + mdString = relativeLink.ReplaceAllStringFunc(mdString, func(link string) string { + link = strings.TrimLeft(link, "](./") + link = strings.ReplaceAll(link, "_", "/") + link = strings.ReplaceAll(link, ".md", "/") + return "](/reference/cli/docker/" + link + }) + var id string // replace trailing whitespace per line, and handle custom anchors lines := strings.Split(mdString, "\n") diff --git a/vendor/modules.txt b/vendor/modules.txt index d94fee24990..bad1d619812 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -245,7 +245,7 @@ github.com/docker/cli/cli/trust github.com/docker/cli/cli/version github.com/docker/cli/opts github.com/docker/cli/templates -# github.com/docker/cli-docs-tool v0.6.0 +# github.com/docker/cli-docs-tool v0.7.0 ## explicit; go 1.18 github.com/docker/cli-docs-tool github.com/docker/cli-docs-tool/annotation From cdfc35d0b60b136321b93d3aa1b9319426519b04 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Fri, 9 Feb 2024 14:35:18 +0100 Subject: [PATCH 2/2] docs: update external link paths Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- commands/build.go | 10 ++-- docs/bake-reference.md | 26 ++++---- docs/reference/buildx_build.md | 90 ++++++++++++++-------------- docs/reference/buildx_debug.md | 2 +- docs/reference/buildx_debug_build.md | 76 +++++++++++------------ 5 files changed, 102 insertions(+), 102 deletions(-) diff --git a/commands/build.go b/commands/build.go index 959674f2144..d3f4addb0d8 100644 --- a/commands/build.go +++ b/commands/build.go @@ -554,7 +554,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/image_build/#add-host"}) + flags.SetAnnotation("add-host", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/image/build/#add-host"}) flags.StringSliceVar(&options.allow, "allow", []string{}, `Allow extra privileged entitlement (e.g., "network.host", "security.insecure")`) @@ -567,12 +567,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/image_build/#cgroup-parent"}) + flags.SetAnnotation("cgroup-parent", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/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/image_build/#file"}) + flags.SetAnnotation("file", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/image/build/#file"}) flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID to the file") @@ -604,10 +604,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/image_build/#tag"}) + flags.SetAnnotation("tag", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/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/image_build/#target"}) + flags.SetAnnotation("target", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/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 afe87d4ba9f..ef3ee44640d 100644 --- a/docs/bake-reference.md +++ b/docs/bake-reference.md @@ -1069,20 +1069,20 @@ 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/image_build/#build-arg -[build-context]: https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context +[build-arg]: https://docs.docker.com/reference/cli/docker/image/build/#build-arg +[build-context]: https://docs.docker.com/reference/cli/docker/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/image_build/#file +[cache-from]: https://docs.docker.com/reference/cli/docker/buildx/build/#cache-from +[cache-to]: https://docs.docker.com/reference/cli/docker/buildx/build/#cache-to +[context]: https://docs.docker.com/reference/cli/docker/buildx/build/#build-context +[file]: https://docs.docker.com/reference/cli/docker/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 -[platform]: https://docs.docker.com/engine/reference/commandline/buildx_build/#platform -[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/image_build/#tag -[target]: https://docs.docker.com/engine/reference/commandline/image_build/#target +[output]: https://docs.docker.com/reference/cli/docker/buildx/build/#output +[platform]: https://docs.docker.com/reference/cli/docker/buildx/build/#platform +[run_mount_secret]: https://docs.docker.com/reference/dockerfile/#run---mounttypesecret +[secret]: https://docs.docker.com/reference/cli/docker/buildx/build/#secret +[ssh]: https://docs.docker.com/reference/cli/docker/buildx/build/#ssh +[tag]: https://docs.docker.com/reference/cli/docker/image/build/#tag +[target]: https://docs.docker.com/reference/cli/docker/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 0b053b7f58a..a2cd99fbfb0 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/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 | +| Name | Type | Default | Description | +|:---------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| +| [`--add-host`](https://docs.docker.com/reference/cli/docker/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/reference/cli/docker/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/reference/cli/docker/image/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/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/reference/cli/docker/image/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/image/build/#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | +| [`--target`](https://docs.docker.com/reference/cli/docker/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/image_build/). +documentation](https://docs.docker.com/reference/cli/docker/image/build/). This page describes a subset of the new flags. ## Examples @@ -152,7 +152,7 @@ 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://docs.docker.com/engine/reference/builder/#run---securitysandbox). + [related Dockerfile extensions](https://docs.docker.com/reference/dockerfile/#run---securitysandbox). 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)). @@ -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/image_build/#build-arg). +Same as [`docker build` command](https://docs.docker.com/reference/cli/docker/image/build/#build-arg). There are also useful built-in build arguments, such as: @@ -176,7 +176,7 @@ There are also useful built-in build arguments, such as: $ docker buildx build --build-arg BUILDKIT_MULTI_PLATFORM=1 . ``` -Learn more about the built-in build arguments in the [Dockerfile reference docs](https://docs.docker.com/engine/reference/builder/#buildkit-built-in-build-args). +Learn more about the built-in build arguments in the [Dockerfile reference docs](https://docs.docker.com/reference/dockerfile/#buildkit-built-in-build-args). ### Additional build contexts (--build-context) @@ -517,7 +517,7 @@ instance supports by running `docker buildx inspect --bootstrap`. Inside a `Dockerfile`, you can access the current platform value through `TARGETPLATFORM` build argument. Refer to the [`docker build` -documentation](https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope) +documentation](https://docs.docker.com/reference/dockerfile/#automatic-platform-args-in-the-global-scope) for the full description of automatic platform argument variants . You can find the formatting definition for the platform specifier in the @@ -611,7 +611,7 @@ For more information, see [here](https://docs.docker.com/build/attestations/sbom ``` Exposes secret to the build. The secret can be used by the build using -[`RUN --mount=type=secret` mount](https://docs.docker.com/engine/reference/builder/#run---mounttypesecret). +[`RUN --mount=type=secret` mount](https://docs.docker.com/reference/dockerfile/#run---mounttypesecret). If `type` is unset it will be detected. Supported types are: @@ -669,7 +669,7 @@ This can be useful when some commands in your Dockerfile need specific SSH authentication (e.g., cloning a private repository). `--ssh` exposes SSH agent socket or keys to the build and can be used with the -[`RUN --mount=type=ssh` mount](https://docs.docker.com/engine/reference/builder/#run---mounttypessh). +[`RUN --mount=type=ssh` mount](https://docs.docker.com/reference/dockerfile/#run---mounttypessh). Example to access Gitlab using an SSH agent socket: diff --git a/docs/reference/buildx_debug.md b/docs/reference/buildx_debug.md index 565ab0ab60b..0db3e5c031c 100644 --- a/docs/reference/buildx_debug.md +++ b/docs/reference/buildx_debug.md @@ -15,7 +15,7 @@ Start debugger (EXPERIMENTAL) | Name | Type | Default | Description | |:------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------------| | `--builder` | `string` | | Override the configured builder instance | -| `--detach` | | | Detach buildx server for the monitor (supported only on linux) (EXPERIMENTAL) | +| `--detach` | `bool` | `true` | Detach buildx server for the monitor (supported only on linux) (EXPERIMENTAL) | | `--invoke` | `string` | | Launch a monitor with executing specified command (EXPERIMENTAL) | | `--on` | `string` | `error` | When to launch the monitor ([always, error]) (EXPERIMENTAL) | | `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`) for the monitor. Use plain to show container output | diff --git a/docs/reference/buildx_debug_build.md b/docs/reference/buildx_debug_build.md index 9afdafd96d7..bec821099e9 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/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 | +| Name | Type | Default | Description | +|:---------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| +| [`--add-host`](https://docs.docker.com/reference/cli/docker/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/reference/cli/docker/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/reference/cli/docker/image/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/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/reference/cli/docker/image/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/image/build/#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | +| [`--target`](https://docs.docker.com/reference/cli/docker/image/build/#target) | `string` | | Set the target build stage to build | +| `--ulimit` | `ulimit` | | Ulimit options |