vagrant-kvm 0.1.0

data/.gitignore

@@ -0,0 +1,14 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (April 2, 2013)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+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,8 @@
+The MIT License (MIT)
+Copyright (c) 2013 Alex Drahon
+
+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.
+
+HE 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,90 @@
+# Vagrant KVM Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds a KVM
+provider to Vagrant, allowing Vagrant to control and provision KVM/QEMU VM.
+
+**NOTE:** This plugin requires Vagrant 1.1+
+**NOTE:** This plugin requires QEMU 1.2+, it has only been tested on Fedora 18
+at the moment.
+
+## Features/Limitations
+
+* Provides the same workflow as the Vagrant VirtualBox provider.
+* Uses VirtualBox boxes almost seamlessly (see below).
+* Uses NFS for sync folders
+* Only works with 1 VM per Vagrantfile for now
+* Only works with private networking for now
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After
+installing, `vagrant up` and specify the `kvm` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-kvm
+...
+$ vagrant up --provider=aws
+...
+```
+
+Of course prior to doing this, you'll need to obtain a KVM-compatible
+box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to use a VirtualBox box and change the provider manually. For
+example:
+
+```
+$ vagrant box add precise32 http://files.vagrantup.com/precise32.box
+...
+```
+
+The box will be installed in `~/.vagrant.d/boxes/precise32/virtualbox`, you
+need to change this to `~/.vagrant.d/boxes/precise32/kvm` and change the
+provider in `metadata.json`. For example:
+
+```
+mv ~/.vagrant.d/boxes/precise32/virtualbox ~/.vagrant.d/boxes/precise32/kvm
+cat <<EOF >~/.vagrant.d/boxes/precise32/kvm/metadata.json
+> {"provider": "kvm"}
+> EOF
+```
+
+You will need a private network specifying an IP address in your Vagrantfile,
+the minimum Vagrantfile would then be:
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise32"
+  config.vm.network :private_network, ip: "192.168.192.10"
+end
+```
+
+And then run `vagrant up --provider=kvm`.
+
+## Box Format
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `kvm` provider.
+
+There are two box formats for the `kvm` provider:
+1. VirtualBox box - you need to change the provider to `kvm` in the
+   `metadata.json` file, the box will be converted on the fly.
+2. "Native" box - you need a box.xml file (libvirt domain format) and a raw
+   image file (you can convert a .vmdk with qemu-img)
+
+To turn this into a native box, you need to create a vagrant image and do:
+
+```
+$ tar cvzf kvm.box ./metadata.json ./Vagrantfile ./box.xml ./box-disk1.img
+```
+
+You need a base MAC address and a private network like in the example.
+
+
+## Configuration
+
+There are no provider-specific parameters at the moment.

data/Rakefile

@@ -0,0 +1,15 @@
+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

data/example_box/README.md

@@ -0,0 +1,18 @@
+# Vagrant KVM Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `kvm` provider.
+
+There are two box formats for the `kvm` provider:
+1. VirtualBox box - you need to change the provider to `kvm` in the
+   `metadata.json` file, the box will be converted on the fly.
+2. "Native" box - you need a box.xml file (libvirt domain format) and a raw
+   image file (you can convert a .vmdk with qemu-img)
+
+To turn this into a native box, you need to create a vagrant image and do:
+
+```
+$ tar cvzf kvm.box ./metadata.json ./Vagrantfile ./box.xml ./box-disk1.img
+```
+
+You need a base MAC address and a private network like in the example.

data/example_box/box.xml

@@ -0,0 +1,78 @@
+<domain type='kvm'>
+  <name>precise32</name>
+  <memory unit='KiB'>393216</memory>
+  <currentMemory unit='KiB'>393216</currentMemory>
+  <vcpu placement='static'>1</vcpu>
+  <os>
+    <type arch='i686' machine='pc-1.2'>hvm</type>
+    <boot dev='hd'/>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <clock offset='utc'/>
+  <on_poweroff>destroy</on_poweroff>
+  <on_reboot>restart</on_reboot>
+  <on_crash>restart</on_crash>
+  <devices>
+    <emulator>/usr/bin/qemu-kvm</emulator>
+    <disk type='file' device='disk'>
+      <driver name='qemu' type='raw'/>
+      <source file='box-disk1.img'/>
+      <target dev='vda' bus='virtio'/>
+      <alias name='virtio-disk0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
+    </disk>
+    <controller type='usb' index='0'>
+      <alias name='usb0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x2'/>
+    </controller>
+    <controller type='virtio-serial' index='0'>
+      <alias name='virtio-serial0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x05' function='0x0'/>
+    </controller>
+    <interface type='network'>
+      <mac address='08:00:27:12:96:98'/>
+      <source network='vagrant'/>
+      <target dev='vnet0'/>
+      <model type='virtio'/>
+      <alias name='net0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
+    </interface>
+    <serial type='pty'>
+      <source path='/dev/pts/6'/>
+      <target port='0'/>
+      <alias name='serial0'/>
+    </serial>
+    <console type='pty' tty='/dev/pts/6'>
+      <source path='/dev/pts/6'/>
+      <target type='serial' port='0'/>
+      <alias name='serial0'/>
+    </console>
+    <channel type='spicevmc'>
+      <target type='virtio' name='com.redhat.spice.0'/>
+      <alias name='channel0'/>
+      <address type='virtio-serial' controller='0' bus='0' port='1'/>
+    </channel>
+    <input type='mouse' bus='ps2'/>
+    <graphics type='spice' port='5900' autoport='yes' listen='127.0.0.1'>
+      <listen type='address' address='127.0.0.1'/>
+    </graphics>
+    <sound model='ich6'>
+      <alias name='sound0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0'/>
+    </sound>
+    <video>
+      <model type='cirrus' vram='9216' heads='1'/>
+      <alias name='video0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>
+    </video>
+    <memballoon model='virtio'>
+      <alias name='balloon0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/>
+    </memballoon>
+  </devices>
+</domain>
+

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+    "provider": "kvm"
+}

data/lib/vagrant-kvm.rb

@@ -0,0 +1,20 @@
+require "pathname"
+
+require "vagrant-kvm/plugin"
+
+module VagrantPlugins
+  module ProviderKvm
+    lib_path = Pathname.new(File.expand_path("../vagrant-kvm", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Driver, lib_path.join("driver/driver")
+    autoload :Errors, lib_path.join("errors")
+    autoload :Util, lib_path.join("util")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-kvm/action.rb

@@ -0,0 +1,268 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module ProviderKvm
+    module Action
+      # Include the built-in modules so that we can use them as top-level
+      # things.
+      include Vagrant::Action::Builtin
+
+      # This action boots the VM, assuming the VM is in a state that requires
+      # a bootup (i.e. not saved).
+      def self.action_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Network
+          b.use Provision
+          b.use PruneNFSExports
+          b.use NFS
+          b.use PrepareNFSSettings
+          b.use ShareFolders
+          b.use SetHostname
+          #b.use Customize
+          b.use Boot
+        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 CheckKvm
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, DestroyConfirm do |env2, b3|
+              if env2[:result]
+                b3.use ConfigValidate
+                b3.use EnvSet, :force_halt => true
+                b3.use action_halt
+                b3.use PruneNFSExports
+                b3.use Destroy
+              else
+                b3.use MessageWillNotDestroy
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for halting
+      # the virtual machine, gracefully or by force.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use Call, IsPaused do |env2, b3|
+                next if !env2[:result]
+                b3.use Resume
+              end
+
+              b2.use Call, GracefulHalt, :poweroff, :running do |env2, b3|
+                if !env2[:result]
+                  b3.use ForcedHalt
+                end
+              end
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This action packages the virtual machine into a single box file.
+      def self.action_package
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SetupPackageFiles
+            b2.use action_halt
+            #b2.use Export
+            b2.use PackageVagrantfile
+            b2.use Package
+          end
+        end
+      end
+
+      # This action just runs the provisioners on the machine.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use ConfigValidate
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              if !env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use Provision
+            end
+          end
+        end
+      end
+
+      # This action is responsible for reloading the machine, which
+      # brings it down, sucks in new configuration, and brings the
+      # machine back up with the new configuration.
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConfigValidate
+            b2.use action_halt
+            b2.use action_start
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for resuming
+      # suspended machines.
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use Resume
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This is the action that will exec into an SSH shell.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use CheckCreated
+          b.use CheckRunning
+          b.use SSHExec
+        end
+      end
+
+      # This is the action that will run a single SSH command.
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use CheckCreated
+          b.use CheckRunning
+          b.use SSHRun
+        end
+      end
+
+      # This action starts a VM, assuming it is already imported and exists.
+      # A precondition of this action is that the VM exists.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use ConfigValidate
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is running, then our work here is done, exit
+            next if env[:result]
+
+            b2.use Call, IsSaved do |env2, b3|
+              if env2[:result]
+                # The VM is saved, so just resume it
+                b3.use action_resume
+                next
+              end
+
+              b3.use Call, IsPaused do |env3, b4|
+                if env3[:result]
+                  b4.use Resume
+                  next
+                end
+
+                # The VM is not saved, so we must have to boot it up
+                # like normal. Boot!
+                b4.use action_boot
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for suspending
+      # the virtual machine.
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use Suspend
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This action brings the machine up from nothing, including importing
+      # the box, configuring metadata, and booting.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckKvm
+          b.use ConfigValidate
+          b.use InitStoragePool
+          b.use Call, Created do |env, b2|
+            # If the VM is NOT created yet, then do the setup steps
+            if !env[:result]
+              b2.use CheckBox
+              b2.use Import
+              b2.use MatchMACAddress
+            end
+          end
+          b.use action_start
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :Boot, action_root.join("boot")
+      autoload :CheckBox, action_root.join("check_box")
+      autoload :CheckCreated, action_root.join("check_created")
+      autoload :CheckKvm, action_root.join("check_kvm")
+      autoload :CheckRunning, action_root.join("check_running")
+      autoload :Created, action_root.join("created")
+      autoload :Destroy, action_root.join("destroy")
+      autoload :DestroyConfirm, action_root.join("destroy_confirm")
+      autoload :ForcedHalt, action_root.join("forced_halt")
+      autoload :Import, action_root.join("import")
+      autoload :InitStoragePool, action_root.join("init_storage_pool")
+      autoload :IsPaused, action_root.join("is_paused")
+      autoload :IsRunning, action_root.join("is_running")
+      autoload :IsSaved, action_root.join("is_saved")
+      autoload :MatchMACAddress, action_root.join("match_mac_address")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
+      autoload :Network, action_root.join("network")
+      autoload :PrepareNFSSettings, action_root.join("prepare_nfs_settings")
+      autoload :PruneNFSExports, action_root.join("prune_nfs_exports")
+      autoload :Resume, action_root.join("resume")
+      autoload :SetupPackageFiles, action_root.join("setup_package_files")
+      autoload :ShareFolders, action_root.join("share_folders")
+      autoload :Suspend, action_root.join("suspend")
+    end
+  end
+end