upstream/packer
1
0
Fork 0
mirror of https://github.com/hashicorp/packer.git synced 2026-05-22 09:57:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: update hcp-sbom provisioner documentation to reflect deprecation of scanner_url and scanner_checksum options

Browse source
This commit is contained in:
Hari Om 2026-05-08 12:41:51 +05:30
parent 4ee664a17c
commit c4e311c8ca
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
website/content/docs/provisioners/hcp-sbom.mdx
View file

@ -17,6 +17,10 @@ page_title: hcp-sbom provisioner reference
The `hcp-sbom` provisioner uploads software bill of materials (SBOM) files from artifacts built by Packer to HCP Packer. You must format SBOM files you want to upload as JSON and follow either the [SPDX](https://spdx.github.io/spdx-spec/latest) or [CycloneDX](https://cyclonedx.org/) specification. HCP Packer ties these SBOM files to the version of the artifact that Packer builds.
## Deprecation Notice
~> **Deprecated Configuration Options:** The `scanner_url` and `scanner_checksum` configuration options are deprecated as of Packer v1.15.4 and will be removed in a future major version. The provisioner now uses the Packer binary with embedded Syft SDK for automatic SBOM generation. For custom SBOM generation tools, use manual generation with the `source` field instead of `auto_generate`.
## Example
The following example uploads an SBOM from the local `/tmp` directory and stores a copy at `./sbom/sbom_cyclonedx.json` on the local machine.
@ -47,6 +51,10 @@ provisioner "hcp-sbom" {
</Tab>
</Tabs>
## Migrating from Custom Scanner URLs
Prior to v1.15.4, the `hcp-sbom` provisioner supported downloading custom scanner binaries via `scanner_url`. This is no longer supported as the provisioner now uses the Packer binary with embedded Syft SDK.
## Configuration reference
You can specify the following configuration options.