From 5301f4613dab5337f450cb289661ef8a57de2979 Mon Sep 17 00:00:00 2001 From: Megan Marsh Date: Tue, 22 Oct 2019 09:54:33 -0700 Subject: [PATCH] update vagrant docs to explain that the builder and postprocessor are mutually exclusive --- website/source/docs/builders/vagrant.html.md | 6 ++++++ website/source/docs/post-processors/vagrant.html.md | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/website/source/docs/builders/vagrant.html.md b/website/source/docs/builders/vagrant.html.md index 18d67a210..2f890548b 100644 --- a/website/source/docs/builders/vagrant.html.md +++ b/website/source/docs/builders/vagrant.html.md @@ -30,6 +30,12 @@ by setting the `skip package` option. You can also change the behavior so that rather than initializing a new Vagrant workspace, you use an already defined one, by using `global_id` instead of `source_box`. +Please note that if you are using the Vagrant builder, then the Vagrant +post-processor is unnecesary because the output of the Vagrant builder is +already a Vagrant box; using that post-processor with the Vagrant builder will +cause your build to fail. Similarly, since Vagrant boxes are already compressed, +the Compress post-processor will not work with this builder. + ## Configuration Reference ### Required: diff --git a/website/source/docs/post-processors/vagrant.html.md b/website/source/docs/post-processors/vagrant.html.md index d9168cfce..862f20017 100644 --- a/website/source/docs/post-processors/vagrant.html.md +++ b/website/source/docs/post-processors/vagrant.html.md @@ -45,6 +45,11 @@ providers. post-processor doesn't support creating boxes for a provider you care about, please help by contributing to Packer and adding support for it. +Please note that if you are using the Vagrant builder, then the Vagrant +post-processor is unnecesary because the output of the Vagrant builder is +already a Vagrant box; using this post-processor with the Vagrant builder will +cause your build to fail. + ## Configuration The simplest way to use the post-processor is to just enable it. No