Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explain attestation-inline=false #4435

Closed
wants to merge 1 commit into from
Closed

docs: explain attestation-inline=false #4435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,8 @@ Keys supported by image output:
* `<type>` specifies what object to attach to, and can be any of `manifest` (the default), `manifest-descriptor`, `index` and `index-descriptor`
* `<platform>` specifies which objects to attach to (by default, all), and is the same key passed into the `platform` opt, see [`docs/multi-platform.md`](docs/multi-platform.md).
* See [`docs/annotations.md`](docs/annotations.md) for more details.
* `attestation-inline=false`: Prevent attaching an [attestation manifest](./docs/attestations/) to the built image.
This option is expected to be used as a workaround for compatibility issue with third party registry implementations that do not properly implement the OCI Distribution Spec.

If credentials are required, `buildctl` will attempt to read Docker configuration file `$DOCKER_CONFIG/config.json`.
`$DOCKER_CONFIG` defaults to `~/.docker`.
Expand Down
6 changes: 6 additions & 0 deletions docs/attestations/attestation-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,3 +213,9 @@ Attestation body containing the SBOM data listing the packages used during the b
"spdxVersion": "SPDX-2.2",
...
```

## Tips
### Preventing attaching attestation manifests

To prevent attaching an attestation manifest to the built image, specify an image exporter option `attestation-inline=false`.
This option is expected to be used as a workaround for compatibility issue with third party registry implementations that do not properly implement the OCI Distribution Spec.