-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3cb5ad3
commit 4a0217f
Showing
2 changed files
with
11 additions
and
21 deletions.
There are no files selected for viewing
27 changes: 9 additions & 18 deletions
27
website/content/partials/provisioner/hcp-sbom/Config-not-required.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,14 @@ | ||
<!-- Code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; DO NOT EDIT MANUALLY --> | ||
|
||
- `destination` (string) - Destination is an optional field that specifies the path where the SBOM | ||
file will be downloaded to for the user. | ||
The 'Destination' must be a writable location. If the destination is a file, | ||
the SBOM will be saved or overwritten at that path. If the destination is | ||
a directory, a file will be created within the directory to store the SBOM. | ||
Any parent directories for the destination must already exist and be | ||
writable by the provisioning user (generally not root), otherwise, | ||
a "Permission Denied" error will occur. If the source path is a file, | ||
it is recommended that the destination path be a file as well. | ||
- `destination` (string) - The path on the local machine to store a copy of the SBOM file. | ||
You can specify an absolute or a path relative to the working directory | ||
when you execute the Packer build. If the file already exists on the | ||
local machine, Packer overwrites the file. If the destination is a | ||
directory, the directory must already exist. | ||
|
||
- `sbom_name` (string) - The name to give the SBOM when uploaded on HCP Packer | ||
|
||
By default this will be generated, but if you prefer to have a name | ||
of your choosing, you can enter it here. | ||
The name must match the following regexp: `[a-zA-Z0-9_-]{3,36}` | ||
|
||
Note: it must be unique for a single build, otherwise the build will | ||
fail when uploading the SBOMs to HCP Packer, and so will the Packer | ||
build command. | ||
- `sbom_name` (string) - The name of the SBOM file stored in HCP Packer. | ||
If omitted, HCP Packer uses the build fingerprint as the file name. | ||
This value must be between three and 36 characters from the following set: `[A-Za-z0-9_-]`. | ||
You must specify a unique name for each build in an artifact version. | ||
|
||
<!-- End of code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; --> |
5 changes: 2 additions & 3 deletions
5
website/content/partials/provisioner/hcp-sbom/Config-required.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
<!-- Code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; DO NOT EDIT MANUALLY --> | ||
|
||
- `source` (string) - Source is a required field that specifies the path to the SBOM file that | ||
needs to be downloaded. | ||
It can be a file path or a URL. | ||
- `source` (string) - The file path or URL to the SBOM file in the Packer artifact. | ||
This file must either be in the SPDX or CycloneDX format. | ||
|
||
<!-- End of code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; --> |