INDEX

Quick PeerOS Install


Basic setup using Vagrant with other supported hypervisors

You can launch your own peers using Vagrant and the hypervisor of your choice. This guide shows you how to set up the supported Vagrant provider and use a Vagrant box created by Subutai to launch your peer.


Prerequisites Before installing a provider, it is important that you have configured Vagrant and the hypervisor of your choice. Some hypervisors may require additional configuration, which is outside the scope of this guide. You also need the Vagrant Subutai plugin installed on your system.


Supported providers

At Subutai, we have built Vagrant boxes, available on Vagrant Cloud, for the following Vagrant providers:

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 the following boxes with the respective Vagrant provider.

In case you encounter an error during installation, see Common errors encountered when using Vagrant plugins.

Libvirt setup

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

💡 Vagrant 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.

  2. Install the Vagrant Libvirt provider plugin.

    ❗️ Before installing the provider, be sure that you have all the build dependencies for your Linux distribution. Refer to the detailed instructions here.

    vagrant plugin install vagrant-libvirt

  3. Launch a Subutai Peer using the Stretch box with the Libvirt provider.

    vagrant init subutai/stretch vagrant up --provider libvirt

Parallels Desktop setup

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 only):

  1. Install the Parallels Desktop for Mac.

  2. Install the Vagrant Parallels Provider plugin.

    vagrant plugin install vagrant-parallels

    For more information about this provider, see the documentation here.

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

    vagrant init subutai/stretch vagrant up --provider parallels

VMware Fusion and Workstation setup

The Vagrant VMware plugin, a commercial product provided by HashiCorp, requires the purchase of a provider 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 installed either one of these supported hypervisors:

  2. Install the Vagrant VMware Desktop Provider plugin.

    Before installing, be sure to do the following first:

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

    b. Initiate the Vagrant VMware Desktop provider plugin installation.

    ✔️ Go here for detailed instructions about the installation and license setup.

    vagrant plugin install vagrant-vmware-desktop

  3. 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 setup

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.

  1. Install Hyper-V or VirtualBox on your machine.

    ❗️ 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.

    If you encounter errors while installing VirtualBox on MacOS, you may refer to the guide here.

  2. Now, let’s launch a peer using the Stretch box with the provider:

    • Vagrant Hyper-V provider

      vagrant init subutai/stretch vagrant up --provider hyperv

      ✔️ After running vagrant up, when asked to choose a switch, select the option for vagrant-subutai.

    • Vagrant VirtualBox provider

      vagrant plugin install vagrant-vbguest vagrant init subutai/stretch vagrant up --provider virtualbox