Merge pull request #10077 from hashicorp/document_3348

builder/qemu: docs: users must re-apply packer defaults for drive and device arguments
This commit is contained in:
Megan Marsh 2020-10-13 11:41:28 -07:00 committed by GitHub
commit 4810a3d86f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 16 deletions

View File

@ -208,19 +208,27 @@ type Config struct {
// the builder. By default this is output-BUILDNAME where "BUILDNAME" is the // the builder. By default this is output-BUILDNAME where "BUILDNAME" is the
// name of the build. // name of the build.
OutputDir string `mapstructure:"output_directory" required:"false"` OutputDir string `mapstructure:"output_directory" required:"false"`
// Allows complete control over the qemu command line (though not, at this // Allows complete control over the qemu command line (though not qemu-img).
// time, qemu-img). Each array of strings makes up a command line switch // Each array of strings makes up a command line switch
// that overrides matching default switch/value pairs. Any value specified // that overrides matching default switch/value pairs. Any value specified
// as an empty string is ignored. All values after the switch are // as an empty string is ignored. All values after the switch are
// concatenated with no separator. // concatenated with no separator.
// //
// ~> **Warning:** The qemu command line allows extreme flexibility, so // ~> **Warning:** The qemu command line allows extreme flexibility, so
// beware of conflicting arguments causing failures of your run. For // beware of conflicting arguments causing failures of your run.
// instance, using --no-acpi could break the ability to send power signal // For instance adding a "--drive" or "--device" override will mean that
// type commands (e.g., shutdown -P now) to the virtual machine, thus // none of the default configuration Packer sets will be used. To see the
// preventing proper shutdown. To see the defaults, look in the packer.log // defaults that Packer sets, look in your packer.log
// file and search for the qemu-system-x86 command. The arguments are all // file (set PACKER_LOG=1 to get verbose logging) and search for the
// printed for review. // qemu-system-x86 command. The arguments are all printed for review, and
// you can use those arguments along with the template engines allowed
// by qemu-args to set up a working configuration that includes both the
// Packer defaults and your extra arguments.
//
// Another pitfall could be setting arguments like --no-acpi, which could
// break the ability to send power signal type commands
// (e.g., shutdown -P now) to the virtual machine, thus preventing proper
// shutdown.
// //
// The following shows a sample usage: // The following shows a sample usage:
// //

View File

@ -136,19 +136,27 @@
the builder. By default this is output-BUILDNAME where "BUILDNAME" is the the builder. By default this is output-BUILDNAME where "BUILDNAME" is the
name of the build. name of the build.
- `qemuargs` ([][]string) - Allows complete control over the qemu command line (though not, at this - `qemuargs` ([][]string) - Allows complete control over the qemu command line (though not qemu-img).
time, qemu-img). Each array of strings makes up a command line switch Each array of strings makes up a command line switch
that overrides matching default switch/value pairs. Any value specified that overrides matching default switch/value pairs. Any value specified
as an empty string is ignored. All values after the switch are as an empty string is ignored. All values after the switch are
concatenated with no separator. concatenated with no separator.
~> **Warning:** The qemu command line allows extreme flexibility, so ~> **Warning:** The qemu command line allows extreme flexibility, so
beware of conflicting arguments causing failures of your run. For beware of conflicting arguments causing failures of your run.
instance, using --no-acpi could break the ability to send power signal For instance adding a "--drive" or "--device" override will mean that
type commands (e.g., shutdown -P now) to the virtual machine, thus none of the default configuration Packer sets will be used. To see the
preventing proper shutdown. To see the defaults, look in the packer.log defaults that Packer sets, look in your packer.log
file and search for the qemu-system-x86 command. The arguments are all file (set PACKER_LOG=1 to get verbose logging) and search for the
printed for review. qemu-system-x86 command. The arguments are all printed for review, and
you can use those arguments along with the template engines allowed
by qemu-args to set up a working configuration that includes both the
Packer defaults and your extra arguments.
Another pitfall could be setting arguments like --no-acpi, which could
break the ability to send power signal type commands
(e.g., shutdown -P now) to the virtual machine, thus preventing proper
shutdown.
The following shows a sample usage: The following shows a sample usage: