vagrant-ovirt3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10423f44983ce1e613d1ff08ea44fccbe0693ab1
+  data.tar.gz: 11d9e3f5839ab31db9081fa4c1779054ddd91a0e
+SHA512:
+  metadata.gz: fcf97503453de8e5647540903cf3e173d7a072b901bc771c288b5230f0e0cda0d124129a9f471e9e5fae77ae8ddcdecf52855018065c0837d898d536bd574ffd
+  data.tar.gz: 477d34d88e332da8034ec5127291b1ce0ba54c03219d1f246f45801406823bb9a60a7ba7765dbd776a335d60f23f853975f59533ba430d63fdfe56fa70382d47

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-ovirt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marcus Young
+
+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,211 @@
+# Vagrant oVirt/RHEV v3 Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds an
+[oVirt v3](http://ovirt.org) and
+[rhev v3](http://www.redhat.com/products/virtualization/) 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.
+
+## Version 1.0.0
+* Complete overhaul of naming schemes. Vagrant-ovirt upstream is deprecated. The provider going forward is 'ovirt3' to allow gem/plugin availability.
+* Volumes are automatically resized
+
+## Version 0.2.1
+* Removed automatic resizing, will be readded when upstream fog changes are committed to rubygems.org
+
+## Features (Version 0.2.0)
+* ~~Volumes are automatically resized~~
+* Replaced configuration to get IP configuration with REST API usage
+
+## Features (Version 0.1.0)
+
+* Vagrant `up` and `destroy` commands.
+* Create and boot oVirt machines from templates.
+* SSH into domains.
+* Provision domains with any built-in Vagrant provisioner.
+* Minimal synced folder support via `rsync`.
+
+## Future work
+
+* Validation of configuration parameters.
+* Test it on other versions of oVirt and RHEV.
+* Template preparation scripts for other distros than RHEL.
+* Vagrant commands `halt`, `resume`, `ssh`, `provision`, `suspend` and `resume`.
+* Take a look at [open issues](https://github.com/myoung34/vagrant-ovirt3/issues?state=open).
+
+## Installation
+
+```
+$ 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.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'ovirt'
+  config.vm.box_url = 'https://raw.github.com/myoung34/vagrant-ovirt3/master/example_box/ovirt.box'
+
+  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'
+  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.
+
+### 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.
+* `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
+
+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 :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.
+
+```ruby
+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
+```
+
+### 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 using the REST API.
+5.	Wait till SSH is available.
+6.	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:
+
+```ruby
+  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](https://github.com/myoung34/vagrant-ovirt3/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.
+
+## 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/README.md

@@ -0,0 +1,13 @@
+# Vagrant oVirt3 Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `ovirt3` 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,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = 'ovirt3'
+  config.vm.box_url = 'https://raw.github.com/myoung34/vagrant-ovirt3/master/example_box/dummy.box'
+
+  config.vm.provider :ovirt3 do |ovirt|
+    ovirt.url = "https://ovirt.example.com:443"
+    ovirt.username = "username"
+    ovirt.password = "secret"
+    ovirt.datacenter = "Datacenter name"
+    ovirt.template = "Template name"
+    ovirt.quota = "Quota name"
+    ovirt.cpus = 1
+    ovirt.memory = 512
+  end
+end

data/example_box/metadata.json

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

data/lib/vagrant-ovirt3.rb

@@ -0,0 +1,42 @@
+require 'pathname'
+require 'vagrant-ovirt3/plugin'
+
+module VagrantPlugins
+  module OVirtProvider
+    lib_path = Pathname.new(File.expand_path("../vagrant-ovirt3", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+    autoload :Util, lib_path.join("util")
+
+    @@ovirt_connection = nil
+    @@ovirt_client = nil
+    def self.ovirt_connection
+      @@ovirt_connection
+    end
+
+    def self.ovirt_connection=(conn)
+      @@ovirt_connection = conn
+    end
+
+    def self.ovirt_client
+      @@ovirt_client
+    end
+
+    def self.ovirt_client=(conn)
+      @@ovirt_client = conn
+    end
+
+
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end
+
+# Set default provider with bash environment variable like this:
+# export VAGRANT_DEFAULT_PROVIDER=ovirt3
+Vagrant::Environment.class_eval do
+  def default_provider
+    (ENV['VAGRANT_DEFAULT_PROVIDER'] || :virtualbox).to_sym
+  end
+end

data/lib/vagrant-ovirt3/action.rb

@@ -0,0 +1,131 @@
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module OVirtProvider
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            b2.use SetNameOfDomain
+            b2.use CreateVM
+            b2.use ResizeDisk
+
+            b2.use Provision
+            b2.use CreateNetworkInterfaces
+
+            b2.use SetHostname
+            b2.use StartVM
+            b2.use WaitTillUp
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for completely
+      # freeing the resources of the underlying virtual machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConnectOVirt
+            b2.use DestroyVM
+          end
+        end
+      end
+
+      # This action is called to read the state of the machine. The resulting
+      # state is expected to be put into the `:machine_state_id` key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use ReadState
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOVirt
+          b.use ReadSSHInfo
+        end
+      end
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use SSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use SSHRun
+          end
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use Provision
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectOVirt, action_root.join("connect_ovirt")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :SetNameOfDomain, action_root.join("set_name_of_domain")
+      autoload :CreateVM, action_root.join("create_vm")
+      autoload :CreateNetworkInterfaces, action_root.join("create_network_interfaces")
+      autoload :ResizeDisk, action_root.join("resize_disk")
+      autoload :StartVM, action_root.join("start_vm")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :DestroyVM, action_root.join("destroy_vm")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :WaitTillUp, action_root.join("wait_till_up")
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+    end
+  end
+end
+