packer: link to docs if a component is missing #12705
Merged
Conversation
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
JenGoldstrich
approved these changes
Nov 22, 2023
| @@ -218,15 +219,33 @@ func (c *Core) BuildNames(only, except []string) []string { | |||
| func (c *Core) generateCoreBuildProvisioner(rawP *template.Provisioner, rawName string) (CoreBuildProvisioner, error) { | |||
| // Get the provisioner | |||
| cbp := CoreBuildProvisioner{} | |||
|
|
|||
| if !c.components.PluginConfig.Provisioners.Has(rawP.Type) { | |||
There was a problem hiding this comment.
Might be worth updating the core build tests in packer/core_test.go for this change, but I didn't dig into these tests too much to see how practical that is
nywilken
reviewed
Nov 22, 2023
There was a problem hiding this comment.
This looks great! Nicely done on the quick turnaround.
I think the output needs a little formatting
~> packer validate ansible_docker.json
Error: Failed to initialize build "docker"
The builder docker is unknown by Packer, and is likely part of a plugin that is
not installed.
You may find the plugin needed in the Packer integrations, and install it as
documented there:
https://developer.hashicorp.com/packer/integrations?filter=docker
~> packer validate ansible_ssh_no_proxy_ssm.pkr.hcl
Error: Unknown source type amazon-ebs
on ansible_ssh_no_proxy_ssm.pkr.hcl line 29:
(source code not available)
The source amazon-ebs is unknown by Packer, and is likely part of a plugin that
is not installed.
You may find the plugin needed in the Packer integrations, and install it as
documented there:
https://developer.hashicorp.com/packer/integrations?filter=amazon
Error: Unknown provisioner type "ansible"
on ansible_ssh_no_proxy_ssm.pkr.hcl line 32:
(source code not available)
The provisioner ansible is unknown by Packer, and is likely part of a plugin
that is not installed.
You may find the plugin needed in the Packer integrations, and install it as
documented there:
https://developer.hashicorp.com/packer/integrations?filter=ansible
~> packer build qemu_fedora_compress_googlecompute-import_post-processor.pkr.hcl
Error: Unknown source type qemu
on qemu_fedora_compress_googlecompute-import_post-processor.pkr.hcl line 39:
(source code not available)
The source qemu is unknown by Packer, and is likely part of a plugin that is not
installed.
You may find the plugin needed in the Packer integrations, and install it as
documented there:
https://developer.hashicorp.com/packer/integrations?filter=qemu
Error: Unknown post-processor type "googlecompute-import"
on qemu_fedora_compress_googlecompute-import_post-processor.pkr.hcl line 46:
(source code not available)
The post-processor googlecompute-import is unknown by Packer, and is likely part
of a plugin that is not installed.
You may find the plugin needed in the Packer integrations, and install it as
documented there:
https://developer.hashicorp.com/packer/integrations?filter=googlecompute
nywilken
added
enhancement
backport/1.10.x
When a user invokes packer for a build or validation, the template being processed needs components to be present for Packer to process it without error. If the component cannot be found from the plugins loaded (or from the components bundled with Packer), Packer errors, and the command fails. This is expected, but the error message does not suggest anything to fix the error, potantially leaving users confused at the problem. This commit suggests either a replacement (in case of a typo), or points to the web documentation for Packer, specifically the integrations, so they can look for the plugin they're missing, and install it, so subsequent invocations of Packer work.
lbajolet-hashicorp
force-pushed
the
missing_plugins_hint_on_error
branch
from
1faa48f
to
19ca583
Compare
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a user invokes packer for a build or validation, the template being processed needs components to be present for Packer to process it without error.
If the component cannot be found from the plugins loaded (or from the components bundled with Packer), Packer errors, and the command fails.
This is expected, but the error message does not suggest anything to fix the error, potantially leaving users confused at the problem.
This commit suggests either a replacement (in case of a typo), or points to the web documentation for Packer, specifically the integrations, so they can look for the plugin they're missing, and install it, so subsequent invocations of Packer work.