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

buildx: metadata envs (#22049) 

<!--Delete sections as needed -->

## Description

Missing documentation for buildx metadata envs

## Related issues or tickets

follow up:
* https://github.com/docker/buildx/pull/2280
* https://github.com/docker/buildx/pull/2551

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax 2025-02-18 14:05:19 +01:00 committed by GitHub
parent da9b5a7fbc
commit 7c42a9fef5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 46 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
content/manuals/build/building/variables.md
View File

@ -305,7 +305,7 @@ they aren't available inside the build and they have no relation to the `ENV` in
They're used to configure the Buildx client, or the BuildKit daemon.
| Variable | Type | Description |
| --------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------ |
|-----------------------------------------------------------------------------|-------------------|------------------------------------------------------------------|
| [BUILDKIT_COLORS](#buildkit_colors) | String | Configure text color for the terminal output. |
| [BUILDKIT_HOST](#buildkit_host) | String | Specify host to use for remote builders. |
| [BUILDKIT_PROGRESS](#buildkit_progress) | String | Configure type of progress output. |
@ -321,6 +321,8 @@ They're used to configure the Buildx client, or the BuildKit daemon.
| [BUILDX_GIT_INFO](#buildx_git_info) | Boolean | Remove Git information in provenance attestations. |
| [BUILDX_GIT_LABELS](#buildx_git_labels) | String \| Boolean | Add Git provenance labels to images. |
| [BUILDX_MEM_PROFILE](#buildx_mem_profile) | String | Generate a `pprof` memory profile at the specified location. |
| [BUILDX_METADATA_PROVENANCE](#buildx_metadata_provenance) | String \| Boolean | Customize provenance informations included in the metadata file. |
| [BUILDX_METADATA_WARNINGS](#buildx_metadata_warnings) | String | Include build warnings in the metadata file. |
| [BUILDX_NO_DEFAULT_ATTESTATIONS](#buildx_no_default_attestations) | Boolean | Turn off default provenance attestations. |
| [BUILDX_NO_DEFAULT_LOAD](#buildx_no_default_load) | Boolean | Turn off loading images to image store by default. |
| [EXPERIMENTAL_BUILDKIT_SOURCE_POLICY](#experimental_buildkit_source_policy) | String | Specify a BuildKit source policy file. |
@ -608,6 +610,26 @@ Usage:
$ export BUILDX_MEM_PROFILE=buildx_mem.prof
```
### BUILDX_METADATA_PROVENANCE
{{< summary-bar feature_name="Buildx metadata provenance" >}}
By default, Buildx includes minimal provenance information in the metadata file
through [`--metadata-file` flag](/reference/cli/docker/buildx/build/#metadata-file).
This environment variable allows you to customize the provenance information
included in the metadata file:
* `min` sets minimal provenance (default).
* `max` sets full provenance.
* `disabled`, `false` or `0` does not set any provenance.
### BUILDX_METADATA_WARNINGS
{{< summary-bar feature_name="Buildx metadata warnings" >}}
By default, Buildx does not include build warnings in the metadata file through
[`--metadata-file` flag](/reference/cli/docker/buildx/build/#metadata-file).
You can set this environment variable to `1` or `true` to include them.
### BUILDX_NO_DEFAULT_ATTESTATIONS
{{< summary-bar feature_name="Buildx no default" >}}

4
data/summary.yaml
View File

@ -51,6 +51,10 @@ Buildx Git labels:
requires: Docker Buildx [0.10.0](/manuals/build/release-notes.md#0100) and later
Buildx mem profile:
requires: Docker Buildx [0.18.0](/manuals/build/release-notes.md#0180) and later
Buildx metadata provenance:
requires: Docker Buildx [0.14.0](/manuals/build/release-notes.md#0140) and later
Buildx metadata warnings:
requires: Docker Buildx [0.16.0](/manuals/build/release-notes.md#0160) and later
Buildx no default:
requires: Docker Buildx [0.10.4](/manuals/build/release-notes.md#0104) and later
Cache backend API: