vagrant-ovirt4 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5342f00fbaebdf678cce7ea4125f40cc213d140
+  data.tar.gz: 385cdb34732539203b0bbd03d7ff414dffa79a7a
+SHA512:
+  metadata.gz: 582d275b8b01fb98e8997b3defb9a79b68ea1f01122c54771439afdc14c8bacdd7b6876cc48c921d6df7f90b3bc025112d328222b8ebb6c8e5f3a216ae3d0335
+  data.tar.gz: 23b28cef56c3423fca1f70cd956e507afa650d1b015acdb75d0d95d0c4a314b39ac9c7a907d44ba4a54cff346660bd0057b60ff407c3a63aa992bad8fcdb6a7d

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+*.log
+/Vagrantfile
+.vagrant
+example_box/*.box
+/.idea
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--format doc --order random --color #--fail-fast

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  #gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git'
+  gem 'pry'
+  gem 'byebug'
+  gem 'pry-byebug'
+end
+
+group :testing do
+  gem 'rspec-its'
+end
+
+group :plugins do
+  gem 'vagrant-ovirt4', :path => '.'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    vagrant-ovirt4 (0.0.1)
+      ovirt-engine-sdk (~> 4.0, >= 4.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.6)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    ovirt-engine-sdk (4.0.6)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rake (0.9.6)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  pry
+  pry-byebug
+  rake (~> 0)
+  rspec (~> 3.4)
+  rspec-its
+  vagrant-ovirt4!
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,110 @@
+# Vagrant oVirt v4 Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds an
+[oVirt v4](http://ovirt.org) 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](https://github.com/oVirt/ovirt-guest-agent)
+1. [cloud-init](https://cloudinit.readthedocs.io/en/latest/)
+1. User 'vagrant'
+  1. password 'vagrant'
+  1. Public key [from here](https://raw.githubusercontent.com/mitchellh/vagrant/master/keys/vagrant.pub)
+  1. add to group with sudo no password
+1. set `!requiretty` in sudoers
+1. firewall off and ssh enabled
+
+#### Example creation steps
+
+1. Create a base template
+  1. Centos Example
+    1. Spin up a virtual machine using the Centos 7 Generic Cloud Image from the ovirt Glance provider
+    1. Once it is up and running, run [the example script](tools/prepare_redhat_for_box.sh) from inside the VM
+    1. Power down the virtual machine
+    1. Remove all Network Interfaces from the VM (so that the template does not have it)
+    1. Right click the virtual machine and click 'Make Template'
+
+### Supported Commands (tested)
+
+1. `vagrant up`
+1. `vagrant destroy`
+1. `vagrant ssh [-c '#command']`
+1. `vagrant ssh-config`
+1. `vagrant halt`
+1. `vagrant reload`
+1. `vagrant status`
+1. `vagrant suspend`
+1. `vagrant resume`
+
+### 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,
+    :ip => '192.168.56.100', :nictype => 'virtio', :netmask => '255.255.255.0', #normal network configuration
+    :ovirt__ip => '192.168.2.198', :ovirt__network_name => 'ovirtmgmt', :ovirt__gateway => '192.168.2.125' # oVirt specific information, overwrites previous on oVirt provider
+
+  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'
+  end
+end
+```
+
+### Configuration options
+
+1. Vagrant specific
+  1. `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`
+  1. `config.vm.network` => Sets the network information of the VM.
+    a. Note: `:ip` => is ignored, but `:ovirt__ip` is used and merged with `:ip`
+1. Provider specific
+  1. `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.
+  1. `url` =>  The URL for the API. Required. String. No default value.
+  1. `username` => The username for the API. Required. String. No default value.
+  1. `password` => The password for the API. Required. String. No default value.
+  1. `insecure` => Allow connecting to SSL sites without certificates. Optional. Bool. Default is `false`
+  1. `debug` => Turn on additional log statements. Optional. Bool. Default is `false`.
+  1. `cpus` => Number of CPUs to use for the VM. Optional. Integer. Default is `1`. 
+    a. Note: (TODO) [Unknown usage](https://github.com/myoung34/vagrant-ovirt4/issues/26)
+  1. `datacenter` => The name of the ovirt datacenter to create within. Required. String. No Default value.
+    a. Note: (TODO) [Unknown usage](https://github.com/myoung34/vagrant-ovirt4/issues/26)
+  1. `template` => The name of the template to use for creation. Required. String. No Default value.
+  1. `memory` => The amount of RAM to use. 
+    a. Note: (TODO) [Unknown usage/defaults](https://github.com/myoung34/vagrant-ovirt4/issues/26)
+  1. `cluster` => The name of the ovirt cluster to create within. Required. String. No Default value.
+  1. `console` => The type of remote viewing protocol to use. Required. String. No Default value.
+    a. Note: (TODO) Enforce this to be Spice, VNC, and RDP
+
+## 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,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--order defined"
+end
+# Default task is to run the unit tests
+task :default => :spec

data/example_box/README.md

@@ -0,0 +1,13 @@
+# Vagrant oVirt4 Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `ovirt4` provider.
+To turn this into a box:
+
+```
+$ tar cvzf dummy.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for oVirt. These defaults can easily be overwritten by higher-level
+Vagrantfiles (such as project root Vagrantfiles).

data/example_box/Vagrantfile

@@ -0,0 +1,14 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+Vagrant.configure("2") do |config|
+  config.vm.box = 'ovirt4'
+  #config.vm.box_url = 'https://github.com/myoung34/vagrant-ovirt4/blob/master/example_box/dummy.box?raw=true'
+
+  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
+  end
+end

data/example_box/metadata.json

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

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

@@ -0,0 +1,38 @@
+require 'log4r'
+require 'ovirtsdk4'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class ConnectOVirt
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt4::action::connect_ovirt")
+          @app = app
+        end
+
+        def call(env)
+
+          # Get config options for ovirt provider.
+          config = env[:machine].provider_config
+
+          conn_attr = {}
+          conn_attr[:url] = "#{config.url}"
+          conn_attr[:username] = config.username if config.username
+          conn_attr[:password] = config.password if config.password
+          conn_attr[:debug] = config.debug if config.debug
+          conn_attr[:insecure] = true if config.insecure
+
+          @logger.info("Connecting to oVirt (#{config.url}) ...")
+          OVirtProvider.ovirt_connection = OvirtSDK4::Connection.new(conn_attr)          
+          OVirtProvider.vms_service = OVirtProvider.ovirt_connection.system_service.vms_service
+          env[:connection] = OVirtProvider.ovirt_connection
+          env[:vms_service] = OVirtProvider.vms_service
+
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,58 @@
+require 'log4r'
+require 'vagrant/util/scoped_hash_override'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+
+      # Create network interfaces for machine, before VM is running.
+      class CreateNetworkInterfaces
+        include Vagrant::Util::ScopedHashOverride
+
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt4::action::create_network_interfaces")
+          @app = app
+        end
+
+        def call(env)
+
+          iface = "nic1"
+          iface_options = nil
+          env[:machine].config.vm.networks.each do |config|
+            type, options = config
+            # We support private and public networks only. They mean both the
+            # same right now.
+            next unless [:private_network].include? type
+
+            iface_options = scoped_hash_override(options, :ovirt)
+          end
+
+          profiles_service = env[:connection].system_service.vnic_profiles_service
+          network_profile_id = profiles_service.list.map { |p| p.id if p.name == iface_options[:network_name] }.first
+          raise Errors::NoNetworkError, :network_name => iface_options[:network_name] if network_profile_id.nil?
+
+          @logger.info("Creating network interface #{iface}")
+          begin
+            nics_service = env[:vms_service].vm_service(env[:machine].id).nics_service
+            nics_service.add(
+              OvirtSDK4::Nic.new(
+                name: iface,
+                vnic_profile: {
+                  id: network_profile_id
+                }
+              )
+            )
+          rescue => e
+            raise Errors::AddInterfaceError,
+              :error_message => e.message
+          end
+
+          # Continue the middleware chain.
+          @app.call(env)
+
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,92 @@
+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_ovirt4::action::create_vm")
+          @app = app
+        end
+
+        def call(env)
+          # Get config.
+          config = env[:machine].provider_config
+
+          hostname = env[:machine].config.vm.hostname
+          hostname = 'vagrant' if hostname.nil?
+
+          # Output the settings we're going to use to the user
+          env[:ui].info(I18n.t("vagrant_ovirt4.creating_vm"))
+          env[:ui].info(" -- Name:          #{hostname}")
+          env[:ui].info(" -- Cluster:       #{config.cluster}")
+          env[:ui].info(" -- Template:      #{config.template}")
+          env[:ui].info(" -- Console Type:  #{config.console}")
+
+          # Create oVirt VM.
+          attr = {
+              :name     => hostname,
+              :cluster  => {
+                :name => config.cluster,
+              },
+              :template  => {
+                :name => config.template,
+              },
+              :display  => {
+                :type => config.console,
+              },
+          }
+
+          begin
+            server = env[:vms_service].add(attr) 
+          rescue OvirtSDK4::Error => e
+            raise Errors::CreateVMError,
+              :error_message => /Fault detail is \"\[(.*)\]\".*/.match(e.message)[1]
+          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_ovirt4.wait_for_ready_vm"))
+          for i in 0..300
+            ready = true
+            vm_service = env[:vms_service].vm_service(env[:machine].id)
+            disk_attachments_service = vm_service.disk_attachments_service
+            disk_attachments = disk_attachments_service.list
+            disk_attachments.each do |disk_attachment|
+              disk = env[:connection].follow_link(disk_attachment.disk)
+              if disk.status != 'ok'
+                ready = false
+                break
+              end
+            end
+            break if ready
+            sleep 2
+          end
+
+          if not ready
+            raise Errors::WaitForReadyVmTimeout
+          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_ovirt4.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-ovirt4/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_ovirt4::action::destroy_vm")
+          @app = app
+        end
+
+        def call(env)
+          # Destroy the server, remove the tracking ID
+          env[:ui].info(I18n.t("vagrant_ovirt4.destroy_vm"))
+
+          vm_service = env[:vms_service].vm_service(env[:machine].id)
+          vm_service.remove
+          env[:machine].id = nil
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/action/halt_vm.rb

@@ -0,0 +1,23 @@
+require 'log4r'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class HaltVM
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant_ovirt4::action::halt_vm")
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_ovirt4.halt_vm"))
+
+          machine = env[:vms_service].vm_service(env[:machine].id)
+          machine.stop rescue nil #todo dont rescue
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "log4r"
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_ovirt4::action::is_created")
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/action/is_running.rb

@@ -0,0 +1,19 @@
+require "log4r"
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      class IsRunning
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_ovirt4::action::is_created")
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :up
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/action/message_already_up.rb

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

data/lib/vagrant-ovirt4/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_ovirt4.not_created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ovirt4/action/message_not_suspended.rb

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

data/lib/vagrant-ovirt4/action/message_not_up.rb

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

data/lib/vagrant-ovirt4/action/message_powering_up.rb

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

data/lib/vagrant-ovirt4/action/message_saving_state.rb

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