Vagrant

From ArchWiki
Jump to: navigation, search

Related articles

Vagrant is a tool for managing and configuring virtualised development environments.

Vagrant has a concept of 'providers', which map to the virtualisation engine and its API. The most popular and well-supported provider is Virtualbox; plugins exist for libvirt, kvm, lxc, vmware and more.

Vagrant uses a mostly declarative Vagrantfile to define virtualised machines. A single Vagrantfile can define multiple machines.

Installation

Install package vagrant.

Plugins

Vagrant has a middleware architecture providing support for powerful plugins.

Plugins can be installed with Vagrant's built-in plugin manager. You can specify multiple plugins to install:

$ vagrant plugin install vagrant-vbguest vagrant-share

vagrant-libvirt

This plugin adds a libvirt provider to Vagrant. The gcc and make packages must be installed before this plugin can be installed, and libvirt and related packages must be installed and configured before using the libvirt provider.

At the time of writing (using Vagrant version 1.8.1), a normal installation of this plugin fails on Arch Linux. The plugin can be successfully installed with this workaround:

$ CONFIGURE_ARGS='with-ldflags=-L/opt/vagrant/embedded/lib with-libvirt-include=/usr/include/libvirt with-libvirt-lib=/usr/lib' \
  GEM_HOME=~/.vagrant.d/gems GEM_PATH=$GEM_HOME:/opt/vagrant/embedded/gems PATH=/opt/vagrant/embedded/bin:$PATH \
  vagrant plugin install vagrant-libvirt

Once the plugin is installed the libvirt provider will be available:

$ vagrant up --provider=libvirt

vagrant-lxc

First install lxc from the official repositories, then:

$ vagrant plugin install vagrant-lxc

Next, configure lxc and some systemd unit files per this comment. The plugin can now be used with a Vagrantfile like so:

VAGRANTFILE_API_VERSION = "2"

Vagrant.configure("2") do |config|

    config.vm.define "main" do |config|
        config.vm.box = 'http://bit.ly/vagrant-lxc-wheezy64-2013-10-23'

        config.vm.provider :lxc do |lxc|
            lxc.customize 'cgroup.memory.limit_in_bytes', '512M'
        end

        config.vm.provision :shell do |shell|
            shell.path = 'provision.sh'
        end
    end
end

The provision.sh file should be a shell script beside the Vagrantfile. Do whatever setup is appropriate; for example, to remove puppet, which is packaged in the above box:

rm /etc/apt/sources.list.d/puppetlabs.list
apt-get purge -y puppet facter hiera puppet-common puppetlabs-release ruby-rgen

vagrant-kvm (deprecated)

This plugin supports KVM as the virtualisation provider.

Vagrant installs a self-contained rainbow environment in /opt which interacts with the system Ruby and other libraries in Arch in confusing ways (Issue with Ruby, Issue with Curl library).

Please see and follow the complete installation guide for Arch Linux at vagrant-kvm wiki.

Provisioning

Provisioners allow you to automatically install software, alter and automate configurations as part of the vagrant up process. The two most common provisioners are puppet from official repositories and chefAUR[broken link: archived in aur-mirror] from the AUR Arch User Repository.

Base Boxes for Vagrant

Here is a list of places to get all sorts of vagrant base boxes for different purposes: development, testing, or even production.

  • The same Arch Linux x86_64 base box can also be obtained via Vagrant Cloud by running: vagrant init terrywang/archlinux
  • Vagrant Cloud is HashiCorp's official site for Vagrant boxes. You can browse user-submitted boxes or upload your own. A single Vagrant Cloud box can support multiple providers with versioning.
  • Opscode bento
    We all know what bento means in Japanese, right? In this case, they are NOT lunch boxes BUT extremely useful base boxes which can be used to test cookbooks or private chef (Chef Server and Client). Distributions included: Ubuntu Server, Debian, CentOS, Fedora and FreeBSD.
  • Vagrant Ubuntu Cloud Images
    It has been there since Jan, 2013. For some reason Canonical has NOT officially promoted it yet, may be still in beta. Remember these are vanilla images, NOT very useful without Chef or Puppet.

Troubleshooting

No ping between host and vagrant box (host-only networking)

Sometimes there are troubles with host-only networking not functioning. Host have no ip on vboxnet interface, host cannot ping vagrant boxes and cannot be pinged from them. This is solved by installing good old net-tools as mentioned in this thread by kevin1024

'vagrant up' hangs on NFS mounting (Mounting NFS shared folders...)

Installing net-tools package may solve this problem.

Error starting network 'default': internal error: Failed to initialize a valid firewall backend

Most likely the firewall dependencies were not installed. Install the ebtables and dnsmasq packages and restart the libvirtd systemd service.

See also