vagrant-ovirt 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile
+!example_box/Vagrantfile
+.vagrant

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-ovirt.gemspec
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lukas Stanek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,219 @@
+# Vagrant oVirt/RHEV Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds an
+[oVirt](http://ovirt.org) and
+[rhev](http://www.redhat.com/products/virtualization/) provider to Vagrant,
+allowing Vagrant to control and provision machines in oVirt and RHEV.
+
+**Note:** Actual version (0.0.1) is still a development one.
+
+## Features (Version 0.0.1)
+
+* Vagrant `up`, `destroy` commands.
+* Create and boot oVirt machines from oVirt templates.
+* SSH into domains.
+* Provision domains with any built-in Vagrant provisioner.
+* Minimal synced folder support via `rsync`.
+
+## Future work
+
+* Take a look at [open issues](https://github.com/pradels/vagrant-ovirt/issues?state=open).
+
+## Installation
+
+Install using standard [Vagrant 1.1+](http://downloads.vagrantup.com) plugin installation methods. After
+installing, `vagrant up` and specify the `ovirt` provider. An example is shown below.
+
+```
+$ vagrant plugin install vagrant-ovirt
+```
+
+## Vagrant Project Preparation
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually use a dummy oVirt box and specify all the details
+manually within a `config.vm.provider` block. So first, add the dummy box using
+any name you want:
+
+```
+$ vagrant box add ovirt https://raw.github.com/pradels/vagrant-ovirt/master/example_box/ovirt.box
+```
+
+And then make a Vagrantfile that looks like the following, filling in
+your information where necessary.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.define :test_vm do |test_vm|
+    test_vm.vm.box = "ovirt"
+    test_vm.vm.provider :ovirt do |ovirt|
+      ovirt.template = "example-template-name"
+      ovirt.quota = "quota name"
+      ovirt.cpus = 1
+      ovirt.memory = 1024
+    end
+  end
+
+  config.vm.provider :ovirt do |ovirt|
+    ovirt.url = "https://rhevm.example.com:443"
+    ovirt.username = "example_user"
+    ovirt.password = "example_password"
+    ovirt.datacenter = "example_datacenter"
+  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.
+* ``ip_command` - Shell command, which shoud return IP address string for
+ MAC address specified in MAC environment variable. By default, this command
+ searches in local arp table.
+
+### 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.
+* `quota` - Name of oVirt quota for VM. Defaults to first quota found.
+
+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.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.define :dbserver do |dbserver|
+    dbserver.vm.box = "ovirt"
+    dbserver.vm.provider :ovirt do |vm|
+      vm.memory = 2048
+      vm.cpus = 2
+      vm.template = "centos63-vagrant-base"
+    end
+  end
+
+  # ...
+```
+
+## Create Project - Vagrant up
+
+In prepared project directory, run following command:
+
+```
+$ vagrant up --provider=ovirt
+```
+
+Vagrant needs to know that we want to use oVirt and not default VirtualBox.
+That's why there is `--provider=ovirt` option specified. Other way to tell
+Vagrant to use oVirt provider is to setup environment variable
+`export VAGRANT_DEFAULT_PROVIDER=ovirt`.
+
+### How Project Is Created
+
+Vagrant goes through steps below when creating new project:
+
+1.	Connect to oVirt via REST API on every REST query.
+2.	Create new oVirt machine from template with additional network interfaces.
+3.	Start oVirt machine.
+4.	Check for IP address of VM with ip_command.
+5.	Wait till SSH is available.
+6.	Sync folders via `rsync` and run Vagrant provisioner on new domain if
+	setup in Vagrantfile.
+
+## Networks
+
+Networking features in the form of `config.vm.network` are supported only
+in bridged format, no hostonly network is supported in current version of
+provider.
+
+Example of network interface definition:
+
+```ruby
+  config.vm.define :test_vm do |test_vm|
+    test_vm.vm.network :bridged, :bridge => "rhevm", :adapter => 1
+  end
+```
+
+In example above, bridged network adapter connected to network `rhevm` is
+defined.
+
+## Obtaining Domain IP Address
+
+OVirt API doesn't provide standard way how to find out an IP address of running
+VM. But we know, what is MAC address of virtual machine. Problem is, where to
+get mapping MAC to IP address.
+
+There is an option named ip_command, which by default looks into local arp
+table and searches there IP for MAC address specified as a MAC shell variable.
+Maybe you need to customize this behaviour, so setup your own ip_commands to
+your needs.
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`, the oVirt
+provider will use `rsync` (if available) to uni-directionally sync the folder
+to the remote machine over SSH.
+
+This is good enough for all built-in Vagrant provisioners (shell,
+chef, and puppet) to work!
+
+## 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](https://github.com/pradels/vagrant-ovirt/tree/master/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.
+
+## Development
+
+To work on the `vagrant-ovirt` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ git clone https://github.com/pradels/vagrant-ovirt.git
+$ cd vagrant-ovirt
+$ bundle install
+```
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+that uses it. Don't forget to add following line at the beginning of your
+`Vagrantfile` while in development mode:
+
+```ruby
+Vagrant.require_plugin "vagrant-ovirt"
+```
+
+Now you can use bundler to execute Vagrant:
+
+```
+$ bundle exec vagrant up --provider=ovirt
+```
+
+## 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
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+
+#require 'rubygems'
+#require 'bundler/setup'
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+

data/example_box/Vagrantfile

@@ -0,0 +1,22 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = 'ovirt'
+
+  #config.vm.define :test_vm do |test_vm|
+  #  test_vm.vm.provider :ovirt do |ovirt|
+  #    ovirt.template = "Template name"
+  #    ovirt.quota = "Quota name"
+  #    ovirt.cpus = 1
+  #    ovirt.memory = 512
+  #  end
+  #end
+
+  #config.vm.provider :ovirt do |ovirt|
+  #  ovirt.url = "https://ovirt.example.com:443"
+  #  ovirt.username = "username"
+  #  ovirt.password = "secret"
+  #  ovirt.datacenter = "Datacenter name"
+  #end
+end

data/example_box/metadata.json

@@ -0,0 +1,4 @@
+{
+    "provider": "ovirt"
+}
+

data/lib/vagrant-ovirt/action/connect_ovirt.rb

@@ -0,0 +1,84 @@
+require 'fog'
+require 'log4r'
+require 'pp'
+require 'rbovirt'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class ConnectOVirt
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::connect_ovirt")
+          @app = app
+        end
+
+        def call(env)
+
+          # We need both, fog and rbovirt client. Sometimes fog doesn't
+          # support some operations like managing quotas, or working with
+          # networks. For this rbovirt client is used.
+          env[:ovirt_client] = OVirtProvider.ovirt_client if \
+            OVirtProvider.ovirt_client != nil
+
+          if OVirtProvider.ovirt_connection != nil
+            env[:ovirt_compute] = OVirtProvider.ovirt_connection
+            return @app.call(env)
+          end
+          
+          # Get config options for ovirt provider.
+          config = env[:machine].provider_config
+
+          conn_attr = {}
+          conn_attr[:provider] = 'ovirt'
+          conn_attr[:ovirt_url] = "#{config.url}/api"
+          conn_attr[:ovirt_username] = config.username if config.username
+          conn_attr[:ovirt_password] = config.password if config.password
+
+          # We need datacenter id in fog connection initialization. But it's
+          # much simpler to use datacenter name in Vagrantfile. So get
+          # datacenter id here from rbovirt client before connecting to fog.
+          env[:ovirt_client] = ovirt_connect(conn_attr)
+          begin
+            datacenter = OVirtProvider::Util::Collection.find_matching(
+              env[:ovirt_client].datacenters, config.datacenter)
+          rescue OVIRT::OvirtException => e
+            raise Errors::FogOVirtConnectionError,
+              :error_message => e.message
+          end
+
+          raise Errors::NoDatacenterError if datacenter == nil
+          conn_attr[:ovirt_datacenter] = datacenter.id
+
+          # Reconnect and prepar rbovirt client with datacenter set from
+          # configuration.
+          env[:ovirt_client] = ovirt_connect(conn_attr)
+          OVirtProvider.ovirt_client = env[:ovirt_client]
+          
+          # Establish fog connection now.
+          @logger.info("Connecting to oVirt (#{config.url}) ...")
+          begin
+            env[:ovirt_compute] = Fog::Compute.new(conn_attr)
+          rescue OVIRT::OvirtException => e
+            raise Errors::FogOVirtConnectionError,
+              :error_message => e.message
+          end
+          OVirtProvider.ovirt_connection = env[:ovirt_compute]
+
+          @app.call(env)
+        end
+
+        private
+
+        def ovirt_connect(credentials)
+          OVIRT::Client.new(
+            credentials[:ovirt_username],
+            credentials[:ovirt_password],
+            credentials[:ovirt_url],
+            credentials[:ovirt_datacenter],
+          )
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt/action/create_network_interfaces.rb

@@ -0,0 +1,96 @@
+require 'log4r'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # Create network interfaces for machine, before VM is running.
+      class CreateNetworkInterfaces
+
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::create_network_interfaces")
+          @app = app
+        end
+
+        def call(env)
+          # Get machine first.
+          begin
+            machine = OVirtProvider::Util::Collection.find_matching(
+              env[:ovirt_compute].servers.all, env[:machine].id.to_s)
+          rescue => e
+            raise Errors::NoVMError,
+              :vm_name => env[:machine].id.to_s
+          end
+
+          # Setup list of interfaces before creating them
+          adapters = []
+
+          # First interface is for provisioning, so this slot is not usable.
+          # This interface should be available already from template.
+          adapters[0] = :reserved
+
+          env[:machine].config.vm.networks.each do |type, options|
+            # Other types than bridged are not supported for now.
+            next if type != :bridged
+
+            network_name = 'rhevm'
+            network_name = options[:bridge] if options[:bridge]
+
+            if options[:adapter]
+              if adapters[options[:adapter]]
+                raise Errors::InterfaceSlotNotAvailable
+              end
+
+              adapters[options[:adapter].to_i] = network_name
+            else
+              empty_slot = find_empty(adapters, start=1)
+              raise Errors::InterfaceSlotNotAvailable if empty_slot == nil
+
+              adapters[empty_slot] = network_name
+            end           
+          end
+
+          # Create each interface as new domain device
+          adapters.each_with_index do |network_name, slot_number|
+            next if network_name == :reserved
+            iface_number = slot_number + 1
+
+            # Get network id
+            network = OVirtProvider::Util::Collection.find_matching(
+              env[:ovirt_client].networks(:cluster => env[:ovirt_cluster].id),
+              network_name)
+            if network == nil
+              raise Errors::NoNetworkError,
+                :network_name => network_name
+            end
+
+            @logger.info("Creating network interface nic#{iface_number}")
+            begin
+              machine.add_interface(
+                :name    => "nic#{iface_number}",
+                :network => network.id,
+
+                # TODO This should be configurable in Vagrantfile.
+                :interface => 'virtio',
+              )
+            rescue => e
+              raise Errors::AddInterfaceError,
+                :error_message => e.message
+            end
+          end
+
+          @app.call(env)
+        end
+
+        private
+
+        def find_empty(array, start=0, stop=8)
+          for i in start..stop
+            return i if !array[i]
+          end
+          return nil
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-ovirt/action/create_vm.rb

@@ -0,0 +1,114 @@
+require 'log4r'
+require 'vagrant/util/retryable'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class CreateVM
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::create_vm")
+          @app = app
+        end
+
+        def call(env)
+          # Get config.
+          config = env[:machine].provider_config
+
+          # Gather some info about domain
+          name = env[:domain_name]
+          cpus = config.cpus
+          memory_size = config.memory*1024
+
+          # Get cluster
+          if config.cluster == nil
+            cluster = env[:ovirt_compute].clusters.first
+          else
+            cluster = OVirtProvider::Util::Collection.find_matching(
+              env[:ovirt_compute].clusters.all, config.cluster)
+          end
+          raise Error::NoClusterError if cluster == nil
+          # TODO fill env also with other ovirtoptions.
+          env[:ovirt_cluster] = cluster
+
+          # Get template
+          template = OVirtProvider::Util::Collection.find_matching(
+            env[:ovirt_compute].templates.all, config.template)
+          if template == nil
+            raise Error::NoTemplateError,
+              :template_name => config.template
+          end
+
+          # Get quota
+          if config.quota == nil
+            quota = env[:ovirt_client].quotas.first
+          else
+            quota = OVirtProvider::Util::Collection.find_matching(
+              env[:ovirt_client].quotas.all, config.quota)
+          end
+          raise Error::NoQuotaError if quota == nil
+
+          # Output the settings we're going to use to the user
+          env[:ui].info(I18n.t("vagrant_ovirt.creating_vm"))
+          env[:ui].info(" -- Name:          #{name}")
+          env[:ui].info(" -- Cpus:          #{cpus}")
+          env[:ui].info(" -- Memory:        #{memory_size/1024}M")
+          env[:ui].info(" -- Base box:      #{env[:machine].box.name}")
+          env[:ui].info(" -- Template:      #{template.name}")
+          env[:ui].info(" -- Quota:         #{quota.name}")
+          env[:ui].info(" -- Datacenter:    #{config.datacenter}")
+          env[:ui].info(" -- Cluster:       #{cluster.name}")
+
+          # Create oVirt VM.
+          attr = {
+              :name     => name,
+              :cores    => cpus,
+              :memory   => memory_size*1024,
+              :cluster  => cluster.id,
+              :template => template.id,
+              :quota    => quota.id,
+          }
+
+          begin
+            server = env[:ovirt_compute].servers.create(attr)
+          rescue OVIRT::OvirtException => e
+            raise Errors::FogCreateServerError,
+              :error_message => e.message
+          end
+
+          # Immediately save the ID since it is created at this point.
+          env[:machine].id = server.id
+
+          # Wait till all volumes are ready.
+          env[:ui].info(I18n.t("vagrant_ovirt.wait_for_ready_vm"))
+          for i in 0..5
+            ready = true
+            server.volumes.each do |volume|
+              if volume.status != 'ok'
+                ready = false
+                break
+              end
+            end
+            break if ready
+            sleep 2
+          end
+
+          @app.call(env)
+        end
+
+        def recover(env)
+          return if env["vagrant.error"].is_a?(Vagrant::Errors::VagrantError)
+
+          # Undo the import
+          env[:ui].info(I18n.t("vagrant_ovirt.error_recovering"))
+          destroy_env = env.dup
+          destroy_env.delete(:interrupted)
+          destroy_env[:config_validate] = false
+          destroy_env[:force_confirm_destroy] = true
+          env[:action_runner].run(Action.action_destroy, destroy_env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/destroy_vm.rb

@@ -0,0 +1,25 @@
+require 'log4r'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class DestroyVM
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt::action::destroy_vm")
+          @app = app
+        end
+
+        def call(env)
+          # Destroy the server, remove the tracking ID
+          env[:ui].info(I18n.t("vagrant_ovirt.destroy_vm"))
+
+          machine = env[:ovirt_compute].servers.get(env[:machine].id.to_s)
+          machine.destroy
+          env[:machine].id = nil
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/is_created.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/message_already_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_ovirt.already_created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class MessageNotCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_ovirt.not_created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end