From 5e9516a1a45f150f8f9cd76a25a3ee1fcec11f22 Mon Sep 17 00:00:00 2001 From: Lucas Bajolet Date: Wed, 16 Aug 2023 10:29:28 -0400 Subject: [PATCH] docs: add snippet regarding HCP_PACKER_PROJECT_ID Since the HCP_PACKER_PROJECT_ID environment variable was introduced for supporting project-level service principals, we add some documentation snippet to highlight its existence and document its usage a bit. --- website/content/docs/hcp/index.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/content/docs/hcp/index.mdx b/website/content/docs/hcp/index.mdx index b7af158ee..c2ec3d4b4 100644 --- a/website/content/docs/hcp/index.mdx +++ b/website/content/docs/hcp/index.mdx @@ -35,6 +35,10 @@ You can set these additional environment variables to control how metadata is pu - `HCP_PACKER_REGISTRY` - When set, Packer does not push image metadata to HCP Packer from an otherwise configured template. Allowed values are [0|OFF]. +- `HCP_PACKER_PROJECT_ID` - The ID of the HCP project to use. This is useful if your service principal has access to multiple projects, as by default Packer will pick the one created first as target. + +-> **Note**: The HCP_PACKER_PROJECT_ID environment variable must be set if you're authenticating with a project-level service principal, as otherwise Packer will attempt to get the list of projects for an organization, which will error due to a lack of permissions. This is supported starting with Packer 1.9.3; older versions of Packer do not support using project-level service principals. + ### HCP Packer Registry Block The only metadata that Packer can infer from a template with the basic configuration are the build name and build fingerprint. For HCL2 templates, we recommend adding the `hcp_packer_registry` block to your template so that you can customize the metadata that Packer sends to the registry.