vagrant-kvm 0.1.2 → 0.1.4

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.1.4 (August 20, 2013)
+
+* Add support for qcow2 and configuration for image type [GH-45]
+* Improve error handling [GH-43] [GH-44]
+* Add license and additional author Hiroshi Miura @miurahr to gemfile [GH-42]
+* Add option to enable/disable VNC [GH-41]
+* Fixes to VM set_name [GH-29]
+* Fix typo in VM definition [GH-35]
+* Expanded Readme file [GH-26] [GH-25][GH-34]
+* Add support for VNC console [GH-27]
+* ShareFolders after Boot to avoid ssh timeout [GH-19]
+* Set vm name to avoid collisions [GH-15]
+
+# 0.1.3 (May 20, 2013)
+
+* Merge pull request #13 Fixed error in check_box.rb (Vagrant v1.2.2 compat)
+* Merge pull request #12 improve invalid version reporting
+
 # 0.1.2 (May 7, 2013)
 
 * Merge pull request #2 add "/usr/bin/kvm" to search options 

data/README.md

@@ -5,8 +5,14 @@ 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
-and Debian Wheezy at the moment.
+**NOTE:** This plugin requires QEMU 1.2+, it has only been tested on Fedora 18,
+Debian Wheezy, Ubuntu 12.04(LTS) Precise and Ubuntu 13.04 Raring at the moment.
+
+**NOTE:** This plugin requires `libvirt-dev` package to be installed 
+(as in Debian/Ubuntu) or `libvirt-devel` (Fedora/openSUSE)
+
+**NOTE** You can use a backported KVM/QEMU 1.2 with Private Package Archive(PPA)
+for Ubuntu 12.04(LTS) at https://launchpad.net/~miurahr/+archive/vagrant
 
 ## Features/Limitations
 
@@ -68,6 +74,12 @@ end
 
 And then run `vagrant up --provider=kvm`.
 
+If you always use kvm provider as default, please set it in your .bashrc:
+```
+export VAGRANT_DEFAULT_PROVIDER=kvm
+```
+then you can simply run `vagrant up` with kvm provider.
+
 ## Box Format
 
 Vagrant providers each require a custom provider-specific box format.
@@ -80,15 +92,32 @@ There are two box formats for the `kvm` provider:
 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:
+To turn this into a native box, you need to create a vagrant image and
+make it sparse.
+You need ```libguestfs-tools``` package 
+in Debian/Ubuntu/Mint, Fedora15 and after, or CentOS/RHEL6.
+
+```
+$ env TMPDIR=/tmp virt-sparsify box-disk1-orig.img box-disk1.img
+```
+
+Please keep enough disk space for TMPDIR!
+To make box with keeping sparse, don't forget -S in tar option:
 
 ```
-$ tar cvzf kvm.box ./metadata.json ./Vagrantfile ./box.xml ./box-disk1.img
+$ tar cvSzf kvm.box ./metadata.json ./Vagrantfile ./box.xml ./box-disk1.img
 ```
 
+For CentOS/RHEL5, there is a package in EPEL5. 
+For Gentoo, you can use ```emerge libguestfs```.
+
 You need a base MAC address and a private network like in the example.
 
 
 ## Configuration
 
-There are no provider-specific parameters at the moment.
+There are some provider specific parameter to control VM definition.
+
+* `gui` - boolean for starting VM with VNC enabled.
+* `image_type` - an image format for vm disk: 'raw' or 'qcow2'
+

data/lib/vagrant-kvm/action.rb

@@ -18,10 +18,10 @@ module VagrantPlugins
           b.use PruneNFSExports
           b.use NFS
           b.use PrepareNFSSettings
-          b.use ShareFolders
           b.use SetHostname
           #b.use Customize
           b.use Boot
+          b.use ShareFolders
         end
       end
 
@@ -223,6 +223,7 @@ module VagrantPlugins
       def self.action_up
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckKvm
+          b.use SetName
           b.use ConfigValidate
           b.use InitStoragePool
           b.use Call, Created do |env, b2|
@@ -260,6 +261,7 @@ module VagrantPlugins
       autoload :PrepareNFSSettings, action_root.join("prepare_nfs_settings")
       autoload :PruneNFSExports, action_root.join("prune_nfs_exports")
       autoload :Resume, action_root.join("resume")
+      autoload :SetName, action_root.join("set_name")
       autoload :SetupPackageFiles, action_root.join("setup_package_files")
       autoload :ShareFolders, action_root.join("share_folders")
       autoload :Suspend, action_root.join("suspend")

data/lib/vagrant-kvm/action/boot.rb

@@ -9,6 +9,10 @@ module VagrantPlugins
         def call(env)
           @env = env
 
+          if @env[:machine].provider_config.gui
+            env[:machine].provider.driver.set_gui
+          end
+
           # Start up the VM
           env[:ui].info I18n.t("vagrant.actions.vm.boot.booting")
           env[:machine].provider.driver.start

data/lib/vagrant-kvm/action/check_box.rb

@@ -16,7 +16,7 @@ module VagrantPlugins
 
             # Add the box then reload the box collection so that it becomes
             # aware of it.
-            env[:ui].info I18n.t("vagrant.actions.vm.check_box.not_found", :name => box_name)
+            env[:ui].info I18n.t("vagrant.actions.vm.check_box.not_found", :name => box_name, :provider => env[:machine].provider_name)
             env[:action_runner].run(Vagrant::Action.action_box_add, {
               :box_name     => box_name,
               :box_provider => env[:machine].provider_name,

data/lib/vagrant-kvm/action/import.rb

@@ -10,6 +10,10 @@ module VagrantPlugins
           env[:ui].info I18n.t("vagrant.actions.vm.import.importing",
                                :name => env[:machine].box.name)
 
+          # Ignore unsupported image types
+          image_type = env[:machine].provider_config.image_type
+          image_type = 'raw' unless image_type == 'qcow2'
+
           # Import the virtual machine (ovf or libvirt)
           # if a libvirt XML definition is present we use it
           # otherwise we convert the OVF
@@ -17,11 +21,11 @@ module VagrantPlugins
           box_file = env[:machine].box.directory.join("box.xml").to_s
           if File.file?(box_file)
             env[:machine].id = env[:machine].provider.driver.import(
-                        box_file, storage_path)
+                        box_file, storage_path, image_type)
           else
             box_file = env[:machine].box.directory.join("box.ovf").to_s
             env[:machine].id = env[:machine].provider.driver.import_ovf(
-                        box_file, storage_path)
+                        box_file, storage_path, image_type)
           end
 
           # If we got interrupted, then the import could have been

data/lib/vagrant-kvm/action/set_name.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module ProviderKvm
+    module Action
+      class SetName
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant::action::vm::setname")
+          @app = app
+        end
+
+        def call(env)
+          name = env[:machine].provider_config.name
+
+          if !name
+            prefix = env[:root_path].basename.to_s
+            prefix.gsub!(/[^-a-z0-9_]/i, "")
+            name = prefix + "_#{Time.now.to_i}"
+          end
+
+          # @todo raise error if name is taken in kvm
+          # @todo don't set the name if the vm already has a name
+
+          @logger.info("Setting the name of the VM: #{name}")
+          env[:machine].provider.driver.set_name(name)
+
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-kvm/config.rb

@@ -6,6 +6,11 @@ module VagrantPlugins
       # @return [Array]
       attr_reader :customizations
 
+      # If set to `true`, then KVM/Qemu will be launched with a VNC console.
+      #
+      # @return [Boolean]
+      attr_accessor :gui
+
       # This should be set to the name of the VM
       #
       # @return [String]
@@ -16,8 +21,15 @@ module VagrantPlugins
       # @return [Hash]
       attr_reader :network_adapters
 
+      # The VM image format
+      #
+      # @return [String]
+      attr_accessor :image_type
+
       def initialize
         @name             = UNSET_VALUE
+        @gui              = UNSET_VALUE
+        @image_type       = UNSET_VALUE
       end
 
       # This is the hook that is called to finalize the object before it
@@ -25,6 +37,10 @@ module VagrantPlugins
       def finalize!
         # The default name is just nothing, and we default it
         @name = nil if @name == UNSET_VALUE
+        # Default is to not show a GUI
+        @gui = false if @gui == UNSET_VALUE
+        # Default image type is a sparsed raw
+        @image_type = 'raw' if @image_type == UNSET_VALUE
       end
     end
   end

data/lib/vagrant-kvm/driver/driver.rb

@@ -10,6 +10,7 @@ module VagrantPlugins
         class VMNotFound < StandardError; end
 
         include Util
+        include Errors
 
         # enum for states return by libvirt
         VM_STATE = [
@@ -21,6 +22,9 @@ module VagrantPlugins
           :shutoff,
           :crashed]
 
+        # The Name of the virtual machine we represent
+        attr_reader :name
+
         # The UUID of the virtual machine we represent
         attr_reader :uuid
 
@@ -46,9 +50,11 @@ module VagrantPlugins
               raise e
             end
           end
+
           @version = read_version
-          if (@version[:maj] == 1 && @version[:min] < 2) || @version[:maj] < 1
-            raise Vagrant::Errors::KvmInvalidVersion
+          if @version < "1.2.0"
+            raise Errors::KvmInvalidVersion,
+              :actual => @version, :required => "< 1.2.0"
           end
 
           # Get storage pool if it exists
@@ -88,8 +94,9 @@ module VagrantPlugins
         #
         # @param [String] xml Path to the libvirt XML file.
         # @param [String] path Destination path for the volume.
+        # @param [String] image_type An image type for the volume.
         # @return [String] UUID of the imported VM.
-        def import(xml, path)
+        def import(xml, path, image_type)
           @logger.info("Importing VM")
           # create vm definition from xml
           definition = File.open(xml) { |f|
@@ -102,10 +109,12 @@ module VagrantPlugins
           old_path = File.join(File.dirname(xml), box_disk)
           new_path = File.join(path, new_disk)
           # we use qemu-img convert to preserve image size
-          system("qemu-img convert -p #{old_path} -O raw #{new_path}")
+          system("qemu-img convert -p #{old_path} -O #{image_type} #{new_path}")
           @pool.refresh
           volume = @pool.lookup_volume_by_name(new_disk)
           definition.disk = volume.path
+          definition.name = @name
+          definition.image_type = image_type
           # create vm
           @logger.info("Creating new VM")
           domain = @conn.define_domain_xml(definition.as_libvirt)
@@ -117,8 +126,9 @@ module VagrantPlugins
         #
         # @param [String] ovf Path to the OVF file.
         # @param [String] path Destination path for the volume.
+        # @param [String] image_type An image type for the volume.
         # @return [String] UUID of the imported VM.
-        def import_ovf(ovf, path)
+        def import_ovf(ovf, path, image_type)
           @logger.info("Importing OVF definition for VM")
           # create vm definition from ovf
           definition = File.open(ovf) { |f|
@@ -130,10 +140,12 @@ module VagrantPlugins
           @logger.info("Converting volume #{box_disk} to #{new_disk}")
           old_path = File.join(File.dirname(ovf), box_disk)
           new_path = File.join(path, new_disk)
-          system("qemu-img convert -p #{old_path} -O raw #{new_path}")
+          system("qemu-img convert -p #{old_path} -O #{image_type} #{new_path}")
           @pool.refresh
           volume = @pool.lookup_volume_by_name(new_disk)
           definition.disk = volume.path
+          definition.name = @name
+          definition.image_type = image_type
           # create vm
           @logger.info("Creating new VM")
           domain = @conn.define_domain_xml(definition.as_libvirt)
@@ -207,13 +219,13 @@ module VagrantPlugins
 
         # Return the qemu version
         #
-        # @return [Hash] with :maj and :min version numbers
+        # @return [String] of the form "1.2.2"
         def read_version
           # libvirt returns a number like 1002002 for version 1.2.2
-          # we return just the major.minor part like this 1002
           maj = @conn.version / 1000000
           min = (@conn.version - maj*1000000) / 1000
-          { :maj => maj, :min => min }
+          rel = @conn.version % 1000
+          "#{maj}.#{min}.#{rel}"
         end
 
         # Resumes the previously paused virtual machine.
@@ -224,6 +236,10 @@ module VagrantPlugins
           true
         end
 
+        def set_name(name)
+          @name = name
+        end
+
         def set_mac_address(mac)
           domain = @conn.lookup_domain_by_uuid(@uuid)
           definition = Util::VmDefinition.new(domain.xml_desc, 'libvirt')
@@ -232,6 +248,14 @@ module VagrantPlugins
           @conn.define_domain_xml(definition.as_libvirt)
         end
 
+        def set_gui
+          domain = @conn.lookup_domain_by_uuid(@uuid)
+          definition = Util::VmDefinition.new(domain.xml_desc, 'libvirt')
+          definition.set_gui
+          domain.undefine
+          @conn.define_domain_xml(definition.as_libvirt)
+        end
+
         # Starts the virtual machine.
         def start
           domain = @conn.lookup_domain_by_uuid(@uuid)

data/lib/vagrant-kvm/errors.rb

@@ -6,6 +6,12 @@ module VagrantPlugins
       class VagrantKVMError < Vagrant::Errors::VagrantError
         error_namespace("vagrant_kvm.errors")
       end
+      class KvmNoConnection < VagrantKVMError
+        error_key(:kvm_no_connection)
+      end
+      class KvmInvalidVersion < VagrantKVMError
+        error_key(:kvm_invalid_version)
+      end
     end
   end
 end

data/lib/vagrant-kvm/util/vm_definition.rb

@@ -8,12 +8,13 @@ module VagrantPlugins
     module Util
       class VmDefinition
         # Attributes of the VM
-        attr_reader :name
+        attr_accessor :name
         attr_reader :cpus
         attr_accessor :disk
         attr_reader :mac
         attr_reader :arch
         attr_reader :network
+        attr_accessor :image_type
 
         def self.list_interfaces(definition)
           nics = {}
@@ -27,7 +28,7 @@ module VagrantPlugins
             nics[adapter][:type] = :user
           end
           # look for interfaces on virtual network
-          doc.css("devices interface[type='netwok']").each do |item|
+          doc.css("devices interface[type='network']").each do |item|
             ifcount += 1
             adapter = ifcount
             nics[adapter] ||= {}
@@ -39,6 +40,7 @@ module VagrantPlugins
 
         def initialize(definition, source_type='libvirt')
           @uuid = nil
+          @gui = nil
           @network = 'default'
           if source_type == 'ovf'
             create_from_ovf(definition)
@@ -68,7 +70,7 @@ module VagrantPlugins
           # disk volume
           diskref = doc.at_css("DiskSection Disk")["fileRef"]
           @disk = doc.at_css("References File[id='#{diskref}']")["href"]
-
+          @image_type = 'raw'
           # mac address
           # XXX we use only the first nic
           @mac = format_mac(doc.at_css("Machine Hardware Adapter[enabled='true']")['MACAddress'])
@@ -92,6 +94,7 @@ module VagrantPlugins
           @disk = doc.at_css("devices disk source")["file"]
           @mac = doc.at_css("devices interface mac")["address"]
           @network = doc.at_css("devices interface source")["network"]
+          @image_type = doc.at_css("devices disk driver")["type"]
         end
 
         def as_libvirt
@@ -110,6 +113,8 @@ module VagrantPlugins
             :disk => @disk,
             :mac => format_mac(@mac),
             :network => @network,
+            :gui => @gui,
+            :image_type => @image_type,
             :qemu_bin => qemu_bin.detect { |binary| File.exists? binary }
           })
           xml
@@ -123,6 +128,10 @@ module VagrantPlugins
           @mac = format_mac(mac)
         end
 
+        def set_gui
+          @gui = true
+        end
+
         # Takes a quantity and a unit
         # returns quantity in bytes
         # mib = true to use mebibytes, etc

data/lib/vagrant-kvm/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProviderKvm
-    VERSION = "0.1.2"
+    VERSION = "0.1.4"
   end
 end

data/locales/en.yml

@@ -2,3 +2,11 @@ en:
   vagrant_kvm:
     test_message: |-
       This is a test message.
+    errors:
+      kvm_no_connection: |-
+        Cannot connect to KVM through Libvirt. Please check kernel module
+        'kvm' and 'kvm-intel' or 'kvm-amd' are installed and your id is in 
+        group libvirt(in debian/ubuntu).
+      kvm_invalid_version: |-
+        Invalid Kvm version detected: %{actual}, but a version %{required} is
+        required.

data/templates/libvirt_domain.erb

@@ -22,7 +22,7 @@
   <devices>
     <emulator><%= qemu_bin %></emulator>
     <disk type='file' device='disk'>
-      <driver name='qemu' type='raw'/>
+      <driver name='qemu' type='<%= image_type %>'/>
       <source file='<%= disk %>'/>
       <target dev='vda' bus='virtio'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
@@ -48,6 +48,9 @@
     <sound model='ich6'>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0'/>
     </sound>
+    <% if gui %>
+    <%= "<graphics type='vnc' port='-1' autoport='yes'/>" %>
+    <% end %>
     <video>
       <model type='cirrus' vram='9216' heads='1'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>

data/vagrant-kvm.gemspec

@@ -5,17 +5,20 @@ Gem::Specification.new do |s|
   s.name          = "vagrant-kvm"
   s.version       = VagrantPlugins::ProviderKvm::VERSION
   s.platform      = Gem::Platform::RUBY
-  s.authors       = "Alex Drahon"
+  s.authors       = ["Alex Drahon", "Hiroshi Miura"]
   s.email         = "adrahon@gmail.com"
   s.homepage      = "http://www.vagrantup.com"
   s.summary       = "Enables Vagrant to use KVM instead of VirtualBox."
   s.description   = "Enables Vagrant to use KVM instead of VirtualBox."
+  s.license       = 'MIT'
 
   s.required_rubygems_version = ">= 1.3.6"
+  s.requirements << 'KVM/QEMU, v1.2.0 or greater'
 
   s.add_runtime_dependency "nokogiri", "~> 1.5.6"
   s.add_runtime_dependency "ruby-libvirt", "~> 0.4.0"
 
+  s.add_development_dependency "pry"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec-core", "~> 2.12.2"
   s.add_development_dependency "rspec-expectations", "~> 2.12.1"

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-kvm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
 - Alex Drahon
+- Hiroshi Miura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -43,6 +44,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +163,7 @@ files:
 - lib/vagrant-kvm/action/message_will_not_destroy.rb
 - lib/vagrant-kvm/action/destroy.rb
 - lib/vagrant-kvm/action/import.rb
+- lib/vagrant-kvm/action/set_name.rb
 - lib/vagrant-kvm/action/export.rb
 - lib/vagrant-kvm/action/destroy_confirm.rb
 - lib/vagrant-kvm/action/check_running.rb
@@ -165,7 +183,8 @@ files:
 - README.md
 - .gitignore
 homepage: http://www.vagrantup.com
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -182,7 +201,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
-requirements: []
+requirements:
+- KVM/QEMU, v1.2.0 or greater
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: