docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

vendor: github.com/docker/buildx v0.17.0 

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
crazy-max 2024-09-10 17:14:24 +00:00 committed by github-actions[bot]
parent 5acfd0fb17
commit e5fd223588
25 changed files with 305 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
_vendor/github.com/docker/buildx/docs/bake-reference.md generated
View File

@ -443,8 +443,7 @@ COPY --from=src . .
#### Use another target as base
> **Note**
>
> [!NOTE]
> You should prefer to use regular multi-stage builds over this option. You can
> Use this feature when you have multiple Dockerfiles that can't be easily
> merged into one.
@ -506,6 +505,25 @@ $ docker buildx bake --print -f - <<< 'target "default" {}'
}
```
### `target.entitlements`
Entitlements are permissions that the build process requires to run.
Currently supported entitlements are:
- `network.host`: Allows the build to use commands that access the host network. In Dockerfile, use [`RUN --network=host`](https://docs.docker.com/reference/dockerfile/#run---networkhost) to run a command with host network enabled.
- `security.insecure`: Allows the build to run commands in privileged containers that are not limited by the default security sandbox. Such container may potentially access and modify system resources. In Dockerfile, use [`RUN --security=insecure`](https://docs.docker.com/reference/dockerfile/#run---security) to run a command in a privileged container.
```hcl
target "integration-tests" {
# this target requires privileged containers to run nested containers
entitlements = ["security.insecure"]
}
```
Entitlements are enabled with a two-step process. First, a target must declare the entitlements it requires. Secondly, when invoking the `bake` command, the user must grant the entitlements by passing the `--allow` flag or confirming the entitlements when prompted in an interactive terminal. This is to ensure that the user is aware of the possibly insecure permissions they are granting to the build process.
### `target.inherits`
A target can inherit attributes from other targets.
@ -750,6 +768,27 @@ target "app" {
}
```
### `target.network`
Specify the network mode for the whole build request. This will override the default network mode
for all the `RUN` instructions in the Dockerfile. Accepted values are `default`, `host`, and `none`.
Usually, a better approach to set the network mode for your build steps is to instead use `RUN --network=<value>`
in your Dockerfile. This way, you can set the network mode for individual build steps and everyone building
the Dockerfile gets consistent behavior without needing to pass additional flags to the build command.
If you set network mode to `host` in your Bake file, you must also grant `network.host` entitlement when
invoking the `bake` command. This is because `host` network mode requires elevated privileges and can be a security risk.
You can pass `--allow=network.host` to the `docker buildx bake` command to grant the entitlement, or you can
confirm the entitlement when prompted if you are using an interactive terminal.
```hcl
target "app" {
# make sure this build does not access internet
network = "none"
}
```
### `target.no-cache-filter`
Don't use build cache for the specified stages.
@ -832,8 +871,8 @@ This lets you [mount the secret][run_mount_secret] in your Dockerfile.
```dockerfile
RUN --mount=type=secret,id=aws,target=/root/.aws/credentials \
aws cloudfront create-invalidation ...
RUN --mount=type=secret,id=KUBECONFIG \
KUBECONFIG=$(cat /run/secrets/KUBECONFIG) helm upgrade --install
RUN --mount=type=secret,id=KUBECONFIG,env=KUBECONFIG \
helm upgrade --install
```
### `target.shm-size`
@ -853,8 +892,7 @@ target "default" {
}
```
> **Note**
>
> [!NOTE]
> In most cases, it is recommended to let the builder automatically determine
> the appropriate configurations. Manual adjustments should only be considered
> when specific performance tuning is required for complex build scenarios.
@ -919,14 +957,12 @@ target "app" {
}
```
> **Note**
>
> [!NOTE]
> If you do not provide a `hard limit`, the `soft limit` is used
> for both values. If no `ulimits` are set, they are inherited from
> the default `ulimits` set on the daemon.
> **Note**
>
> [!NOTE]
> In most cases, it is recommended to let the builder automatically determine
> the appropriate configurations. Manual adjustments should only be considered
> when specific performance tuning is required for complex build scenarios.
@ -1114,8 +1150,7 @@ target "webapp-dev" {
}
```
> **Note**
>
> [!NOTE]
> See [User defined HCL functions][hcl-funcs] page for more details.
<!-- external links -->

4
_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md generated
View File

@ -1,6 +1,4 @@
---
title: buildkitd.toml
---
# buildkitd.toml
The TOML file used to configure the buildkitd daemon settings has a short
list of global settings followed by a series of sections for specific areas

4
_vendor/modules.txt
View File

@ -1,6 +1,6 @@
# github.com/moby/moby v27.2.1+incompatible
# github.com/moby/buildkit v0.15.1
# github.com/docker/buildx v0.16.2
# github.com/moby/buildkit v0.16.0
# github.com/docker/buildx v0.17.0
# github.com/docker/cli v27.2.2-0.20240909090509-65decb573126+incompatible
# github.com/docker/compose/v2 v2.29.2
# github.com/docker/scout-cli v1.13.0

11
data/buildx/docker_buildx.yaml
View File

@ -44,6 +44,17 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}

30
data/buildx/docker_buildx_bake.yaml
View File

@ -8,8 +8,7 @@ long: |-
Read [High-level build options with Bake](/build/bake/)
guide for introduction to writing bake files.
> **Note**
>
> [!NOTE]
> `buildx bake` command may receive backwards incompatible features in the future
> if needed. We are looking for feedback on improving the command and extending
> the functionality further.
@ -17,6 +16,16 @@ usage: docker buildx bake [OPTIONS] [TARGET...]
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: allow
value_type: stringArray
default_value: '[]'
description: Allow build to access specified resources
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: call
value_type: string
default_value: build
@ -187,6 +196,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}
@ -302,8 +322,7 @@ examples: |-
}
```
> **Note**
>
> [!NOTE]
> Build record [provenance](/build/metadata/attestations/slsa-provenance/#provenance-attestation-example)
> (`buildx.build.provenance`) includes minimal provenance by default. Set the
> `BUILDX_METADATA_PROVENANCE` environment variable to customize this behavior:
@ -311,8 +330,7 @@ examples: |-
> * `max` sets full provenance.
> * `disabled`, `false` or `0` does not set any provenance.
> **Note**
>
> [!NOTE]
> Build warnings (`buildx.build.warnings`) are not included by default. Set the
> `BUILDX_METADATA_WARNINGS` environment variable to `1` or `true` to
> include them.

36
data/buildx/docker_buildx_build.yaml
View File

@ -543,6 +543,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Add entries to container hosts file (--add-host) {#add-host}
@ -1060,8 +1071,7 @@ examples: |-
}
```
> **Note**
>
> [!NOTE]
> Build record [provenance](/build/metadata/attestations/slsa-provenance/#provenance-attestation-example)
> (`buildx.build.provenance`) includes minimal provenance by default. Set the
> `BUILDX_METADATA_PROVENANCE` environment variable to customize this behavior:
@ -1070,8 +1080,7 @@ examples: |-
> - `max` sets full provenance.
> - `disabled`, `false` or `0` doesn't set any provenance.
> **Note**
>
> [!NOTE]
> Build warnings (`buildx.build.warnings`) are not included by default. Set the
> `BUILDX_METADATA_WARNINGS` environment variable to `1` or `true` to
> include them.
@ -1311,8 +1320,7 @@ examples: |-
Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use `plain` to show container
output (default `auto`).
> **Note**
>
> [!NOTE]
> You can also use the `BUILDKIT_PROGRESS` environment variable to set its value.
The following example uses `plain` output during the build:
@ -1330,8 +1338,7 @@ examples: |-
...
```
> **Note**
>
> [!NOTE]
> Check also the [`BUILDKIT_COLORS`](/build/building/variables/#buildkit_colors)
> environment variable for modifying the colors of the terminal output.
@ -1429,8 +1436,8 @@ examples: |-
# syntax=docker/dockerfile:1
FROM node:alpine
RUN --mount=type=bind,target=. \
--mount=type=secret,id=SECRET_TOKEN \
SECRET_TOKEN=$(cat /run/secrets/SECRET_TOKEN) yarn run test
--mount=type=secret,id=SECRET_TOKEN,env=SECRET_TOKEN \
yarn run test
```
```console
@ -1446,8 +1453,7 @@ examples: |-
optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g`
(gigabytes). If you omit the unit, the system uses bytes.
> **Note**
>
> [!NOTE]
> In most cases, it is recommended to let the builder automatically determine
> the appropriate configurations. Manual adjustments should only be considered
> when specific performance tuning is required for complex build scenarios.
@ -1533,14 +1539,12 @@ examples: |-
$ docker buildx build --ulimit nofile=1024:1024 .
```
> **Note**
>
> [!NOTE]
> If you don't provide a `hard limit`, the `soft limit` is used
> for both values. If no `ulimits` are set, they're inherited from
> the default `ulimits` set on the daemon.
> **Note**
>
> [!NOTE]
> In most cases, it is recommended to let the builder automatically determine
> the appropriate configurations. Manual adjustments should only be considered
> when specific performance tuning is required for complex build scenarios.

15
data/buildx/docker_buildx_create.yaml
View File

@ -147,6 +147,18 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Append a new node to an existing builder (--append) {#append}
@ -208,8 +220,7 @@ examples: |-
--buildkitd-flags '--oci-worker-net bridge'
```
> **Note**
>
> [!NOTE]
> Network mode "bridge" is supported since BuildKit v0.13 and will become the
> default in next v0.14.

11
data/buildx/docker_buildx_debug.yaml
View File

@ -78,6 +78,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false

11
data/buildx/docker_buildx_debug_build.yaml
View File

@ -514,6 +514,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false

11
data/buildx/docker_buildx_dial-stdio.yaml
View File

@ -37,6 +37,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
Example go program that uses the dial-stdio command wire up a buildkit client.
This is for example use only and may not be suitable for production use.

11
data/buildx/docker_buildx_du.yaml
View File

@ -36,6 +36,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Show disk usage

11
data/buildx/docker_buildx_imagetools.yaml
View File

@ -23,6 +23,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}

14
data/buildx/docker_buildx_imagetools_create.yaml
View File

@ -104,6 +104,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Add annotations to an image (--annotation) {#annotation}
@ -120,8 +131,7 @@ examples: |-
foo/bar:alpha foo/bar:beta foo/bar:gamma
```
> **Note**
>
> [!NOTE]
> The `imagetools create` command supports adding annotations to the image
> index and descriptor, using the following type prefixes:
>

11
data/buildx/docker_buildx_imagetools_inspect.yaml
View File

@ -75,6 +75,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}

14
data/buildx/docker_buildx_inspect.yaml
View File

@ -27,6 +27,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Ensure that the builder is running before inspecting (--bootstrap) {#bootstrap}
@ -48,8 +59,7 @@ examples: |-
The following example shows information about a builder instance named
`elated_tesla`:
> **Note**
>
> [!NOTE]
> The asterisk (`*`) next to node build platform(s) indicate they have been
> manually set during `buildx create`. Otherwise the platforms were
> automatically detected.

12
data/buildx/docker_buildx_install.yaml
View File

@ -13,6 +13,18 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: true
experimental: false

12
data/buildx/docker_buildx_ls.yaml
View File

@ -39,6 +39,18 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Format the output (--format) {#format}

11
data/buildx/docker_buildx_prune.yaml
View File

@ -84,6 +84,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}

11
data/buildx/docker_buildx_rm.yaml
View File

@ -63,6 +63,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Remove all inactive builders (--all-inactive) {#all-inactive}

11
data/buildx/docker_buildx_stop.yaml
View File

@ -17,6 +17,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}

12
data/buildx/docker_buildx_uninstall.yaml
View File

@ -13,6 +13,18 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: true
experimental: false

11
data/buildx/docker_buildx_use.yaml
View File

@ -39,6 +39,17 @@ inherited_options:
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Override the configured builder instance (--builder) {#builder}

12
data/buildx/docker_buildx_version.yaml
View File

@ -19,6 +19,18 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false

6
go.mod
View File

@ -5,16 +5,16 @@ go 1.21.0
toolchain go1.22.5
require (
github.com/docker/buildx v0.16.2 // indirect
github.com/docker/buildx v0.17.0 // indirect
github.com/docker/cli v27.2.2-0.20240909090509-65decb573126+incompatible // indirect
github.com/docker/compose/v2 v2.29.2 // indirect
github.com/docker/scout-cli v1.13.0 // indirect
github.com/moby/buildkit v0.15.1 // indirect
github.com/moby/buildkit v0.16.0 // indirect
github.com/moby/moby v27.2.1+incompatible // indirect
)
replace (
github.com/docker/buildx => github.com/docker/buildx v0.16.2
github.com/docker/buildx => github.com/docker/buildx v0.17.0
github.com/docker/cli => github.com/docker/cli v27.2.2-0.20240909090509-65decb573126+incompatible
github.com/docker/compose/v2 => github.com/docker/compose/v2 v2.29.2
github.com/docker/scout-cli => github.com/docker/scout-cli v1.13.0

2
go.sum
View File

@ -78,6 +78,8 @@ github.com/docker/buildx v0.16.0 h1:LurEflyb6BBoLtDwJY1dw9dLHKzEgGvCjAz67QI0xO0=
github.com/docker/buildx v0.16.0/go.mod h1:4xduW7BOJ2B11AyORKZFDKjF6Vcb4EgTYnV2nunxv9I=
github.com/docker/buildx v0.16.2 h1:SPcyEiiCZEntJQ+V0lJI8ZudUrki2v1qUqmC/NqxDDs=
github.com/docker/buildx v0.16.2/go.mod h1:by+CuE4Q+2NvECkIhNcWe89jjbHADCrDlzS9MRgbv2k=
github.com/docker/buildx v0.17.0 h1:Z+QQxsJJPldaeU/4aNXoudFwDDK0/ALFYmDcP5q5fiY=
github.com/docker/buildx v0.17.0/go.mod h1:sBKkoZFs+R2D6ARyQ4/GE/FQHHFsl9PkHdvv/GXAsMo=
github.com/docker/cli v24.0.2+incompatible h1:QdqR7znue1mtkXIJ+ruQMGQhpw2JzMJLRXp6zpzF6tM=
github.com/docker/cli v24.0.2+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8=
github.com/docker/cli v24.0.4+incompatible h1:Y3bYF9ekNTm2VFz5U/0BlMdJy73D+Y1iAAZ8l63Ydzw=