vagrant-libvirt 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5475753167fabd89226aeb3801ae1122a07b0e9
-  data.tar.gz: 4e9db984dfcd0100c10a5e04d7a9b738a64d33ec
+  metadata.gz: 38f679c4994924e362840cb557548fd54cb12fa9
+  data.tar.gz: a6f1ffd51906f47c366fb72b0cf87b8ffbd145b2
 SHA512:
-  metadata.gz: bdc9f497e2e357be510406e75e44e6638cdbd4e07830a96821c51cc698ceb21849f2216adfe829bbdc9a96396e46e0507b789b0741f8e996ea3319dbace2a418
-  data.tar.gz: 872af8fbd4e578d78a20f030a04ddf1a9aa60844f0bf6c87603b28b19c2850c5763266a47ec148d106731c15b69a08ddfd46d6a5996b5fe513a212b018e9b58e
+  metadata.gz: 1cdcb6b6d8d55a4dc5e025cc7c83452d64d1f964013ade0537acfbea3c27c314133a52ff58d842ec74832056f230d4ea259757482101a1f2613162199aeaccde
+  data.tar.gz: de6039104f84243740a0437c278f0d6b4b283293ff6efb0a15e6109cd58f4fa0d6ebdd2111bece79e88b87fc85b9d4d5501cbdbefcd8832bda8c539e375767b1

data/README.md

@@ -1,10 +1,10 @@
 # Vagrant Libvirt Provider
 
-This is a [Vagrant](http://www.vagrantup.com) 1.4.3+ plugin that adds an
+This is a [Vagrant](http://www.vagrantup.com) plugin that adds an
 [Libvirt](http://libvirt.org) provider to Vagrant, allowing Vagrant to
 control and provision machines via Libvirt toolkit.
 
-**Note:** Actual version (0.0.15) is still a development one. Feedback is
+**Note:** Actual version is still a development one. Feedback is
 welcome and can help a lot :-)
 
 ## Features
@@ -25,13 +25,15 @@ welcome and can help a lot :-)
 
 ## Future work
 
-* More boxes should be available.
 * Take a look at [open issues](https://github.com/pradels/vagrant-libvirt/issues?state=open).
 
 ## Installation
 
-Install using standard [Vagrant 1.4.3+](http://downloads.vagrantup.com) plugin installation methods. After
-installing, `vagrant up` and specify the `libvirt` provider. An example is shown below.
+First, you should have libvirt installed if you plan to run VMs on your local system. For instructions, refer to your linux distribution's documentation,
+
+Next, you must have [Vagrant installed](http://docs.vagrantup.com/v2/installation/index.html). Vagrant-libvirt supports Vagrant 1.5 and 1.6.
+
+ Now you're ready to install vagrant-libvirt using standard [Vagrant plugin](http://docs.vagrantup.com/v2/plugins/usage.html) installation methods.
 
 ```
 $ vagrant plugin install vagrant-libvirt
@@ -54,6 +56,8 @@ In RedHat, Centos, Fedora, ...
 
 ## Vagrant Project Preparation
 
+### Add Box
+
 After installing the plugin (instructions above), the quickest way to get
 started is to add Libvirt box and specify all the details manually within
 a `config.vm.provider` block. So first, add Libvirt box using any name you
@@ -63,42 +67,53 @@ want. This is just an example of Libvirt CentOS 6.4 box available:
 $ vagrant box add centos64 http://kwok.cz/centos64.box
 ```
 
+### Create Vagrantfile
+
 And then make a Vagrantfile that looks like the following, filling in your
 information where necessary. In example below, VM named test_vm is created from
-centos64 box and setup with 10.20.30.40 IP address.
+centos64 box.
 
 ```ruby
 Vagrant.configure("2") do |config|
-
-  # If you are still using old centos box, you have to setup root username for
-  # ssh access. Read more in section 'SSH Access To VM'.
-  config.ssh.username = "root"
-
   config.vm.define :test_vm do |test_vm|
     test_vm.vm.box = "centos64"
-    test_vm.vm.network :private_network, :ip => '10.20.30.40'
-  end
-
-  config.vm.provider :libvirt do |libvirt|
-    libvirt.driver = "kvm"
-    libvirt.host = "localhost"
-    libvirt.connect_via_ssh = true
-    libvirt.username = "root"
-    libvirt.storage_pool_name = "default"
-
-    # include as many of these addition disks as you want to
-    libvirt.storage :file,
-      #:path => '',		# automatically chosen if unspecified!
-      #:device => 'vdb',	# automatically chosen if unspecified!
-      #:size => '10G',		# defaults to 10G if unspecified!
-      :type => 'qcow2'		# defaults to 'qcow2' if unspecified!
   end
 end
 ```
 
-### Libvirt Configuration Options
+### Start VM
+
+In prepared project directory, run following command:
+
+```
+$ vagrant up --provider=libvirt
+```
+
+Vagrant needs to know that we want to use Libvirt and not default VirtualBox.
+That's why there is `--provider=libvirt` option specified. Other way to tell
+Vagrant to use Libvirt provider is to setup environment variable
+`export VAGRANT_DEFAULT_PROVIDER=libvirt`.
+
+### How Project Is Created
 
-This provider exposes quite a few provider-specific configuration options:
+Vagrant goes through steps below when creating new project:
+
+1.	Connect to Libvirt localy or remotely via SSH.
+2.	Check if box image is available in Libvirt storage pool. If not, upload it to
+	remote Libvirt storage pool as new volume.
+3.	Create COW diff image of base box image for new Libvirt domain.
+4.	Create and start new domain on Libvirt host.
+5.	Check for DHCP lease from dnsmasq server.
+6.	Wait till SSH is available.
+7.	Sync folders and run Vagrant provisioner on new domain if
+	setup in Vagrantfile.
+
+
+### Libvirt Configuration
+
+### Provider Options
+
+Although it should work without any configuration for most people, this provider exposes quite a few provider-specific configuration options. The following options allow you to configure how vagrant-libvirt connects to libvirt, and are used to generate the [libvirt connection URI](http://libvirt.org/uri.html):
 
 * `driver` - A hypervisor name to access. For now only kvm and qemu are supported.
 * `host` - The name of the server, where libvirtd is running.
@@ -107,8 +122,22 @@ This provider exposes quite a few provider-specific configuration options:
 * `password` - Password to access Libvirt.
 * `id_ssh_key_file` - The id ssh key file name to access Libvirt (eg: id_dsa or id_rsa or ... in the user .ssh directory)
 * `socket` - Path to the libvirt unix socket (eg: /var/run/libvirt/libvirt-sock)
+* `uri` - For advanced usage. Directly specifies what libvirt connection URI vagrant-libvirt should use. Overrides all other connection configuration options.
+
+Connection-independent options:
+
 * `storage_pool_name` - Libvirt storage pool name, where box image and instance snapshots will be stored.
 
+Here is an example of how to set these options.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.provider :libvirt do |libvirt|
+    libvirt.host = "example.com"
+  end
+end
+```
+
 ### Domain Specific Options
 
 * `disk_bus` - The type of disk device to emulate. Defaults to virtio if not set. Possible values are documented in libvirt's [description for _target_](http://libvirt.org/formatdomain.html#elementsDisks).
@@ -141,33 +170,6 @@ Vagrant.configure("2") do |config|
   # ...
 ```
 
-## Create Project - Vagrant up
-
-In prepared project directory, run following command:
-
-```
-$ vagrant up --provider=libvirt
-```
-
-Vagrant needs to know that we want to use Libvirt and not default VirtualBox.
-That's why there is `--provider=libvirt` option specified. Other way to tell
-Vagrant to use Libvirt provider is to setup environment variable
-`export VAGRANT_DEFAULT_PROVIDER=libvirt`.
-
-### How Project Is Created
-
-Vagrant goes through steps below when creating new project:
-
-1.	Connect to Libvirt localy or remotely via SSH.
-2.	Check if box image is available in Libvirt storage pool. If not, upload it to
-	remote Libvirt storage pool as new volume.
-3.	Create COW diff image of base box image for new Libvirt domain.
-4.	Create and start new domain on Libvirt host.
-5.	Check for DHCP lease from dnsmasq server.
-6.	Wait till SSH is available.
-7.	Sync folders and run Vagrant provisioner on new domain if
-	setup in Vagrantfile.
-
 ## Networks
 
 Networking features in the form of `config.vm.network` support private networks
@@ -262,6 +264,26 @@ a DHCP server. dnsmasq writes lease information in the `/var/lib/libvirt/dnsmasq
 directory. Vagrant-libvirt looks for the MAC address in this file and extracts
 the corresponding IP address.
 
+## Additional Disks
+
+You can create and attach additional disks to a VM via `libvirt.storage :file`. It has a number of options:
+
+* `path` - Location of the disk image. If unspecified, a path is automtically chosen in the same storage pool as the VMs primary disk.
+* `device` - Name of the device node the disk image will have in the VM, e.g. *vdb*. If unspecified, the next available device is chosen.
+* `size` - Size of the disk image. If unspecified, defaults to 10G.
+* `type` - Type of disk image to create. Defaults to *qcow2*.
+
+The following example creates two additional disks.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.provider :libvirt do |libvirt|
+    libvirt.storage :file, :size => '20G'
+    libvirt.storage :file, :size => '40G', :type => 'raw'
+  end
+end
+```
+
 ## SSH Access To VM
 
 There are some configuration options for ssh access to VM via `config.ssh.*` in

data/lib/vagrant-libvirt/action/connect_libvirt.rb

@@ -11,7 +11,6 @@ module VagrantPlugins
         end
 
         def call(env)
-
           # If already connected to libvirt, just use it and don't connect
           # again.
           if ProviderLibvirt.libvirt_connection
@@ -21,49 +20,7 @@ module VagrantPlugins
 
           # Get config options for libvirt provider.
           config = env[:machine].provider_config
-
-          # Setup connection uri.
-          uri = config.driver.dup
-          virt_path = case uri
-          when 'qemu', 'openvz', 'uml', 'phyp', 'parallels', 'kvm'
-            '/system'
-          when 'xen', 'esx'
-            '/'
-          when 'vbox', 'vmwarews', 'hyperv'
-            '/session'
-          else
-            raise "Require specify driver #{uri}"
-          end
-          if uri == 'kvm'
-            uri = 'qemu'	# use qemu uri for kvm domain type
-          end
-
-          if config.connect_via_ssh
-            uri << '+ssh://'
-            if config.username
-              uri << config.username + '@'
-            end
-
-            if config.host
-              uri << config.host
-            else
-              uri << 'localhost'
-            end
-          else
-            uri << '://'
-            uri << config.host if config.host
-          end
-
-          uri << virt_path
-          uri << '?no_verify=1'
-
-          if config.id_ssh_key_file
-            # set ssh key for access to libvirt host
-            home_dir = `echo ${HOME}`.chomp
-            uri << "\&keyfile=#{home_dir}/.ssh/"+config.id_ssh_key_file
-          end
-          # set path to libvirt socket
-          uri << "\&socket="+config.socket if config.socket
+          uri = config.uri
 
           conn_attr = {}
           conn_attr[:provider] = 'libvirt'

data/lib/vagrant-libvirt/action/handle_box_image.rb

@@ -31,7 +31,7 @@ module VagrantPlugins
           # Get config options
           config   = env[:machine].provider_config
           box_image_file = env[:machine].box.directory.join('box.img').to_s
-          env[:box_volume_name] = env[:machine].box.name.to_s.dup
+          env[:box_volume_name] = env[:machine].box.name.to_s.dup.gsub("/", "-VAGRANTSLASH-")
           env[:box_volume_name] << '_vagrant_box_image.img'
 
           # Don't continue if image already exists in storage pool.

data/lib/vagrant-libvirt/config.rb

@@ -12,6 +12,10 @@ end
 module VagrantPlugins
   module ProviderLibvirt
     class Config < Vagrant.plugin('2', :config)
+      # manually specify URI
+      # will supercede most other options if provided
+      attr_accessor :uri
+
       # A hypervisor name to access via Libvirt.
       attr_accessor :driver
 
@@ -19,8 +23,7 @@ module VagrantPlugins
       attr_accessor :host
 
       # If use ssh tunnel to connect to Libvirt.
-      attr_accessor :connect_via_ssh
-
+      attr_accessor :connect_via_ssh 
       # Path towards the libvirt socket
       attr_accessor :socket
 
@@ -59,6 +62,7 @@ module VagrantPlugins
       attr_accessor :disks
 
       def initialize
+        @uri               = UNSET_VALUE
         @driver            = UNSET_VALUE
         @host              = UNSET_VALUE
         @connect_via_ssh   = UNSET_VALUE
@@ -122,6 +126,54 @@ module VagrantPlugins
         end
       end
 
+      # code to generate URI from a config moved out of the connect action
+      def _generate_uri
+        # builds the libvirt connection URI from the given driver config
+        # Setup connection uri.
+        uri = @driver.dup
+        virt_path = case uri
+        when 'qemu', 'openvz', 'uml', 'phyp', 'parallels', 'kvm'
+          '/system'
+        when '@en', 'esx'
+          '/'
+        when 'vbox', 'vmwarews', 'hyperv'
+          '/session'
+        else
+          raise "Require specify driver #{uri}"
+        end
+        if uri == 'kvm'
+          uri = 'qemu'	# use qemu uri for kvm domain type
+        end
+
+        if @connect_via_ssh
+          uri << '+ssh://'
+          if @username
+            uri << @username + '@'
+          end
+
+          if @host
+            uri << @host
+          else
+            uri << 'localhost'
+          end
+        else
+          uri << '://'
+          uri << @host if @host
+        end
+
+        uri << virt_path
+        uri << '?no_verify=1'
+
+        if @id_ssh_key_file
+          # set ssh key for access to libvirt host
+          home_dir = `echo ${HOME}`.chomp
+          uri << "\&keyfile=#{home_dir}/.ssh/"+@id_ssh_key_file
+        end
+        # set path to libvirt socket
+        uri << "\&socket="+@socket if @socket
+        return uri
+      end
+
       def finalize!
         @driver = 'kvm' if @driver == UNSET_VALUE
         @host = nil if @host == UNSET_VALUE
@@ -133,6 +185,9 @@ module VagrantPlugins
         @management_network_name = 'vagrant-libvirt' if @management_network_name == UNSET_VALUE
         @management_network_address = '192.168.121.0/24' if @management_network_address == UNSET_VALUE
 
+        # generate a URI if none is supplied
+        @uri = _generate_uri() if @uri == UNSET_VALUE
+
         # Domain specific settings.
         @memory = 512 if @memory == UNSET_VALUE
         @cpus = 1 if @cpus == UNSET_VALUE

data/lib/vagrant-libvirt/templates/public_interface.xml.erb

@@ -6,8 +6,8 @@
   <source dev='<%= @device %>' mode='<%= @mode %>'/>
   <% else %>
   <source bridge='<%=@device%>'/>
-  <model type='<%=@model_type%>'/>
   <% end %>
+  <model type='<%=@model_type%>'/>
 </interface>
 
 

data/lib/vagrant-libvirt/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProviderLibvirt
-    VERSION = '0.0.16'
+    VERSION = '0.0.17'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Lukas Stanek
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog