From 638be57e438fe4e3a4fc4ccab8c11bd3859810fd Mon Sep 17 00:00:00 2001 From: Megan Marsh Date: Tue, 25 May 2021 04:55:25 -0700 Subject: [PATCH] document gotcha around third party plugins (#11032) * document gotcha around third party plugins * Update website/content/docs/commands/hcl2_upgrade.mdx Co-authored-by: Adrien Delorme --- website/content/docs/commands/hcl2_upgrade.mdx | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/website/content/docs/commands/hcl2_upgrade.mdx b/website/content/docs/commands/hcl2_upgrade.mdx index af1b058b1..308949255 100644 --- a/website/content/docs/commands/hcl2_upgrade.mdx +++ b/website/content/docs/commands/hcl2_upgrade.mdx @@ -98,9 +98,11 @@ working on improving this part of the transformer. ## Options -- `-output-file` - File where to put the hcl2 generated config. Defaults to - JSON_TEMPLATE.pkr.hcl -- `-with-annotations` - Adds helper annotations with information about the generated HCL2 blocks. +- `-output-file` - Filename of the hcl2 generated template. Defaults to + JSON_TEMPLATE.pkr.hcl; for example, if the file is called + "packerparty.json", the default output-file is "packerparty.json.pkr.hcl". +- `-with-annotations` - Adds helpful comments to the HCL template with + information about the generated HCL2 blocks. ## User variables using other user variables @@ -128,3 +130,10 @@ locals { baz = "${var.foo} ${var.bar}" } ``` + +## Upgrading templates that use third-party community plugins + +If your template references a plugin that is not bundled with the main Packer +binary, you need to make sure that the [plugin is installed](/docs/plugins#installing-plugins) +or you will get an `unknown builder type` error. Packer needs to load the plugin +to transpose the template.