Skip to content

Latest commit

 

History

History
256 lines (206 loc) · 8.56 KB

vagrant.md

File metadata and controls

256 lines (206 loc) · 8.56 KB
Raw

Vagrant

Vagrant's slogan is "development environments made easy". Vagrant provides an abstraction on top of a VM or cloud provider that allows you to manage hosts and their provisioning. https://www.vagrantup.com/.

Getting Started

Requirements

A prerequisite for using the vagrant hypervisor with beaker is that the Vagrant package, minimum version 1.7, needs to installed. Version 2.1.2 (latest as of time of writing) has been tested. See downloads.vagrantup.com for downloads or install with Homebrew:

$ brew install cask vagrant

You will also need a virtualization provider. Beaker-vagrant is most commonly used as an interface to VirtualBox, so you'll also need that:

$ brew install cask virtualbox

Historically, we provided a suite of pre-built, publicly available Vagrant boxes for use in constructing tests: Puppet Labs Vagrant Boxes. However, these boxes have not been updated recently and will have issues (ex: outdated cURL on CentOS). You can use these easily by pulling one of our Example Vagrant Hosts Files, but this should be avoided if possible.

For acceptance testing of beaker-vagrant, we use the official CentOS 7 box.

Setup a Vagrant Hosts File

A vm is identified by box or box_url in the config file. No snapshot name is required as the vm is reverted back to original state post testing using vagrant destroy --force.

Example Vagrant hosts file

HOSTS:
  ubuntu-1404-x64:
    roles:
      - master
      - agent
      - dashboard
      - cloudpro
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
CONFIG:
  nfs_server: none
  consoleport: 443

VagrantFiles are created per host configuration file. They can be found in the .vagrant/beaker_vagrant_files directory of the current working directory in a subdirectory named after the host configuration file.

> beaker --hosts sample.cfg
> cd .vagrant/beaker_vagrant_files; ls
sample.cfg
> cd sample.c

Below are details of vagrants features as they're supported through beaker. If you'd like to see more examples of vagrant hosts files, checkout our vagrant hosts file examples doc.

Vagrant-Specific Hosts File Settings

Running With a GUI

It is possible to have the VirtualBox VM run with a GUI (i.e. non-headless mode) by specifying vb_gui of any non-nil value in the config file, i.e.:

Example Vagrant hosts file with vb_gui

HOSTS:
  ubuntu-1404-x64:
    roles:
      - master
      - agent
      - dashboard
      - cloudpro
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    vb_gui: true
CONFIG:
  nfs_server: none
  consoleport: 443

Mounting Local Folders

When using the Vagrant Hypervisor, beaker can mount specific local directories as synced_folders inside the vagrant box. This is done by using the mount_folders option in the nodeset file.

Example hosts file

HOSTS:
  ubuntu-1404-x64-master:
    roles:
      - master
      - agent
      - dashboard
      - database
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    mount_folders:
      folder1:
        from: ./
        to: /vagrant/folder1
      tmp:
        from: /tmp
        to: /vagrant/tmp
    ip: 192.168.20.20
  ubuntu-1404-x64-agent:
    roles:
      - agent
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    ip: 192.168.21.21
CONFIG:
  nfs_server: none
  consoleport: 443

In the above beaker will mount the folders ./ to /vagrant/folder1 and the folder /tmp to /vagrant/tmp.

Forwarding Ports to Guest

When using the Vagrant Hypervisor, beaker can create the Vagrantfile to forward specified ports to a specific box. This is done by using the forwarded_ports option in the nodeset file.

Example hosts file

HOSTS:
  ubuntu-1404-x64-master:
    roles:
      - master
      - agent
      - dashboard
      - database
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    ip: 192.168.20.20
  ubuntu-1404-x64-agent:
    roles:
      - agent
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    ip: 192.168.21.21
    forwarded_ports:
      apache:
        from: 10080
        to: 80
      tomcat:
        from: 8080
        to: 8080
        from_ip: '127.0.0.1'
        to_ip: '0.0.0.0'

In the above, beaker will forward port 10080 and 8080 on the Host to port 80 and 8080 (respectively) on the Agent guest.

Volumes Support

When using the Vagrant Hypervisor, beaker can create attached volumes which appear as extra disks on the guest. The size of the volume should be specified in megabytes. You can override the type of storage controller used to attach the disk by specifying volume_storage_controller with values of AHCI, LSILogic, USB, or PIIX4.

Example hosts file

HOSTS:
  ubuntu-1404-x64:
    roles:
      - master
      - agent
      - dashboard
      - cloudpro
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    volumes:
      second_disk:
        size: 5120
    volume_storage_controller: USB

Adding vagrant shell provisioner

When using the Vagrant Hypervisor, beaker can create the Vagrantfile with a shell provisioner. This is done by using the shell_provisioner option in the nodeset file.

Example hosts file

HOSTS:
  ubuntu-1404-x64-master:
    roles:
      - master
      - agent
      - dashboard
      - database
    platform: ubuntu-1404-x86_64
    hypervisor: vagrant
    box: puppetlabs/ubuntu-14.04-64-nocm
    box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
    ip: 192.168.20.20
    shell_provisioner:
      path: /home/user/scripts/bootstrap.sh

In the above, beaker will create a Vagrantfile which runs the above shell script on the Agent guest.

Using the host's resolver as a DNS proxy in NAT mode (virtualbox only)

When using the Vagrant hypervisor with the virtualbox provider, beaker can configure the VirtualBox NAT engine's DHCP sever to proxy DNS queries through to the host's resolver using the natdns setting in the nodeset file.

Example hosts file

HOSTS:
  el7-server:
    roles:
      - default
    platform: el-7-x86_64
    box: centos/7
    hypervisor: vagrant
    natdns: on
    yum_repos:
      epel:
        mirrorlist: 'https://mirrors.fedoraproject.org/mirrorlist?repo=epel-7&arch=$basearch&country=us'
        gpgkeys:
          - https://dl.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL-$releasever

vagrant plugins

You can check more information for some supported vagrant plugins: