Vagrant oVirt/RHEV v3 Provider

This is a Vagrant 1.1+ plugin that adds an oVirt v3 and rhev v3 provider to Vagrant, allowing Vagrant to control and provision machines in oVirt and RHEV.

In this document, both oVirt and RHEV names are used interchangeably and represent the same platform on top of which this provider should work.

Installation

$ vagrant plugin uninstall vagrant-ovirt
$ vagrant plugin install vagrant-ovirt3
$ vagrant up --provider=ovirt3

Vagrant Project Preparation

Create a Vagrantfile that looks like the following, filling in your information where necessary.

Vagrant.configure('2') do |config|
  config.vm.box = 'ovirt'
  config.vm.box_url = 'https://github.com/myoung34/vagrant-ovirt3/blob/master/example_box/dummy.box?raw=true'

  config.vm.network :private_network,
    :ip => '192.168.56.100', :nictype => 'virtio', :netmask => '255.255.255.0', #normal network configuration
    :ovirt__ip => '10.101.55.72', :ovirt__network_name => 'ovirtmgmt', :ovirt__gateway => '10.101.55.1' # oVirt specific information, overwrites previous on oVirt provider

  config.vm.provider :ovirt3 do |ovirt|
    ovirt.template = 'template'
    ovirt.cpus = 1
    ovirt.memory = 1024
    ovirt.console = 'vnc' #could also be 'spice'
    ovirt.url = 'https://youroVirtmaster:443'
    ovirt.username = 'username'
    ovirt.password = 'password'
    ovirt.datacenter = 'datacenter'
    ovirt.quota = "e92124b9-22f4-4cef-bcd6-b9ae22155dcd"
    ovirt.ca_no_verify = true
    ovirt.memory_guaranteed = 2048 # Supported by oVirt 3.6 and above only
    ovirt.connect_timeout = 30
  end
end

RHEV/oVirt Configuration Options

This provider exposes quite a few provider-specific configuration options:

url - URL to management interface.
username - Username to access oVirt.
password - Password to access oVirt.
datacenter - oVirt datacenter name, where machines will be created.
cluster - oVirt cluster name. Defaults to first cluster found.
filtered_api - Set to true if oVirt user does not have admin priviliges.
ca_no_verify - Set to true to not verify TLS certificates.
ca_cert_store - Certificate authority store to use for verification (this option will be replaced with ca_cert in a future version).
ca_cert_file - Like ca_cert_store, but provides a file containing a single certificate.
quota - The ID of the quota to use. This can be retrieved via the REST API
memory_guaranteed - The amount of memory guaranteed to the VM. Supported by oVirt 3.6 and above only
connect_timeout - The amount of time to wait until the VM changes state

Domain Specific Options

memory - Amount of memory in MBytes. Defaults to 512 if not set.
cpus - Number of virtual cpus. Defaults to 1 if not set.
template - Name of template from which new VM should be created.
template_version - If a template has sub-versions, specify a sub-version number or name.
console - Console type to use. Can be 'vnc' or 'spice'. Default is 'spice'
disk_size - If set, the first volume of the VM will automatically be resized to the specified value. disk_size is in GB
user_data - If given, user data is made available to the VM via a virtual floppy disk. This data is used to configure VMs via cloud-init. The value for user_data should generally be a string in cloud-config format.

Specific domain settings can be set for each domain separately in multi-VM environment. Example below shows a part of Vagrantfile, where specific options are set for dbserver domain.

Vagrant.configure("2") do |config|
  config.vm.define :dbserver do |dbserver|
    dbserver.vm.box = "ovirt"
    dbserver.vm.provider :ovirt3 do |vm|
      vm.memory = 2048
      vm.cpus = 2
      vm.template = "centos63-vagrant-base"
    end
  end

  # ...

Multiple provider Vagrantfile with Provisioners Example

This example allows you to spin up a box under virtualbox using $ vagrant up as well as a VM under oVirt using a template with $ vagrant up --provider=ovirt Note, the network information will differ between the two. Under virtualbox, it should come up with an IP of 192.168.56.100. Under oVirt it should come up as 10.101.55.72 if successful.

Vagrant.configure('2') do |config|
  config.vm.box = 'mybox'

   config.vm.network :private_network,
    :ip => '192.168.56.100', :nictype => 'virtio', :netmask => '255.255.255.0' #normal network configuration
    :ovirt__ip => '10.101.55.72', :ovirt__network_name => 'ovirtmgmt', :ovirt__gateway => '10.101.55.1', # oVirt specific information, overwrites previous on oVirt provider

  config.vm.provider :virtualbox do |vb|
    vb.customize [
      # Key                Value
      'modifyvm',          :id,
      '--cpuexecutioncap', '90',
      '--memory',          '1376',
      '--nictype2',        'virtio',
    ]
  end


  config.vm.provider :ovirt3 do |ovirt|
    ovirt.template = 'template'
    ovirt.cpus = 1
    ovirt.memory = 1024
    ovirt.console = 'vnc' #could also be 'spice'
    ovirt.url = 'https://youroVirtmaster:443'
    ovirt.username = 'username'
    ovirt.password = 'password'
    ovirt.datacenter = 'datacenter'
  end

  config.vm.provision 'shell' do |shell|
    shell.inline = 'uname -a > /var/log/something.log 2>&1'
  end

  config.vm.provision :puppet do |puppet|
    puppet.options = [
      "--environment development",
      '--hiera_config=/etc/puppet/hiera/hiera.yaml',
    ]
    puppet.manifests_path = './manifests'
    puppet.manifest_file = 'default.pp'
  end

Parallel Support

By default VMs will be created and provisioned in parallel. If this causes resource issues or you want VMs to be created in series use --no-parallel

$ vagrant up 
$ vagrant up --no-parallel

How Project Is Created

Vagrant goes through steps below when creating new project:

Connect to oVirt via REST API on every REST query.
Create new oVirt machine from template with additional network interfaces.
Start oVirt machine.
Check for IP address of VM using the REST API.
Wait till SSH is available.
Sync folders via rsync and run Vagrant provisioner on new domain if setup in Vagrantfile.

Network Interfaces

Networking features in the form of config.vm.network support private networks concept. No public network or port forwarding are supported in current version of provider.

An examples of network interface definitions:

  config.vm.define :test_vm1 do |test_vm1|
    test_vm1.vm.network :private_network,
      :ip      => "10.20.30.40",
      :netmask => "255.255.255.0",
      :ovirt__network_name => "ovirt_networkname"
  end

In example below, one additional network interface is created for VM test_vm1. Interface is connected to ovirt_networkname network and configured to ip address 10.20.30.40/24. If you omit ip address, interface will be configured dynamically via dhcp.

Box Format

Every provider in Vagrant must introduce a custom box format. This provider introduces oVirt boxes. You can view an example box in the example_box directory. That directory also contains instructions on how to build a box.

The box is a tarball containing:

metadata.json file describing box image (just a provider name).
Vagrantfile that does default settings for the provider-specific configuration for this provider.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request