diff --git a/website/content/partials/provisioner/hcp_sbom/Config-not-required.mdx b/website/content/partials/provisioner/hcp_sbom/Config-not-required.mdx index a8019fbde..a46cec04b 100644 --- a/website/content/partials/provisioner/hcp_sbom/Config-not-required.mdx +++ b/website/content/partials/provisioner/hcp_sbom/Config-not-required.mdx @@ -1,5 +1,13 @@ -- `destination` (string) - Destination +- `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. diff --git a/website/content/partials/provisioner/hcp_sbom/Config-required.mdx b/website/content/partials/provisioner/hcp_sbom/Config-required.mdx index 0cb7e7a80..936c435f6 100644 --- a/website/content/partials/provisioner/hcp_sbom/Config-required.mdx +++ b/website/content/partials/provisioner/hcp_sbom/Config-required.mdx @@ -1,5 +1,7 @@ -- `source` (string) - Source +- `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.