266 lines
6.7 KiB
Plaintext
266 lines
6.7 KiB
Plaintext
---
|
|
modeline: |
|
|
vim: set ft=pandoc:
|
|
description: >
|
|
The VirtualBox Packer builder is able to create VirtualBox virtual machines
|
|
snapshots
|
|
|
|
and export them in the OVF format, starting from an ISO image.
|
|
layout: docs
|
|
page_title: VirtualBox Snapshot - Builders
|
|
sidebar_title: VM
|
|
---
|
|
|
|
# VirtualBox Builder (from an existing VM)
|
|
|
|
Type: `virtualbox-vm`
|
|
|
|
The VirtualBox Packer builder is able to create
|
|
[VirtualBox](https://www.virtualbox.org/) virtual machines snapshots and
|
|
(optionally) export them in the OVF format, starting from an **existing**
|
|
virtual machine.
|
|
|
|
The builder builds a virtual machine snapshot by using an existing virtual
|
|
machine, booting it, provisioning software within the OS, then shutting it down.
|
|
The result of the VirtualBox builder is a new snapshot persisting all changes
|
|
from the applied provisioners.
|
|
|
|
## Basic Example
|
|
|
|
Here is a basic example. which serves to show the basic configuration:
|
|
|
|
<Tabs>
|
|
<Tab heading="JSON">
|
|
|
|
```json
|
|
{
|
|
"type": "virtualbox-vm",
|
|
"communicator": "winrm",
|
|
"headless": "{{user `headless`}}",
|
|
"winrm_username": "vagrant",
|
|
"winrm_password": "vagrant",
|
|
"winrm_timeout": "2h",
|
|
"shutdown_command": "shutdown /s /t 10 /f /d p:4:1 /c \"Packer Shutdown\"",
|
|
"guest_additions_mode": "disable",
|
|
"output_directory": "./builds-vm",
|
|
"vm_name": "target-vm",
|
|
"attach_snapshot": "Snapshot",
|
|
"target_snapshot": "Target-Snapshot",
|
|
"force_delete_snapshot": "true",
|
|
"keep_registered": "false",
|
|
"skip_export": "false"
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
<Tab heading="HCL2">
|
|
|
|
```hcl
|
|
source "virtualbox-vm" "basic-example" {
|
|
communicator = "winrm"
|
|
headless = "{{user `headless`}}"
|
|
winrm_username = "vagrant"
|
|
winrm_password = "vagrant"
|
|
winrm_timeout = "2h"
|
|
shutdown_command = "shutdown /s /t 10 /f /d p:4:1 /c \"Packer Shutdown\""
|
|
guest_additions_mode = "disable"
|
|
output_directory = "./builds-vm"
|
|
vm_name = "target-vm"
|
|
attach_snapshot = "Snapshot"
|
|
target_snapshot = "Target-Snapshot"
|
|
force_delete_snapshot = true
|
|
keep_registered = false
|
|
skip_export = false
|
|
}
|
|
|
|
build {
|
|
sources = ["sources.virtualbox-vm.basic-example"]
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
It is important to add a `shutdown_command`. By default Packer halts the virtual
|
|
machine and the file system may not be sync'd. Thus, changes made in a
|
|
provisioner might not be saved.
|
|
|
|
## Configuration Reference
|
|
|
|
There are many configuration options available for the builder. In addition to
|
|
the items listed here, you will want to look at the general configuration
|
|
references for [ISO](#iso-configuration),
|
|
[HTTP](#http-directory-configuration),
|
|
[Floppy](#floppy-configuration),
|
|
[CD](#CD-configuration),
|
|
[Export](#export-configuration),
|
|
[Boot](#boot-configuration),
|
|
[Shutdown](#shutdown-configuration),
|
|
[Run](#run-configuration),
|
|
[Communicator](#communicator-configuration)
|
|
configuration references, which are
|
|
necessary for this build to succeed and can be found further down the page.
|
|
In addition to the options listed here, a
|
|
[communicator](/docs/templates/communicator) can be configured for this
|
|
builder.
|
|
|
|
### Required:
|
|
|
|
@include 'builder/virtualbox/vm/Config-required.mdx'
|
|
|
|
### Optional:
|
|
|
|
@include 'builder/virtualbox/vm/Config-not-required.mdx'
|
|
|
|
@include 'builder/virtualbox/common/VBoxVersionConfig-not-required.mdx'
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/ShutdownConfig-not-required.mdx'
|
|
|
|
### Http directory configuration
|
|
|
|
@include 'common/commonsteps/HTTPConfig.mdx'
|
|
|
|
#### Optional:
|
|
|
|
@include 'common/commonsteps/HTTPConfig-not-required.mdx'
|
|
|
|
### Floppy configuration
|
|
|
|
@include 'common/commonsteps/FloppyConfig.mdx'
|
|
|
|
#### Optional:
|
|
|
|
@include 'common/commonsteps/FloppyConfig-not-required.mdx'
|
|
|
|
### CD configuration
|
|
|
|
@include 'common/commonsteps/CDConfig.mdx'
|
|
|
|
#### Optional:
|
|
|
|
@include 'common/commonsteps/CDConfig-not-required.mdx'
|
|
|
|
### Export configuration
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/ExportConfig-not-required.mdx'
|
|
|
|
### Output configuration
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/OutputConfig-not-required.mdx'
|
|
|
|
### Run configuration
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/RunConfig-not-required.mdx'
|
|
|
|
### Shutdown configuration
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/ShutdownConfig-not-required.mdx'
|
|
|
|
### Hardware configuration
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/HWConfig-not-required.mdx'
|
|
|
|
### VBox Manage configuration
|
|
|
|
#### Optional:
|
|
|
|
@include 'builder/virtualbox/common/VBoxManageConfig-not-required.mdx'
|
|
|
|
### Communicator configuration
|
|
|
|
#### Optional common fields:
|
|
|
|
@include 'helper/communicator/Config-not-required.mdx'
|
|
|
|
@include 'builder/virtualbox/common/CommConfig-not-required.mdx'
|
|
|
|
#### Optional SSH fields:
|
|
|
|
@include 'helper/communicator/SSH-not-required.mdx'
|
|
|
|
#### Optional WinRM fields:
|
|
|
|
@include 'helper/communicator/WinRM-not-required.mdx'
|
|
|
|
### Boot Configuration
|
|
|
|
@include 'common/bootcommand/BootConfig.mdx'
|
|
|
|
Please note that for the Virtuabox builder, the IP address of the HTTP server
|
|
Packer launches for you to access files like the preseed file in the example
|
|
above (`{{ .HTTPIP }}`) is hardcoded to 10.0.2.2. If you change the network
|
|
of your VM you must guarantee that you can still access this HTTP server.
|
|
|
|
The boot command is sent to the VM through the `VBoxManage` utility in as few
|
|
invocations as possible. We send each character in groups of 25, with a default
|
|
delay of 100ms between groups. The delay alleviates issues with latency and CPU
|
|
contention. If you notice missing keys, you can tune this delay by specifying
|
|
"boot_keygroup_interval" in your Packer template, for example:
|
|
|
|
<Tabs>
|
|
<Tab heading="JSON">
|
|
|
|
```json
|
|
{
|
|
"builders": [
|
|
{
|
|
"type": "virtualbox-vm",
|
|
"boot_keygroup_interval": "500ms"
|
|
...
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
<Tab heading="HCL2">
|
|
|
|
```hcl
|
|
source "virtualbox-vm" "basic-example" {
|
|
boot_keygroup_interval = "500ms"
|
|
# ...
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
#### Optional:
|
|
|
|
@include 'common/bootcommand/BootConfig-not-required.mdx'
|
|
|
|
@include 'builders/virtualbox-ssh-key-pair.mdx'
|
|
|
|
## Guest Additions
|
|
|
|
Packer will automatically download the proper guest additions for the version of
|
|
VirtualBox that is running and upload those guest additions into the virtual
|
|
machine so that provisioners can easily install them.
|
|
|
|
Packer downloads the guest additions from the official VirtualBox website, and
|
|
verifies the file with the official checksums released by VirtualBox.
|
|
|
|
After the virtual machine is up and the operating system is installed, Packer
|
|
uploads the guest additions into the virtual machine. The path where they are
|
|
uploaded is controllable by `guest_additions_path`, and defaults to
|
|
"VBoxGuestAdditions.iso". Without an absolute path, it is uploaded to the home
|
|
directory of the SSH user.
|
|
|
|
## VBoxManage Commands
|
|
|
|
@include 'builder/virtualbox/common/VBoxManageConfig.mdx'
|
|
|
|
@include 'builder/virtualbox/common/VBoxManageConfig-not-required.mdx'
|