Skip to content

Commit 7c42a9f

Browse files
crazy-maxcrazy-max
authored
buildx: metadata envs (#22049)
<!--Delete sections as needed --> ## Description Missing documentation for buildx metadata envs ## Related issues or tickets follow up: * docker/buildx#2280 * docker/buildx#2551 ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review Signed-off-by: CrazyMax <[email protected]>
1 parent da9b5a7 commit 7c42a9f

File tree

2 files changed

+46
-20
lines changed

2 files changed

+46
-20
lines changed

‎content/manuals/build/building/variables.md‎

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -304,26 +304,28 @@ Note that these variables aren't used to configure the build container;
304304
they aren't available inside the build and they have no relation to the `ENV` instruction.
305305
They're used to configure the Buildx client, or the BuildKit daemon.
306306

307-
| Variable | Type | Description |
308-
| --------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------ |
309-
| [BUILDKIT_COLORS](#buildkit_colors) | String | Configure text color for the terminal output. |
310-
| [BUILDKIT_HOST](#buildkit_host) | String | Specify host to use for remote builders. |
311-
| [BUILDKIT_PROGRESS](#buildkit_progress) | String | Configure type of progress output. |
312-
| [BUILDKIT_TTY_LOG_LINES](#buildkit_tty_log_lines) | String | Number of log lines (for active steps in TTY mode). |
313-
| [BUILDX_BAKE_GIT_AUTH_HEADER](#buildx_bake_git_auth_header) | String | HTTP authentication scheme for remote Bake files. |
314-
| [BUILDX_BAKE_GIT_AUTH_TOKEN](#buildx_bake_git_auth_token) | String | HTTP authentication token for remote Bake files. |
315-
| [BUILDX_BAKE_GIT_SSH](#buildx_bake_git_ssh) | String | SSH authentication for remote Bake files. |
316-
| [BUILDX_BUILDER](#buildx_builder) | String | Specify the builder instance to use. |
317-
| [BUILDX_CONFIG](#buildx_config) | String | Specify location for configuration, state, and logs. |
318-
| [BUILDX_CPU_PROFILE](#buildx_cpu_profile) | String | Generate a `pprof` CPU profile at the specified location. |
319-
| [BUILDX_EXPERIMENTAL](#buildx_experimental) | Boolean | Turn on experimental features. |
320-
| [BUILDX_GIT_CHECK_DIRTY](#buildx_git_check_dirty) | Boolean | Enable dirty Git checkout detection. |
321-
| [BUILDX_GIT_INFO](#buildx_git_info) | Boolean | Remove Git information in provenance attestations. |
322-
| [BUILDX_GIT_LABELS](#buildx_git_labels) | String \| Boolean | Add Git provenance labels to images. |
323-
| [BUILDX_MEM_PROFILE](#buildx_mem_profile) | String | Generate a `pprof` memory profile at the specified location. |
324-
| [BUILDX_NO_DEFAULT_ATTESTATIONS](#buildx_no_default_attestations) | Boolean | Turn off default provenance attestations. |
325-
| [BUILDX_NO_DEFAULT_LOAD](#buildx_no_default_load) | Boolean | Turn off loading images to image store by default. |
326-
| [EXPERIMENTAL_BUILDKIT_SOURCE_POLICY](#experimental_buildkit_source_policy) | String | Specify a BuildKit source policy file. |
307+
| Variable | Type | Description |
308+
|-----------------------------------------------------------------------------|-------------------|------------------------------------------------------------------|
309+
| [BUILDKIT_COLORS](#buildkit_colors) | String | Configure text color for the terminal output. |
310+
| [BUILDKIT_HOST](#buildkit_host) | String | Specify host to use for remote builders. |
311+
| [BUILDKIT_PROGRESS](#buildkit_progress) | String | Configure type of progress output. |
312+
| [BUILDKIT_TTY_LOG_LINES](#buildkit_tty_log_lines) | String | Number of log lines (for active steps in TTY mode). |
313+
| [BUILDX_BAKE_GIT_AUTH_HEADER](#buildx_bake_git_auth_header) | String | HTTP authentication scheme for remote Bake files. |
314+
| [BUILDX_BAKE_GIT_AUTH_TOKEN](#buildx_bake_git_auth_token) | String | HTTP authentication token for remote Bake files. |
315+
| [BUILDX_BAKE_GIT_SSH](#buildx_bake_git_ssh) | String | SSH authentication for remote Bake files. |
316+
| [BUILDX_BUILDER](#buildx_builder) | String | Specify the builder instance to use. |
317+
| [BUILDX_CONFIG](#buildx_config) | String | Specify location for configuration, state, and logs. |
318+
| [BUILDX_CPU_PROFILE](#buildx_cpu_profile) | String | Generate a `pprof` CPU profile at the specified location. |
319+
| [BUILDX_EXPERIMENTAL](#buildx_experimental) | Boolean | Turn on experimental features. |
320+
| [BUILDX_GIT_CHECK_DIRTY](#buildx_git_check_dirty) | Boolean | Enable dirty Git checkout detection. |
321+
| [BUILDX_GIT_INFO](#buildx_git_info) | Boolean | Remove Git information in provenance attestations. |
322+
| [BUILDX_GIT_LABELS](#buildx_git_labels) | String \| Boolean | Add Git provenance labels to images. |
323+
| [BUILDX_MEM_PROFILE](#buildx_mem_profile) | String | Generate a `pprof` memory profile at the specified location. |
324+
| [BUILDX_METADATA_PROVENANCE](#buildx_metadata_provenance) | String \| Boolean | Customize provenance informations included in the metadata file. |
325+
| [BUILDX_METADATA_WARNINGS](#buildx_metadata_warnings) | String | Include build warnings in the metadata file. |
326+
| [BUILDX_NO_DEFAULT_ATTESTATIONS](#buildx_no_default_attestations) | Boolean | Turn off default provenance attestations. |
327+
| [BUILDX_NO_DEFAULT_LOAD](#buildx_no_default_load) | Boolean | Turn off loading images to image store by default. |
328+
| [EXPERIMENTAL_BUILDKIT_SOURCE_POLICY](#experimental_buildkit_source_policy) | String | Specify a BuildKit source policy file. |
327329

328330
BuildKit also supports a few additional configuration parameters. Refer to
329331
[BuildKit built-in build args](/reference/dockerfile.md#buildkit-built-in-build-args).
@@ -608,6 +610,26 @@ Usage:
608610
$ export BUILDX_MEM_PROFILE=buildx_mem.prof
609611
```
610612

613+
### BUILDX_METADATA_PROVENANCE
614+
615+
{{< summary-bar feature_name="Buildx metadata provenance" >}}
616+
617+
By default, Buildx includes minimal provenance information in the metadata file
618+
through [`--metadata-file` flag](/reference/cli/docker/buildx/build/#metadata-file).
619+
This environment variable allows you to customize the provenance information
620+
included in the metadata file:
621+
* `min` sets minimal provenance (default).
622+
* `max` sets full provenance.
623+
* `disabled`, `false` or `0` does not set any provenance.
624+
625+
### BUILDX_METADATA_WARNINGS
626+
627+
{{< summary-bar feature_name="Buildx metadata warnings" >}}
628+
629+
By default, Buildx does not include build warnings in the metadata file through
630+
[`--metadata-file` flag](/reference/cli/docker/buildx/build/#metadata-file).
631+
You can set this environment variable to `1` or `true` to include them.
632+
611633
### BUILDX_NO_DEFAULT_ATTESTATIONS
612634

613635
{{< summary-bar feature_name="Buildx no default" >}}

‎data/summary.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ Buildx Git labels:
5151
requires: Docker Buildx [0.10.0](/manuals/build/release-notes.md#0100) and later
5252
Buildx mem profile:
5353
requires: Docker Buildx [0.18.0](/manuals/build/release-notes.md#0180) and later
54+
Buildx metadata provenance:
55+
requires: Docker Buildx [0.14.0](/manuals/build/release-notes.md#0140) and later
56+
Buildx metadata warnings:
57+
requires: Docker Buildx [0.16.0](/manuals/build/release-notes.md#0160) and later
5458
Buildx no default:
5559
requires: Docker Buildx [0.10.4](/manuals/build/release-notes.md#0104) and later
5660
Cache backend API:

0 commit comments

Comments
 (0)