vagrant-libvirt 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.0.6 (Jul 24, 2013)
+
+* Synced folder via NFS support.
+* Routed private network support.
+* Configurable ssh parameters in Vagrantfile via `config.ssh.*`.
+* Fixed uploading base box image to storage pool bug (buffer was too big).
+
 # 0.0.5 (May 10, 2013)
 
 * Private networks support.

data/README.md

@@ -4,12 +4,12 @@ This is a [Vagrant](http://www.vagrantup.com) 1.1+ 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.5) is still a development one. Feedback is
+**Note:** Actual version (0.0.6) is still a development one. Feedback is
 welcome and can help a lot :-)
 
-## Features (Version 0.0.5)
+## Features (Version 0.0.6)
 
-* Controll local or remote Libvirt hypervisors.
+* Controll local Libvirt hypervisors.
 * Vagrant `up`, `destroy`, `suspend`, `resume`, `halt`, `ssh` and `provision` commands.
 * Upload box image (qcow2 format) to Libvirt storage pool.
 * Create volume as COW diff image for domains.
@@ -18,7 +18,7 @@ welcome and can help a lot :-)
 * SSH into domains.
 * Setup hostname and network interfaces.
 * Provision domains with any built-in Vagrant provisioner.
-* Minimal synced folder support via `rsync`.
+* Synced folder support via `rsync` or `nfs`.
 
 ## Future work
 
@@ -66,6 +66,11 @@ centos64 box and setup with 10.20.30.40 IP address.
 
 ```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'
@@ -110,6 +115,7 @@ Vagrant.configure("2") do |config|
     dbserver.vm.provider :libvirt do |domain|
       domain.memory = 2048
       domain.cpus = 2
+      domain.nested = true
     end
   end
 
@@ -153,7 +159,7 @@ 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'
+    test_vm1.vm.network :private_network, :ip => "10.20.30.40",
   end
 ```
 
@@ -178,14 +184,18 @@ starts with 'libvirt__' string. Here is a list of those options:
   network 'default' is used.
 * `:libvirt__netmask` - Used only together with `:ip` option. Default is
   '255.255.255.0'.
-* `:libvirt__nat_interface` - Name of interface, where should network be
-  NATed. Used only when creating new network. By default, all physical
-  interfaces are used.
-* `:libvirt__isolated` - If network should be isolated - without NAT to outside.
-  Used only when creating new network. Default is set to false.
 * `:libvirt__dhcp_enabled` - If DHCP will offer addresses, or not. Used only
   when creating new network. Default is true.
 * `:libvirt__adapter` - Number specifiyng sequence number of interface.
+* `:libvirt__forward_mode` - Specify one of `none`, `nat` or `route` options.
+  This option is used only when creating new network. Mode `none` will create
+  isolated network without NATing or routing outside. You will want to use
+  NATed forwarding typically to reach networks outside of hypervisor. Routed
+  forwarding is typically useful to reach other networks within hypervisor.
+  By default, option `nat` is used.
+* `:libvirt__forward_device` - Name of interface/device, where network should
+  be forwarded (NATed or routed). Used only when creating new network. By
+  default, all physical interfaces are used.
 
 ## Obtaining Domain IP Address
 
@@ -197,6 +207,24 @@ makes lease information public in `/var/lib/libvirt/dnsmasq` directory, or in
 information like which MAC address has which IP address resides and it's parsed
 by vagrant-libvirt plugin.
 
+## SSH Access To VM
+
+There are some configuration options for ssh access to VM via `config.ssh.*` in
+Vagrantfile. Untill provider version 0.0.5, root user was hardcoded and used to
+access VMs ssh. Now, vagrant user is used by default, but it's configurable via
+`config.ssh.username` option in Vagrantfile now.
+
+If you are still using CentOS 6.4 box from example in this README, please set
+ssh username back to root, because user vagrant is not usable (I forgot to add
+necessary ssh key to his authorized_keys).
+
+Configurable ssh parameters in Vagrantfile after provider version 0.0.5 are:
+
+* `config.ssh.username` - Default is username vagrant.
+* `config.ssh.guest_port` - Default port is set to 22.
+* `config.ssh.forward_agent` - Default is false.
+* `config.ssh.forward_x11` - Default is false.
+
 ## Synced Folders
 
 There is minimal support for synced folders. Upon `vagrant up`, the Libvirt
@@ -206,6 +234,8 @@ to the remote machine over SSH.
 This is good enough for all built-in Vagrant provisioners (shell,
 chef, and puppet) to work!
 
+If used options `:nfs => true`, folder will exported by nfs.
+
 ## Box Format
 
 You can view an example box in the [example_box/directory](https://github.com/pradels/vagrant-libvirt/tree/master/example_box). That directory also contains instructions on how to build a box.

data/example_box/Vagrantfile

@@ -7,13 +7,25 @@ Vagrant.configure("2") do |config|
   # 
   #config.vm.define :test_vm do |test_vm|
     # Box name
+    #
     #test_vm.vm.box = "centos64"
 
+    # Domain Specific Options
+    #
+    # See README for more info.
+    #
+    #test_vm.vm.provider :libvirt do |domain|
+    #  domain.memory = 2048
+    #  domain.cpus = 2
+    #end
+
     # Interfaces for VM
     # 
-    # Hostonly network is not supported in this version of provider. Bridged
-    # interface with network id specified can be created.
-    #test_vm.vm.network :bridged, :bridge => "default", :adapter => 1
+    # 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. See README for more info. 
+    #
+    #test_vm.vm.network :private_network, :ip => '10.20.30.40'
   #end
 
   # Options for libvirt vagrant provider.

data/lib/vagrant-libvirt/action.rb

@@ -24,6 +24,10 @@ module VagrantPlugins
               b2.use TimedProvision
               b2.use CreateNetworks
               b2.use CreateNetworkInterfaces
+
+              b2.use NFS
+              b2.use PrepareNFSSettings
+              b2.use ShareFolders
               b2.use SetHostname
               b2.use StartDomain
               b2.use WaitTillUp
@@ -100,6 +104,7 @@ module VagrantPlugins
             end
 
             b2.use ConnectLibvirt
+            b2.use PruneNFSExports
             b2.use DestroyDomain
             b2.use DestroyNetworks
           end
@@ -274,6 +279,9 @@ module VagrantPlugins
       autoload :WaitTillUp, action_root.join("wait_till_up")
       autoload :SyncFolders, action_root.join("sync_folders")
       autoload :SSHRun,  "vagrant/action/builtin/ssh_run"
+      autoload :PrepareNFSSettings, action_root.join("prepare_nfs_settings")
+      autoload :PruneNFSExports, action_root.join("prune_nfs_exports")
+      autoload :ShareFolders, action_root.join("share_folders")
     end
   end
 end

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

@@ -18,7 +18,7 @@ module VagrantPlugins
             env[:libvirt_compute] = Libvirt.libvirt_connection
             return @app.call(env)
           end
-          
+
           # Get config options for libvirt provider.
           config = env[:machine].provider_config
 
@@ -38,7 +38,7 @@ module VagrantPlugins
           else
             uri << '://'
             uri << config.host if config.host
-          end                
+          end
           uri << '/system?no_verify=1'
 
           conn_attr = {}
@@ -46,7 +46,7 @@ module VagrantPlugins
           conn_attr[:libvirt_uri] = uri
           conn_attr[:libvirt_username] = config.username if config.username
           conn_attr[:libvirt_password] = config.password if config.password
-          
+
           # Setup command for retrieving IP address for newly created machine
           # with some MAC address. Get it from dnsmasq leases table - either
           # /var/lib/libvirt/dnsmasq/*.leases files, or
@@ -54,7 +54,7 @@ module VagrantPlugins
           ip_command =  "LEASES='/var/lib/libvirt/dnsmasq/*.leases'; "
           ip_command << "[ -f /var/lib/misc/dnsmasq.leases ] && "
           ip_command << "LEASES='/var/lib/misc/dnsmasq.leases'; "
-          ip_command << "cat $LEASES | grep $mac | awk '{ print $3 }'"
+          ip_command << "grep $mac $LEASES | awk '{ print $3 }'"
           conn_attr[:libvirt_ip_command] = ip_command
 
           @logger.info("Connecting to Libvirt (#{uri}) ...")

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

@@ -123,7 +123,7 @@ module VagrantPlugins
 
           env[:ui].info I18n.t("vagrant.actions.vm.network.configuring")
           env[:machine].guest.capability(
-            :configure_networks, networks_to_configure)
+            :configure_networks, networks_to_configure) 
         end
 
         private

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

@@ -45,6 +45,8 @@ module VagrantPlugins
             @options = scoped_hash_override(options, :libvirt)
             @options = {
               :netmask      => '255.255.255.0',
+              :dhcp_enabled => true,
+              :forward_mode => 'nat',
             }.merge(@options)
 
             # Prepare a hash describing network for this specific interface.
@@ -201,14 +203,9 @@ module VagrantPlugins
           @network_address = @interface_network[:ip_address]
           @network_netmask = @interface_network[:netmask]
 
-          if @options[:isolated]
-            @network_forward_mode = false
-          else
-            @network_forward_mode = 'nat'
-
-            if @options[:nat_interface]
-              @network_nat_interface = @options[:nat_interface]
-            end
+          @network_forward_mode = @options[:forward_mode]
+          if @options[:forward_device]
+            @network_forward_device = @options[:forward_device]
           end
 
           if @options[:dhcp_enabled]

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

@@ -96,7 +96,14 @@ module VagrantPlugins
             volume = pool.lookup_volume_by_name(volume_name)
             stream = env[:libvirt_compute].client.stream
             volume.upload(stream, offset=0, length=image_size)
-            buf_size = 1024*1024 # 1M
+
+            # Exception Libvirt::RetrieveError can be raised if buffer is
+            # longer than length accepted by API send function.
+            # 
+            # TODO: How to find out if buffer is too large and what is the
+            # length that send function will accept?
+
+            buf_size = 1024*250 # 250K
             progress = 0
             open(image_file, 'rb') do |io|
               while (buff = io.read(buf_size)) do

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

@@ -0,0 +1,66 @@
+require 'nokogiri'
+module VagrantPlugins
+  module Libvirt
+    module Action
+      class PrepareNFSSettings
+        def initialize(app,env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          @app.call(env)
+
+          using_nfs = false
+          env[:machine].config.vm.synced_folders.each do |id, opts|
+            if opts[:nfs]
+              using_nfs = true
+              break
+            end
+          end
+
+          if using_nfs
+            @logger.info("Using NFS, preparing NFS settings by reading host IP and machine IP")
+            env[:nfs_host_ip]    = read_host_ip(env[:machine],env)
+            env[:nfs_machine_ip] = env[:machine].ssh_info[:host]
+
+            raise Vagrant::Errors::NFSNoHostonlyNetwork if !env[:nfs_machine_ip]
+          end
+        end
+
+        # Returns the IP address of the first host only network adapter
+        #
+        # @param [Machine] machine
+        # @return [String]
+        def read_host_ip(machine,env)
+          nets = env[:libvirt_compute].list_networks
+          if nets.size == 1
+            net = nets.first
+          else
+            domain = env[:libvirt_compute].servers.get(machine.id.to_s)
+            xml=Nokogiri::XML(domain.to_xml)
+            networkname = xml.xpath('/domain/devices/interface/source').first.attributes['network'].value.to_s
+            puts "network name = #{networkname}"
+            net = env[:libvirt_compute].list_networks.find {|netw| netw[:name] == networkname}
+          end
+          # FIXME better implement by libvirt xml parsing
+          `ip addr show | grep -A 2 #{net[:bridge_name]} | grep -i 'inet ' | tr -s ' ' | cut -d' ' -f3 | cut -d'/' -f 1`.chomp
+        end
+
+        # Returns the IP address of the guest by looking at the first
+        # enabled host only network.
+        #
+        # @return [String]
+        def read_machine_ip(machine)
+          machine.config.vm.networks.each do |type, options|
+            if type == :private_network && options[:ip].is_a?(String)
+              return options[:ip]
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'yaml'
+module VagrantPlugins
+  module Libvirt
+    module Action
+      class PruneNFSExports
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:host]
+            uuid = env[:machine].id
+            # get all uuids
+            uuids = env[:libvirt_compute].servers.all.map(&:id)
+            # not exiisted in array will removed from nfs
+            uuids.delete(uuid)
+            env[:host].nfs_prune(uuids)
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -40,15 +40,19 @@ module VagrantPlugins
           }
           raise Errors::NoIpAddressError if not ip_address
 
-          # Return the info
-          # TODO: Some info should be configurable in Vagrantfile
-          return {
+          ssh_info = {
             :host          => ip_address,
-            :port          => 22,
-            :username      => 'root',
-            :forward_agent => true,
-            :forward_x11   => true,
+            :port          => machine.config.ssh.guest_port,
+            :username      => machine.config.ssh.username,
+            :forward_agent => machine.config.ssh.forward_agent,
+            :forward_x11   => machine.config.ssh.forward_x11,
           }
+
+          if not ssh_info[:username]
+            ssh_info[:username] = machine.config.ssh.default.username
+          end
+
+          ssh_info
         end 
       end
     end

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

@@ -0,0 +1,76 @@
+require "pathname"
+
+require "log4r"
+
+module VagrantPlugins
+  module Libvirt
+    module Action
+      class ShareFolders
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant::action::vm::share_folders")
+          @app    = app
+        end
+
+        def call(env)
+          @env = env
+
+          prepare_folders
+          create_metadata
+
+          @app.call(env)
+        end
+
+        # This method returns an actual list of shared
+        # folders to create and their proper path.
+        def shared_folders
+          {}.tap do |result|
+            @env[:machine].config.vm.synced_folders.each do |id, data|
+              # Ignore NFS shared folders
+              next if !data[:nfs]
+
+              # convert to NFS share
+              #data[:nfs] = true
+
+              # This to prevent overwriting the actual shared folders data
+              result[id] = data.dup
+            end
+          end
+        end
+
+        # Prepares the shared folders by verifying they exist and creating them
+        # if they don't.
+        def prepare_folders
+          shared_folders.each do |id, options|
+            hostpath = Pathname.new(options[:hostpath]).expand_path(@env[:root_path])
+
+            if !hostpath.directory? && options[:create]
+              # Host path doesn't exist, so let's create it.
+              @logger.debug("Host path doesn't exist, creating: #{hostpath}")
+
+              begin
+                hostpath.mkpath
+              rescue Errno::EACCES
+                raise Vagrant::Errors::SharedFolderCreateFailed,
+                  :path => hostpath.to_s
+              end
+            end
+          end
+        end
+
+        def create_metadata
+          @env[:ui].info I18n.t("vagrant.actions.vm.share_folders.creating")
+
+          folders = []
+          shared_folders.each do |id, data|
+            folders << {
+              :name => id,
+              :hostpath => File.expand_path(data[:hostpath], @env[:root_path]),
+              :transient => data[:transient]
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ module VagrantPlugins
           ssh_info = env[:machine].ssh_info
 
           env[:machine].config.vm.synced_folders.each do |id, data|
+            next if data[:nfs]
             hostpath  = File.expand_path(data[:hostpath], env[:root_path])
             guestpath = data[:guestpath]
 

data/lib/vagrant-libvirt/errors.rb

@@ -25,7 +25,7 @@ module VagrantPlugins
       end
 
       class ImageUploadError < VagrantLibvirtError
-        error_key(:image_upload_error_error)
+        error_key(:image_upload_error)
       end
 
 

data/lib/vagrant-libvirt/provider.rb

@@ -9,6 +9,7 @@ module VagrantPlugins
     class Provider < Vagrant.plugin('2', :provider)
       def initialize(machine)
         @machine = machine
+        raise 'REQUIRE USE RUBY >= 1.9.3 VERSION' if RUBY_VERSION < '1.9.3'
       end
 
       # This should return an action callable for the given name.

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

@@ -2,9 +2,9 @@
   <name><%= @network_name %></name>
   <bridge name="<%= @network_bridge_name %>" />
 
-  <% if @network_forward_mode != false %>
-    <% if @network_nat_interface %>
-  <forward mode="<%= @network_forward_mode %>" dev="<%= @network_nat_interface %>" />
+  <% if @network_forward_mode != 'none' %>
+    <% if @network_forward_device %>
+  <forward mode="<%= @network_forward_mode %>" dev="<%= @network_forward_device %>" />
     <% else %>
   <forward mode="<%= @network_forward_mode %>" />
     <% end %>

data/lib/vagrant-libvirt/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Libvirt
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/tools/prepare_redhat_for_box.sh

@@ -10,7 +10,7 @@
 # For more info about creating custom box refer to
 # https://github.com/pradels/vagrant-libvirt/tree/master/example_box
 
-# We need a hostname.
+# We need to set a hostname.
 if [ $# -ne 1 ]; then
 	echo "Usage: $0 <hostname>"
 	echo "Hostname should be in format vagrant-[os-name], e.g. vagrant-redhat63."
@@ -75,7 +75,7 @@ sed -i 's/Defaults\s*requiretty/Defaults !requiretty/' /etc/sudoers
 
 
 # SSH setup
-# Add Vagrant ssh key for root accout.
+# Add Vagrant ssh key for root and vagrant accouts.
 sed -i 's/.*UseDNS.*/UseDNS no/' /etc/ssh/sshd_config
 
 [ -d ~root/.ssh ] || mkdir ~root/.ssh
@@ -85,6 +85,13 @@ ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7
 EOF
 chmod 600 ~root/.ssh/authorized_keys
 
+[ -d ~vagrant/.ssh ] || mkdir ~vagrant/.ssh
+chmod 700 ~vagrant/.ssh
+cat > ~vagrant/.ssh/authorized_keys << EOF
+ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ== vagrant insecure public key
+EOF
+chmod 600 ~vagrant/.ssh/authorized_keys
+
 
 # Disable firewall and switch SELinux to permissive mode.
 chkconfig iptables off

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -94,10 +94,13 @@ files:
 - lib/vagrant-libvirt/action/message_not_created.rb
 - lib/vagrant-libvirt/action/message_not_running.rb
 - lib/vagrant-libvirt/action/message_not_suspended.rb
+- lib/vagrant-libvirt/action/prepare_nfs_settings.rb
+- lib/vagrant-libvirt/action/prune_nfs_exports.rb
 - lib/vagrant-libvirt/action/read_ssh_info.rb
 - lib/vagrant-libvirt/action/read_state.rb
 - lib/vagrant-libvirt/action/resume_domain.rb
 - lib/vagrant-libvirt/action/set_name_of_domain.rb
+- lib/vagrant-libvirt/action/share_folders.rb
 - lib/vagrant-libvirt/action/start_domain.rb
 - lib/vagrant-libvirt/action/suspend_domain.rb
 - lib/vagrant-libvirt/action/sync_folders.rb