vagrant-libvirt 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b81bd9999cef0982201e37382c06ce3657bfe4442f060864c3f659ffc2ce37
-  data.tar.gz: e44c22486556883da8170f757cc8c3a29a4a98b07460c4b1098cb4aaed7566b3
+  metadata.gz: 9e37a27120aef75fdd73d704321b96c7c881b07fa3cbdd655855300bf11163a3
+  data.tar.gz: 4639827cc360b3f06304310f02dffea445f19d2f4b8675a6e0e05a9be3cea307
 SHA512:
-  metadata.gz: ca1762baa21c39a9e047128f87cae3decedf38fee218bd741ebe0b40779d95bf306926a53c42038e3d4556f1484edb811868b3f612d37c574382afcf14516788
-  data.tar.gz: daabf0d91e896deb468a79ea287c52137991a04c9befabeab53e700dbbe580a17ba019da8b817a6e3a8148b81f5a26e86c112c2d0f05ba216595ea4c56a0dac6
+  metadata.gz: cb13d39445a95f3514cc1be73bcf6e81ec7924959ec86e6cc712c50050ac8211f6b5beb26bbd42c137020e98143794d7b67aa7241e2461cdf2d1ca5ed2a15c30
+  data.tar.gz: b341135cabad7d59963df62e9dd921470a43e4794fb203ff78b893bd058a38af877717f48b25a72135211e72d82082ec444227b97157e365903103240dfb1311

data/README.md

@@ -18,7 +18,10 @@ can help a lot :-)
 
 * [Features](#features)
 * [Future work](#future-work)
-* [Using Docker based Installation](#using-docker-based-installation)
+* [Using the container image](#using-the-container-image)
+  * [Using Docker](#using-docker)
+  * [Using Podman](#using-podman)
+  * [Extending the Docker image with additional vagrant plugins](#extending-the-docker-image-with-additional-vagrant-plugins)
 * [Installation](#installation)
   * [Possible problems with plugin installation on Linux](#possible-problems-with-plugin-installation-on-linux)
   * [Additional Notes for Fedora and Similar Linux Distributions](#additional-notes-for-fedora-and-similar-linux-distributions)
@@ -99,7 +102,7 @@ can help a lot :-)
 * Take a look at [open
   issues](https://github.com/vagrant-libvirt/vagrant-libvirt/issues?state=open).
 
-## Using Docker based Installation
+## Using the container image
 
 Due to the number of issues encountered around compatibility between the ruby runtime environment
 that is part of the upstream vagrant installation and the library dependencies of libvirt that
@@ -109,11 +112,31 @@ This should allow users to execute vagrant with vagrant-libvirt without needing
 the compatibility issues, though you may need to extend the image for your own needs should
 you make use of additional plugins.
 
-To get the image:
+Note the default image contains the full toolchain required to build and install vagrant-libvirt
+and it's dependencies. There is also a smaller image published with the `-slim` suffix if you
+just need vagrant-libvirt and don't need to install any additional plugins for your environment.
+
+If you are connecting to a remote system libvirt, you may omit the
+`-v /var/run/libvirt/:/var/run/libvirt/` mount bind. Some distributions patch the local
+vagrant environment to ensure vagrant-libvirt uses `qemu:///session`, which means you
+may need to set the environment variable `LIBVIRT_DEFAULT_URI` to the same value if
+looking to use this in place of your distribution provided installation.
+
+### Using Docker
+
+To get the image with the most recent release:
 ```bash
 docker pull vagrantlibvirt/vagrant-libvirt:latest
 ```
 
+---
+**Note** If you want the very latest code you can use the `edge` tag instead.
+
+```bash
+docker pull vagrantlibvirt/vagrant-libvirt:edge
+```
+---
+
 Preparing the docker run, only once:
 
 ```bash
@@ -126,33 +149,73 @@ docker run -it --rm \
   -e LIBVIRT_DEFAULT_URI \
   -v /var/run/libvirt/:/var/run/libvirt/ \
   -v ~/.vagrant.d:/.vagrant.d \
-  -v $(pwd):$(pwd) \
-  -w $(pwd) \
+  -v $(realpath "${PWD}"):${PWD} \
+  -w $(realpath "${PWD}") \
   --network host \
   vagrantlibvirt/vagrant-libvirt:latest \
     vagrant status
 ```
 
-It's possible to define an alias in `~/.bashrc`, for example:
+It's possible to define a function in `~/.bashrc`, for example:
 ```bash
-alias vagrant='
-  mkdir -p ~/.vagrant.d/{boxes,data,tmp}; \
+vagrant(){
   docker run -it --rm \
     -e LIBVIRT_DEFAULT_URI \
     -v /var/run/libvirt/:/var/run/libvirt/ \
     -v ~/.vagrant.d:/.vagrant.d \
-    -v $(pwd):$(pwd) \
-    -w $(pwd) \
+    -v $(realpath "${PWD}"):${PWD} \
+    -w $(realpath "${PWD}") \
     --network host \
     vagrantlibvirt/vagrant-libvirt:latest \
-    vagrant'
+      vagrant $@
+}
+
 ```
 
-Note that if you are connecting to a remote system libvirt, you may omit the
-`-v /var/run/libvirt/:/var/run/libvirt/` mount bind. Some distributions patch the local
-vagrant environment to ensure vagrant-libvirt uses `qemu:///session`, which means you
-may need to set the environment variable `LIBVIRT_DEFAULT_URI` to the same value if
-looking to use this in place of your distribution provided installation.
+### Using Podman
+To run with Podman you need to include
+
+```bash
+  --entrypoint /bin/bash \
+  --security-opt label=disable \
+  -v ~/.vagrant.d/boxes:/vagrant/boxes \
+  -v ~/.vagrant.d/data:/vagrant/data \
+```
+
+for example:
+
+```bash
+vagrant(){
+  podman run -it --rm \
+    -e LIBVIRT_DEFAULT_URI \
+    -v /var/run/libvirt/:/var/run/libvirt/ \
+    -v ~/.vagrant.d/boxes:/vagrant/boxes \
+    -v ~/.vagrant.d/data:/vagrant/data \
+    -v $(realpath "${PWD}"):${PWD} \
+    -w $(realpath "${PWD}") \
+    --network host \
+    --entrypoint /bin/bash \
+    --security-opt label=disable \
+    docker.io/vagrantlibvirt/vagrant-libvirt:latest \
+      vagrant $@
+}
+```
+
+Running Podman in rootless mode maps the root user inside the container to your host user so we need to bypass [entrypoint.sh](https://github.com/vagrant-libvirt/vagrant-libvirt/blob/master/entrypoint.sh) and mount persistent storage directly to `/vagrant`. 
+
+### Extending the Docker image with additional vagrant plugins
+
+By default the image published and used contains the entire tool chain required
+to reinstall the vagrant-libvirt plugin and it's dependencies, as this is the
+default behaviour of vagrant anytime a new plugin is installed. This means it
+should be possible to use a simple `FROM` statement and ask vagrant to install
+additional plugins.
+
+```
+FROM vagrantlibvirt/vagrant-libvirt:latest
+
+RUN vagrant plugin install <plugin>
+```
 
 ## Installation
 
@@ -907,6 +970,23 @@ 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.
 
+It is also possible to use the Qemu Agent to extract the management interface
+configuration from the booted virtual machine. This is helpful in libvirt
+environments where no local dnsmasq is used for automatic address assigment,
+but external dhcp services via bridged libvirt networks.
+
+Prerequisite is to enable the qemu agent channel via ([Libvirt communication
+channels](#libvirt-communication-channels)) and the virtual machine image must
+have the agent pre-installed before deploy. The agent will start automatically
+if it detects an attached channel during boot.
+
+* `qemu_use_agent` - false by default, if set to true, attempt to extract configured
+  ip address via qemu agent.
+
+To use the management network interface with an external dhcp service you need
+to setup a bridged host network manually and define it via
+`management_network_name` in your Vagrantfile.
+
 ## Additional Disks
 
 You can create and attach additional disks to a VM via `libvirt.storage :file`.
@@ -1068,13 +1148,14 @@ The USB controller can be configured using `libvirt.usb_controller`, with the fo
 Vagrant.configure("2") do |config|
   config.vm.provider :libvirt do |libvirt|
     # Set up a USB3 controller
-    libvirt.usb_controller :model => "nec-xhci"
+    libvirt.usb_controller :model => "qemu-xhci"
   end
 end
 ```
 
 See the [libvirt documentation](https://libvirt.org/formatdomain.html#elementsControllers) for a list of valid models.
 
+If any USB devices are passed through by setting `libvirt.usb` or `libvirt.redirdev`, a default controller will be added using the model `qemu-xhci` in the absence of a user specified one. This should help ensure more devices work out of the box as the default configured by libvirt is pii3-uhci, which appears to only work for USB 1 devices and does not work as expected when connected via a USB 2 controller, while the xhci stack should work for all versions of USB.
 
 ### USB Device Passthrough
 
@@ -1095,6 +1176,17 @@ The example values above match the device from the following output of `lsusb`:
 Bus 001 Device 002: ID 1234:abcd Example device
 ```
 
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.provider :libvirt do |libvirt|
+    # pass through specific device based on identifying it
+    libvirt.usbdev :vendor => '0x1234', :product => '0xabcd'
+    # pass through a host device where multiple of the same vendor/product exist
+    libvirt.usbdev :bus => '1', :device => '1'
+  end
+end
+```
+
 Additionally, the following options can be used:
 
 * `startupPolicy` - Is passed through to Libvirt and controls if the device has
@@ -1151,7 +1243,7 @@ In this case, the USB device with `class 0x0b`, `vendor 0x08e6`, `product 0x3437
 Vagrant.configure("2") do |config|
   config.vm.provider :libvirt do |libvirt|
     libvirt.redirdev :type => "spicevmc"
-    libvirt.redirfilter :class => "0x0b" :vendor => "0x08e6" :product => "0x3437" :version => "2.00" :allow => "yes"
+    libvirt.redirfilter :class => "0x0b", :vendor => "0x08e6", :product => "0x3437", :version => "2.00", :allow => "yes"
     libvirt.redirfilter :allow => "no"
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 
 module VagrantPlugins

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 
 module VagrantPlugins
@@ -398,9 +400,14 @@ module VagrantPlugins
           # Create Libvirt domain.
           # Is there a way to tell fog to create new domain with already
           # existing volume? Use domain creation from template..
+          xml = to_xml('domain')
+          @logger.debug {
+            "Creating Domain with XML:\n#{xml}"
+          }
+
           begin
             server = env[:machine].provider.driver.connection.servers.create(
-              xml: to_xml('domain')
+              xml: xml
             )
           rescue Fog::Errors::Error => e
             raise Errors::FogCreateServerError, error_message: e.message

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 
 module VagrantPlugins
@@ -76,6 +78,9 @@ module VagrantPlugins
               else
                   pool_name = config.storage_pool_name
               end
+              @logger.debug {
+                "Creating Volume with XML:\n#{xml}"
+              }
               @logger.debug "Using pool #{pool_name} for base box snapshot"
               domain_volume = env[:machine].provider.driver.connection.volumes.create(
                 xml: xml,

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 require 'vagrant/util/network_ip'
 require 'vagrant/util/scoped_hash_override'
@@ -128,10 +130,10 @@ module VagrantPlugins
             end
 
             message = "Creating network interface eth#{@iface_number}"
-            message << " connected to network #{@network_name}."
+            message += " connected to network #{@network_name}."
             if @mac
               @mac = @mac.scan(/(\h{2})/).join(':')
-              message << " Using MAC address: #{@mac}"
+              message += " Using MAC address: #{@mac}"
             end
             @logger.info(message)
 
@@ -157,6 +159,9 @@ module VagrantPlugins
                     else
                       to_xml(template_name)
                     end
+              @logger.debug {
+                "Attaching Network Device with XML:\n#{xml}"
+              }
               domain.attach_device(xml)
             rescue => e
               raise Errors::AttachDeviceError,
@@ -246,6 +251,7 @@ module VagrantPlugins
                           udp_tunnel={}, pci_bus, pci_slot)
           Nokogiri::XML::Builder.new do |xml|
             xml.interface(type: type || 'network') do
+              xml.alias(name: "ua-net-#{iface_number}")
               xml.source(source_options) do
                 xml.local(udp_tunnel) if type == 'udp'
               end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 require 'vagrant/util/network_ip'
 require 'vagrant/util/scoped_hash_override'
@@ -160,7 +162,7 @@ module VagrantPlugins
             if @interface_network[:created]
               # Just check for mismatch error here - if name and ip from
               # config match together.
-              if @options[:network_name] != @interface_network[:name]
+              if @options[:network_name] != @interface_network[:name] and @qemu_use_agent == false
                 raise Errors::NetworkNameAndAddressMismatch,
                       ip_address:   @options[:ip],
                       network_name: @options[:network_name]
@@ -312,8 +314,7 @@ module VagrantPlugins
 
           if @options[:dhcp_enabled]
             # Find out DHCP addresses pool range.
-            network_address = "#{@interface_network[:network_address]}/"
-            network_address << (@interface_network[:netmask]).to_s
+            network_address = "#{@interface_network[:network_address]}/#{(@interface_network[:netmask]).to_s}"
             net = @interface_network[:network_address] ? IPAddr.new(network_address) : nil
 
             # First is address of network, second is gateway (by default).
@@ -336,8 +337,12 @@ module VagrantPlugins
           @network_domain_name = @options[:domain_name]
 
           begin
+            xml = to_xml('private_network')
+            @logger.debug {
+              "Creating private network with XML:\n#{xml}"
+            }
             @interface_network[:libvirt_network] = \
-              @libvirt_client.define_network_xml(to_xml('private_network'))
+              @libvirt_client.define_network_xml(xml)
             @logger.debug 'created network'
           rescue => e
             raise Errors::CreateNetworkError, error_message: e.message
@@ -345,10 +350,9 @@ module VagrantPlugins
 
           created_networks_file = env[:machine].data_dir + 'created_networks'
 
-          message = 'Saving information about created network '
-          message << "#{@interface_network[:name]}, "
-          message << "UUID=#{@interface_network[:libvirt_network].uuid} "
-          message << "to file #{created_networks_file}."
+          message = 'Saving information about created network ' \
+            "#{@interface_network[:name]}, UUID=#{@interface_network[:libvirt_network].uuid} " \
+            "to file #{created_networks_file}."
           @logger.info(message)
 
           File.open(created_networks_file, 'a') do |file|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 
 module VagrantPlugins

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 require 'nokogiri'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action
@@ -104,7 +106,7 @@ module VagrantPlugins
             IdentitiesOnly=#{ssh_info[:keys_only] ? 'yes' : 'no'}
           ) + ssh_info[:private_key_path].map do |pk|
                 "IdentityFile='\"#{pk}\"'"
-              end).map { |s| s.prepend('-o ') }.join(' ')
+              end).map { |s| "-o #{s}" }.join(' ')
 
           options += " -o ProxyCommand=\"#{ssh_info[:proxy_command]}\"" if machine.provider_config.proxy_command
 
@@ -116,12 +118,12 @@ module VagrantPlugins
               env[:ui].info 'Requesting sudo for host port(s) <= 1024'
               r = system('sudo -v')
               if r
-                ssh_cmd << 'sudo ' # add sudo prefix
+                ssh_cmd += 'sudo ' # add sudo prefix
               end
             end
           end
 
-          ssh_cmd << "ssh -n #{options} #{params}"
+          ssh_cmd += "ssh -n #{options} #{params}"
 
           @logger.debug "Forwarding port with `#{ssh_cmd}`"
           log_file = ssh_forward_log_file(
@@ -180,10 +182,10 @@ module VagrantPlugins
               kill_cmd = ''
 
               if tag[:port] <= 1024
-                kill_cmd << 'sudo ' # add sudo prefix
+                kill_cmd += 'sudo ' # add sudo prefix
               end
 
-              kill_cmd << "kill #{tag[:pid]}"
+              kill_cmd += "kill #{tag[:pid]}"
               @@lock.synchronize do
                 system(kill_cmd)
               end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 
 module VagrantPlugins
@@ -11,41 +13,9 @@ module VagrantPlugins
         end
 
         def call(env)
-          env[:ui].info(I18n.t('vagrant_libvirt.halt_domain'))
-
-          timeout = env[:machine].config.vm.graceful_halt_timeout
           domain = env[:machine].provider.driver.connection.servers.get(env[:machine].id.to_s)
-          raise Errors::NoDomainError if domain.nil?
-
-          if env[:force_halt]
-            domain.poweroff
-            return @app.call(env)
-          end
-
-          begin
-            Timeout.timeout(timeout) do
-              begin
-                env[:machine].guest.capability(:halt)
-              rescue Timeout::Error
-                raise
-              rescue
-                @logger.info('Trying Libvirt graceful shutdown.')
-                # Read domain object again
-                dom = env[:machine].provider.driver.connection.servers.get(env[:machine].id.to_s)
-                if dom.state.to_s == 'running'
-                  dom.shutdown
-                end
-              end
-
-              domain.wait_for(timeout) do
-                !ready?
-              end
-            end
-          rescue Timeout::Error
-            @logger.info('VM is still running. Calling force poweroff.')
-            domain.poweroff
-          rescue
-            @logger.error('Failed to shutdown cleanly. Calling force poweroff.')
+          if env[:machine].state.id == :running
+            env[:ui].info(I18n.t('vagrant_libvirt.halt_domain'))
             domain.poweroff
           end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 require 'open3'
 require 'json'
@@ -85,7 +87,6 @@ module VagrantPlugins
           box_virtual_size = env[:box_volumes][0][:virtual_size]
           if config.machine_virtual_size
             config_machine_virtual_size = ByteNumber.from_GB(config.machine_virtual_size)
-            puts config_machine_virtual_size < box_virtual_size
             if config_machine_virtual_size < box_virtual_size
               # Warn that a virtual size less than the box metadata size
               # is not supported and will be ignored
@@ -180,8 +181,7 @@ module VagrantPlugins
             raise Vagrant::Errors::BoxNotFound, name: env[:machine].box.name
           end
           box_image_size = File.size(box_image_file) # B
-          message = "Creating volume #{box_volume[:name]}"
-          message << " in storage pool #{config.storage_pool_name}."
+          message = "Creating volume #{box_volume[:name]} in storage pool #{config.storage_pool_name}."
           @logger.info(message)
           begin
             fog_volume = env[:machine].provider.driver.connection.volumes.create(

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log4r'
 
 module VagrantPlugins
@@ -42,8 +44,12 @@ module VagrantPlugins
               @storage_pool_path = storage_pool_path(env)
               @storage_pool_uid = storage_uid(env)
               @storage_pool_gid = storage_gid(env)
+              xml = to_xml('default_storage_pool')
+              @logger.debug {
+                "Creating Storage Pool with XML:\n#{xml}"
+              }
               libvirt_pool = env[:machine].provider.driver.connection.client.define_storage_pool_xml(
-                to_xml('default_storage_pool')
+                xml
               )
               libvirt_pool.build
               libvirt_pool.create

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action