brycekahle / bento

Packer templates for building minimal Vagrant baseboxes for multiple platforms

Bento

Bento is a project that encapsulates Packer templates for building Vagrant base boxes. A subset of templates are built and published to the bento org on Vagrant Cloud. These published boxes serve as the default boxes for kitchen-vagrant.

*NOTE:

• Virutalbox 7.x requires extra config to allow nat network to connect to the host. To use uncomment lines #154 and #155 in bento/packer_templates/pkr-variables.pkr.hcl
• When running packer build command the output directory is relative to the working directory the command is currently running in. Suggest running packer build commands from bento root directory for build working files to be placed in bento/builds/(build_name) directory by default. If the output_directory variable isn't overwritten a directory called builds/(build_name) will be created in the current working directory that you are running the command from

Using Public Boxes

Adding a bento box to Vagrant

vagrant box add bento/ubuntu-18.04

Using a bento box in a Vagrantfile

Vagrant.configure("2") do |config|
  config.vm.box = "bento/ubuntu-18.04"
end

Building Boxes

Requirements

• Packer >= 1.7.0
• Vagrant
• At least one of the following virtualization providers:
  • VirtualBox
  • VMware Fusion
  • VMware Workstation
  • Parallels Desktop also requires Parallels Virtualization SDK
  • qemu *
  • Hyper-V *

*NOTE: support for these providers is considered experimental and corresponding Vagrant Cloud images may or may not exist.

Using packer

To build a Ubuntu 22.04 box for only the VirtualBox provider

cd <path/to>/bento
packer init -upgrade ./packer_templates
packer build -only=virtualbox-iso.vm -var-file=os_pkrvars/ubuntu/ubuntu-22.04-x86_64.pkrvars.hcl ./packer_templates

To build latest Debian 11 boxes for all possible providers (simultaneously)

cd <path/to>/bento
packer init -upgrade ./packer_templates
packer build -var-file=os_pkrvars/debian/debian-11-x86_64.pkrvars.hcl ./packer_templates

To build latest CentOS 7 boxes for all providers except VMware and Parallels

cd <path/to>/bento
packer init -upgrade ./packer_templates
packer build -except=parallels-iso.vm,vmware-iso.vm -var-file=os_pkrvars/centos/centos-7-x86_64.pkrvars.hcl ./packer_templates

To use an alternate url

cd <path/to>/bento
packer init -upgrade ./packer_templates
packer build -var 'iso_url=http://mirror.utexas.edu/fedora/linux' -var-file=os_pkrvars/fedora/fedor-37-x86_64.pkrvars.hcl ./packer_templates

To build a Windows 10 Enterprise Gen 2 box for the Hyper-V provider

cd <path/to>/bento
packer init -upgrade ./packer_templates
packer build -var-file=os_pkrvars/windows/windows-10gen2-x86_64.pkrvars.hcl ./packer_templates

If the build is successful, your box files will be in the builds directory at the root of the repository.

KVM/qemu support for Windows

You must download the iso image with the Windows drivers for paravirtualized KVM/qemu hardware. You can do this from the command line: wget -nv -nc https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso -O virtio-win.iso.

You can use the following sample command to build a KVM/qemu Windows box:

packer init -upgrade ./packer_templates
packer build --only=qemu.vm -var-file=os_pkrvars/windwos/windows-2022-x86_64.pkrvars.hcl ./packer_templates

Proprietary Templates

Templates for operating systems only available via license or subscription are also available in the repository, these include but are not limited to: Red Hat Enterprise Linux, and SUSE Linux Enterprise. As the ISOs are not publicly available the URL values will need to be overridden as appropriate. We rely on the efforts of those with access to licensed versions of the operating systems to keep these up-to-date.

Networking/Firewalls

Most of the providers expect unrestricted access to networking in order to build as expected. We can't enumerate all possible firewall configurations but include some snippets below that might be useful to users.

Windows

$VS = "Standardswitch"
$IF_ALIAS = (Get-NetAdapter -Name "vEthernet ($VS)").ifAlias
New-NetFirewallRule -Displayname "Allow incomming from $VS" -Direction Inbound -InterfaceAlias $IF_ALIAS -Action Allow

Hyper-V Generation 2 VM's

Hyper-V Gen 2 VMs do not support floppy drives. If you previously provided resources using a floppy drive, you must add those files to your Gen 2 iso images, in particular:

• autounattend.xml: The Gen 2 autounattend.xml file supports EFI partitions. Update the autounattend.xml with the correct Windows version for your systems and ensure that the partitions are correct for your situation. You also need to manage the driver disk that holds the hyper-v guest services drivers and adjust the autounattend.xml file as appropriate.
• base_setup.ps1

Testing the build with the test-kitchen

If you have successfully built a vagrant box using the bento tool, you should have the vagrant box and a metadata file in the builds folder. You can use these files to test the build with a test-kitchen configuration. Place your kitchen.yml and bootstrap.sh files inside the templates directory and run the following command to test the build.

kitchen test

Bugs and Issues

Please use GitHub issues to report bugs, features, or other problems.

Related projects

A huge thank you to these related projects from which we've taken inspiration and often used as a source for workarounds in complex world of base box building.

• https://github.com/boxcutter
• https://github.com/lavabit/robox
• https://github.com/mcandre/packer-templates
• https://github.com/timsutton/osx-vm-templates
• https://github.com/ferventcoder/vagrant-windows-puppet/tree/master/baseboxes

License & Authors

These basebox templates were converted from veewee definitions originally based on work done by Tim Dysinger to make "Don't Repeat Yourself" (DRY) modular baseboxes. Thanks Tim!

• Author: Chris McClimans ([e-mail])
• Author: Fletcher Nichol ([e-mail])
• Author: Joshua Timberman ([e-mail])
• Author: Julian Dunn ([e-mail])
• Author: Ross Timson ([e-mail])
• Author: Seth Chisamore ([e-mail])
• Author: Stephen Delano ([e-mail])
• Author: Tim Dysinger ([e-mail])
• Author: Tim Smith ([e-mail])
• Author: Tom Duffield ([e-mail])
• Author: Corey Hemminger ([e-mail])

Copyright 2012-2022, Progress Software, Inc. (<[e-mail]>)
Copyright 2011-2012, Tim Dysinger (<[e-mail]>)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.