extend export_opts documentation, add sample code (#3746)

This commit is contained in:
Steven Samuel Cole 2016-08-23 23:51:34 +02:00 committed by Rickard von Essen
parent dfae68dc6b
commit e88c1542e5
1 changed files with 38 additions and 2 deletions

View File

@ -83,8 +83,44 @@ builder.
specified, the default is 10 seconds.
- `export_opts` (array of strings) - Additional options to pass to the
`VBoxManage export`. This can be useful for passing product information to
include in the resulting appliance file.
[VBoxManage export](https://www.virtualbox.org/manual/ch08.html#vboxmanage-export).
This can be useful for passing product information to include in the
resulting appliance file. Packer JSON configuration file example:
``` {.json}
{
"type": "virtualbox-ovf",
"export_opts":
[
"--manifest",
"--vsys", "0",
"--description", "{{user `vm_description`}}",
"--version", "{{user `vm_version`}}"
],
"format": "ova",
}
```
A VirtualBox [VM description](https://www.virtualbox.org/manual/ch08.html#idm3756)
may contain arbitrary strings; the GUI interprets HTML formatting.
However, the JSON format does not allow arbitrary newlines within a
value. Add a multi-line description by preparing the string in the
shell before the packer call like this (shell `>` continuation
character snipped for easier copy & paste):
``` {.shell}
vm_description='some
multiline
description'
vm_version='0.2.0'
packer build \
-var "vm_description=${vm_description}" \
-var "vm_version=${vm_version}" \
"packer_conf.json"
```
- `floppy_files` (array of strings) - A list of files to place onto a floppy
disk that is attached when the VM is booted. This is most useful for