Packer Automated VM Image and Vagrant Box Builds
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.rst

packer-build

What does this do?

These Packer templates and associated files may be used to build fresh Debian and Ubuntu virtual machine images for Vagrant, VirtualBox and QEMU.

The resulting image files may be used as bootable systems on real machines and the provided preseed files may also be used to install identical systems on bare metal as well.

While there are no limitations for running 32-bit x86 guests on 64-bit x86 hosts, this functionality has been deprecated here since 32-bit support is being phased out of Debian/Ubuntu "real soon now".

What dependencies does this have?

These templates are tested semi-regularly on recent Linux (Debian and/or Ubuntu) hosts using recent versions of Packer and Vagrant. All testing is currently done on systems that have amd64/x86_64-family processors.

The VirtualBox and QEMU versions used for Linux testing are normally the "stock" ones provided by the official distribution repositories.

  • REQUIRED: Packer (Packer_download)
    • 1.3.3 on Debian Stretch 9.x (VirtualBox and QEMU)
    • not currently being tested on macOS but used to work fine
  • REQUIRED (if not using QEMU): VirtualBox (VirtualBox_download)
    • 5.1.34 r121010 (Qt5.7.1) [5.1.34-121010~Debian~stretch] on Debian Stretch 9.x
    • not currently being tested on macOS but used to work fine
  • REQUIRED (if not using VirtualBox): QEMU (kvm)
    • 2.8.1(Debian 1:2.8+dfsg-6+deb9u3) [2.8+dfsg-6+deb9u3] on Debian Stretch 9.x
    • not currently being tested on macOS but used to work fine
  • OPTIONAL: Vagrant (Vagrant_download)
    • 2.2.3 on Debian Stretch 9.x (VirtualBox)
    • not currently being tested on macOS but used to work fine
  • BIG, BIG MAYBE: vagrant-libvirt plugin (QEMU provider for Vagrant)
    • Please refer to their page for version information, installation instructions and dependencies.

Even though Packer supports QEMU as an officially-supported provider, Vagrant, for some reason, does not. The 3rd-party plugin named "vagrant-libvirt" provides the missing QEMU support for Vagrant. We are unable at this time to verify this fact due to the following errors encountered while trying to run "vagrant up":

Error while connecting to libvirt: Error making a connection to libvirt URI qemu:///system?no_verify=1&keyfile=/home/whoa/.ssh/id_rsa:
Call to virConnectOpen failed: Failed to connect socket to '/var/run/libvirt/libvirt-sock': No such file or directory

It may be possible to correct this error by installing the libvirt-daemon-system package on Debian.

TODO Items

  • Get proper templating working for the preseed and vagrant files
  • [preseed debian] Find out if partman-crypto will allow passphrase-crypted
  • [preseed debian] Skip past "Force UEFI Install" installer prompt
  • [template qemu] Correct generated filenames for images to end in .img{,.gz}
  • [template vagrant] Dump checksum into vagrant manifest file + convert to JSON

Using Packer Templates

You must first generate templates using:

./script/generate_templates.sh

Then, you may run them using one or more of the following:

./script/vbox.sh [PACKER_OPTIONS] PACKER_TEMPLATE
./script/qemu.sh [PACKER_OPTIONS] PACKER_TEMPLATE

Examples:

./script/vbox.sh template/debian/buster/base.json

./script/vbox.sh -var headless=true -var version=1.0.0 -var vm_name=test \
    template/debian/buster/base.json

./script/qemu.sh -var-file=variables.json template/debian/buster/base.json

Contents of example file variables.json used above:

{
  "headless": true,
  "version": "1.0.0",
  "vm_name": "test"
}

Using Vagrant Box Files

A Vagrant box file is actually a regular gzipped tar archive containing...

  • box.ovf - Open Virtualization Format XML descriptor file
  • nameofmachine-disk1.vmdk - a virtual hard drive image file
  • Vagrantfile - derived from 'Vagrantfile.template'
  • metadata.json - containing just '{ "provider": "virtualbox" }'

An OVA file is actually a regular tar archive containing identical copies of the first 2 files that you would normally see in a Vagrant box file (but the OVF file may be named nameofmachine.ovf and it must be the first file or VirtualBox will get confused).

To create and use a Vagrant box file without a dedicated Vagrantfile:

./script/vbox.sh -var version=1.0.0 template/debian/buster/base.json
vagrant box add myname/buster \
    build/2038-01-19-03-14/base-buster-1.0.0.virtualbox.box
vagrant init myname/buster
vagrant up
vagrant ssh
...
vagrant destroy

In order to version things and self-host the box files, you will need to create a JSON file containing the following:

{
  "name": "base-buster",
  "description": "Base box for 64-bit x86 Debian Buster 10.x",
  "versions": [
    {
      "version": "1.0.0",
      "providers": [
        {
          "name": "virtualbox",
          "url": "http://server/vm/base-buster/base-buster-1.0.0-virtualbox.box",
          "checksum_type": "sha256",
          "checksum": "THESHA256SUMOFTHEBOXFILE"
        }
      ]
    }
  ]
}

SHA256 hashes are the largest ones that Vagrant supports, currently.

Then, simply make sure you point your Vagrantfile at this version payload:

Vagrant.configure('2') do |config|
  config.vm.box = 'base-buster'
  config.vm.box_url = 'http://server/vm/base-buster/base-buster.json'

  config.vm.synced_folder '.', '/vagrant', disabled: true
end

NOTE: You must ensure you disable the synched folder stuff above or you will encounter the following error:

Vagrant was unable to mount VirtualBox shared folders. This is usually
because the filesystem "vboxsf" is not available. This filesystem is
made available via the VirtualBox Guest Additions and kernel module.
Please verify that these guest additions are properly installed in the
guest. This is not a bug in Vagrant and is usually caused by a faulty
Vagrant box. For context, the command attempted was:

mount -t vboxsf -o uid=1000,gid=1000 vagrant /vagrant

The error output from the command was:

mount: unknown filesystem type 'vboxsf'

Making Bootable Drives

For best results, you should use the Packer QEMU "kvm" builder when trying to create bootable images to be used on real hardware. This allows the use of the "raw" block device format which is ideal for writing directly directly to USB and SATA drives. Alternately, you may use "qemu-img convert" or "vbox-img convert" to convert an exiting image in another format to raw mode:

./script/qemu.sh template/debian/buster/base.json
zcat build/2038-01-19-03-14/base-buster.raw.gz | dd of=/dev/sdz bs=4M

... Or, if you just want to "boot" it:

qemu-system-x86_64 -m 512M -machine type=pc,accel=kvm \
    build/2038-01-19-03-14/base-buster.raw

Overriding Local ISO Cache Location

You may override the default directory used instead of './packer_cache' by specifying it with the environment variable 'PACKER_CACHE_DIR':

PACKER_CACHE_DIR=/tmp packer build -only=vbox \
    template/debian/buster/base.json

You must always specify the PACKER_CACHE_DIR when using the provided templates due to a problem in packer where the PACKER_CACHE_DIR is not provided to the template if one was not provided; In this case, it will fall back to the default value of "./packer_cache".

Overriding Local VM Cache Location

vboxmanage setproperty machinefolder ${HOME}/vm

Disabling Hashicorp Checkpoint Version Checks

Both Packer and Vagrant will contact Hashicorp with some anonymous information each time it is being run for the purposes of announcing new versions and other alerts. If you would prefer to disable this feature, simply add the following environment variables:

CHECKPOINT_DISABLE=1
VAGRANT_CHECKPOINT_DISABLE=1

UEFI Booting on VirtualBox

It isn't necessary to perform this step when running on real hardware, however, VirtualBox (4.3.28) seems to have a problem if you don't perform this step.

To examine the actual contents of the file after editing it:

hexdump /boot/efi/startup.nsh

Using the EFI Shell Editor

To enter the UEFI shell text editor from the UEFI prompt:

edit startup.nsh

Type in the stuff to add to the file (the path to the UEFI blob):

FS0:\EFI\debian\grubx64.efi

To exit the UEFI shell text editor:

^S
^Q

Hex Result:

0000000 feff 0046 0053 0030 003a 005c 0045 0046
0000010 0049 005c 0064 0065 0062 0069 0061 006e
0000020 005c 0067 0072 0075 0062 0078 0036 0034
0000030 002e 0065 0066 0069
0000038

Using Any Old 'nix' Text Editor

To populate the file in a similar manner to the UEFI Shell method above:

echo 'FS0:\EFI\debian\grubx64.efi' > /boot/efi/startup.nsh

Hex Result:

0000000 5346 3a30 455c 4946 645c 6265 6169 5c6e
0000010 7267 6275 3678 2e34 6665 0a69
000001c

Serving Local Files via HTTP

./script/sow.py

Caching Debian/Ubuntu Packages

If you wish to speed up fetching lots of Debian and/or Ubuntu packages, you should probably install "apt-cacher-ng" on a machine and then add the following to each machine that should use the new cache:

echo "Acquire::http::Proxy 'http://localhost:3142';" >>\
    /etc/apt/apt.conf.d/99apt-cacher-ng

You must re-run "apt-cache update" each time you add or remove a proxy. If you populate the "d-i http/proxy string" value in your preseed file, all this stuff will have been done for you already.

Preseed Documentation

Other

Why did you use the Ubuntu Server installer to create desktop systems?

Building Windows VMs

Using a Headless Server

If you are using these scripts on a "headless" server (i.e.: no GUI), you must set the "headless" variable to "true" or you will encounter the following error:

...
==> virtualbox: Starting the virtual machine...
==> virtualbox: Error starting VM: VBoxManage error: VBoxManage: error: The virtual machine 'base-buster' has terminated unexpectedly during startup because of signal 6
==> virtualbox: VBoxManage: error: Details: code NS_ERROR_FAILURE (0x80004005), component MachineWrap, interface IMachine
...

Offical ISO Files

Debian

Ubuntu

Distro Release Names

Debian_releases

  • Bookworm (12.x); released on 2023?-??-??, supported until 2028?-??-01
  • Bullseye (11.x); released on 2021?-??-??, supported until 2026?-??-01
  • Buster (10.x); released on 2019?-??-??, supported until 2024?-??-01
  • Stretch (9.x); released on 2017-06-18, supported until 2022-06-01
  • Jessie (8.x); released on 2015-04-26, supported until 2020-04-01

Ubuntu_releases

  • Disco Dingo (19.04.x); released on 2019-04-??, supported until 2020?-02?-01
  • Cosmic Cuttlefish (18.10.x); released on 2018-10-18, supported until 2019-07-01
  • Bionic Beaver (18.04.x LTS); released on 2018-04-26, supported until 2023-04-01
  • Xenial Xerus (16.04.x LTS); released on 2016-04-21, supported until 2021-04-01
  • Trusty Tahr (14.04.x LTS); released on 2014-04-17, supported until 2019-04-01