How to Install and Use Vagrant Providers

You can launch your own peers through Subutai virtual machines using Vagrant, a tool for running virtual machines on different hypervisors. This guide shows you how to install and use Vagrant providers, presuming that you have configured the hypervisor of your choice and installed the Vagrant Subutai plugin. If you have not installed this plugin, see Vagrant Subutai Plugin. Some hypervisors may require additional configuration, which is outside the scope of this guide.

Subutai has built Vagrant boxes, available on the Vagrant Cloud, for the following Vagrant providers:

Vagrant provider (supported versions/editions)	Supported OS
	Linux	Mac	Windows
VirtualBox (5.2.0 or higher)	✅	✅	✅
Libvirt	✅
Hyper-V (8.1 or higher)			✅
VMware Workstation (regular and Pro)	✅		✅
VMware Fusion (regular and Pro)		✅
Parallels Desktop (10 or higher; only Pro and Business editions)		✅

You can use following box for each supported Vagrant provider.

• Debian 9.x (Stretch) https://app.vagrantup.com/subutai/boxes/stretch

Libvirt

Between Libvirt's QEMU and KVM hypervisors with remote management capabilities, the Vagrant Subutai plugin currently supports only the local KVM hypervisor.

Note: Vagrantfile modifications can be made to create remote KVM-based virtual machines, but that is beyond the scope of this guide.

To install and use the provider, on Linux variants only:

1. Install the KVM hypervisor on your local machine.

• For instructions on Ubuntu, visit their wiki site.
• For instructions on Debian, visit their wiki site.

2. Install the Vagrant Libvirt Provider plugin.

   vagrant plugin install vagrant-libvirt

   For detailed instructions, see the documentation here.

   Before installing vagrant-libvirt provider, make sure to install its dependency packages from here.

3. Install the Vagrant Subutai plugin.

   vagrant plugin install vagrant-subutai

   For detailed instructions, see the documentation here.

4. Launch a Subutai Peer using the Stretch box for the Libvirt provider.

   vagrant init subutai/stretch

   vagrant up --provider libvirt

Parallels Desktop

For this commercial desktop hypervisor, only Parallels version 10 and above are supported and only the Pro and Business editions can be used with the Vagrant Parallels provider.

To install and use the provider on Mac:

1. Install the Parallels Desktop for Mac.

2. Install the Vagrant Parallels Provider plugin.

   vagrant plugin install vagrant-parallels

3. Install the Vagrant Subutai plugin.

   vagrant plugin install vagrant-subutai

   For detailed instructions, see the documentation here.

4. Launch a Subutai Peer using the Stretch box for the Parallels provider.

   vagrant init subutai/stretch

   vagrant up --provider parallels

VMware Fusion and Workstation

The Vagrant VMware plugin, a commercial product provided by HashiCorp, requires the purchase of a license to operate. To purchase a license, visit the Vagrant VMware provider page. The Vagrant VMware plugin is compatible with both the regular and Pro versions of VMware Fusion and VMware Workstation.

To install and use the provider:

1. Make sure that you have VMware Workstation (Linux and Windows) or VMware Fusion (Mac OS) already installed.

2. Install the Vagrant VMware Desktop Provider plugin.

   a. Install the Vagrant VMware Utility, a system installation package available for download here.

   b. Initiate the installation of the Vagrant VMware Desktop Provider plugin.

   vagrant plugin install vagrant-vmware-desktop

3. Install the Vagrant Subutai plugin.

   vagrant plugin install vagrant-subutai

   For detailed instructions, see the documentation here.

4. Launch a Subutai Peer using the stretch box for the VMWare Desktop Provider:

   vagrant init subutai/stretch

   vagrant up --provider vmware_desktop

Hyper-V and VirtualBox

Vagrant comes ready with a built-in provider for Hyper-V and VirtualBox, so you do not need to install one. The Hyper-V provider is compatible with Windows Enterprise, Professional, or Education 8.1 and higher versions only.

Note: Hyper-V requires that you execute Vagrant with Administrative privileges. The same privileges are required when creating and managing virtual machines with Hyper-V. Vagrant displays an error if you do not have the proper permissions

Install the Hyper-V on Windows 10 machine.

Let’s launch a Subutai Peer using the Stretch box with the:

• Vagrant Hyper-V provider:

  vagrant plugin install vagrant-subutai

  vagrant init subutai/stretch

  vagrant up --provider hyperv

• Vagrant VirtualBox provider:

  vagrant plugin install vagrant-subutai

  vagrant plugin install vagrant-vbguest

  vagrant init subutai/stretch

  vagrant up --provider virtualbox