Vagrant Backend¶
The Vagrant backend is used to spin up clusters on Vagrant virtual machines, where each virtual machine is a DC/OS node.
Requirements¶
Hardware¶
A minimum of 2 GB of free memory is required per DC/OS node.
ssh
¶
The ssh
command must be available to use the SSH
transport.
Vagrant by HashiCorp¶
Vagrant must be installed. This has been tested with:
Vagrant 2.1.1
Vagrant 2.1.2
Oracle VirtualBox¶
VirtualBox must be installed. This has been tested with VirtualBox 5.1.18.
vagrant-vbguest
plugin¶
vagrant-vbguest must be installed.
doctor
command¶
DC/OS E2E comes with the minidcos vagrant doctor
command.
Run this command to check your system for common causes of problems.
Reference¶
-
class
dcos_e2e.backends.
Vagrant
(virtualbox_description='', workspace_dir=None, vm_memory_mb=2048, vagrant_box_version='~> 0.10', vagrant_box_url='https://downloads.dcos.io/dcos-vagrant/metadata.json')¶ Create a configuration for a Vagrant cluster backend.
- Parameters
workspace_dir¶ (
Optional
[Path
]) – The directory in which large temporary files will be created. These files will be deleted at the end of a test run. This is equivalent to dir intempfile.mkstemp()
.virtualbox_description¶ (
str
) – A description string to add to VirtualBox VMs.vm_memory_mb¶ (
int
) – The amount of memory in megabytes allocated to each VM.vagrant_box_version¶ (
str
) – The Vagrant box version to use. See https://www.vagrantup.com/docs/boxes/versioning.html#version-constraints for version details.
-
workspace_dir
¶ The directory in which large temporary files will be created. These files will be deleted at the end of a test run.
-
virtualbox_description
¶ A description string to add to VirtualBox VMs.
-
vm_memory_mb
¶ The amount of memory in megabytes allocated to each VM.
-
vagrant_box_version
¶ The Vagrant box version to use. See https://www.vagrantup.com/docs/boxes/versioning.html#version-constraints for version details.
-
vagrant_box_url
¶ The URL of the Vagrant box to use.