oVirt v4 provider for Vagrant
Ruby HTML
Latest commit 27994e2 Apr 11, 2017 @myoung34 myoung34 committed on GitHub Merge pull request #88 from alclonky/remote-boxes
Added support for handling remote boxes

README.md

Vagrant oVirt v4 Provider

This is a Vagrant 1.1+ plugin that adds an oVirt v4 and allowing Vagrant to control and provision machines in oVirt.

Installation

$ vagrant plugin install vagrant-ovirt4
$ vagrant up --provider=ovirt4

Usage

Prerequisites

Configuration

  1. ovirt-guest-agent
  2. cloud-init
  3. User 'vagrant'
  4. password 'vagrant'
  5. Public key from here
  6. add to group with sudo no password
  7. set !requiretty in sudoers
  8. firewall off and ssh enabled

Example creation steps

  1. Create a base template
  2. Centos Example
  3. Spin up a virtual machine using the Centos 7 Generic Cloud Image from the ovirt Glance provider
  4. Once it is up and running, run the example script from inside the VM
  5. Power down the virtual machine
  6. Remove all Network Interfaces from the VM (so that the template does not have it)
  7. Right click the virtual machine and click 'Make Template'

Supported Commands (tested)

  1. vagrant up
  2. vagrant destroy
  3. vagrant ssh [-c '#command']
  4. vagrant ssh-config
  5. vagrant halt
  6. vagrant reload
  7. vagrant status
  8. vagrant suspend
  9. vagrant resume
  10. vagrant snapshot list
  11. vagrant snapshot delete [id]
  12. vagrant snapshot save [description]

Configuration example

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

  config.vm.network :private_network,
    :ovirt__network_name => 'ovirtmgmt' #DHCP
    # Static configuration
    #:ovirt__ip => '192.168.2.198', :ovirt__network_name => 'ovirtmgmt', :ovirt__gateway => '192.168.2.125', :ovirt__netmask => '255.255.0.0', :ovirt__dns_servers => '192.168.2.1', :ovirt__dns_search => 'test.local'

  config.vm.provider :ovirt4 do |ovirt|
    ovirt.url = 'https://server/ovirt-engine/api'
    ovirt.username = "admin@internal"
    ovirt.password = "password"
    ovirt.insecure = true
    ovirt.debug = true
    ovirt.cluster = 'Default'
    ovirt.template = 'Vagrant-Centos7-test'
    ovirt.console = 'vnc'
    ovirt.memory_size = '1 GiB' #see https://github.com/dominikh/filesize for usage
    ovirt.memory_guaranteed = '256 MB' #see https://github.com/dominikh/filesize for usage
    ovirt.cpu_cores = 2
    ovirt.cpu_sockets = 2
    ovirt.cpu_threads = 2
    ovirt.bios_serial = aaabbbb-ccc-dddd
    ovirt.cloud_init =<<EOF
write_files:
  - content: |
      Hello, world!
    path: /tmp/greeting.txt
    permissions: '0644'
EOF

  end
end

Configuration options

  1. Vagrant specific
  2. config.vm.hostname => Sets the hostname of the VM a. Is the 'name' in the Virtual Machine tab of the UI a. Is the 'hostname' of the VM configured by cloud-init
  3. config.vm.network => Sets the network information of the VM. a. Note: :ip => is ignored, but :ovirt__ip is used and merged with :ip
  4. Provider specific
  5. config.vm.network => Sets the network information of the VM. a. Note: Only :private_network is currently supported. a. If :ovirt__ip is provided, then the network type is assumed 'STATIC' and gateway is also used.
  6. url => The URL for the API. Required. String. No default value.
  7. username => The username for the API. Required. String. No default value.
  8. password => The password for the API. Required. String. No default value.
  9. insecure => Allow connecting to SSL sites without certificates. Optional. Bool. Default is false
  10. debug => Turn on additional log statements. Optional. Bool. Default is false.
  11. datacenter => The name of the ovirt datacenter to create within. Required. String. No Default value.
  12. template => The name of the template to use for creation. Required. String. No Default value.
  13. cluster => The name of the ovirt cluster to create within. Required. String. No Default value.
  14. console => The type of remote viewing protocol to use. Required. String. No Default value.
  15. memory_size => The physical size of the memory for the VM (in MB). Defaults to 256
  16. memory_guaranteed => The guaranteed size of the memory for the VM (in MB). Note: cannot be larger than memory_size. Defaults to memory_size
  17. cpu_cores => The number of CPU cores. Defaults to 1
  18. cpu_sockets => The number of CPU cores. Defaults to 1
  19. cpu_threads => The number of CPU threads. Defaults to 1
  20. cloud_init => The cloud-init data to pass. Must be properly formatted as yaml. Docs here
  21. affinity => The affinity to use. See this for possible uses. Optional. Invalid will cause a RuntimeError
  22. placement_host => The host to start the VM on. Optional.
  23. bios_serial => The BIOS serial number to assign. Optional.

Testing

Currently pull-requests are tested via test-kitchen using kitchen-vagrant. See Jenkinsfile for more information. If you'd like to run them yourself, however, they make not work in all setups. For example they assume 192.168.2.0/24, host pinning will probably not have a host that's in all set ups, and the template names might not match.

To run Unit tests: bundle install; bundle exec rspec

To run acceptance tests:

export OVIRT_URL='https://yoururl/ovirt-engine/api''
export OVIRT_USERNAME='yourname@internal'
export OVIRT_PASSWORD='yourpassword!'
gem build *.gemspec
vagrant plugin install *.gem
bundle exec kitchen test all

Contributing

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