vagrant-libvirt 0.0.41 → 0.0.42

data/Rakefile

@@ -0,0 +1,8 @@
+#require 'rubygems'
+#require 'bundler/setup'
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+task default: [:deftask]
+task :deftask do
+  puts 'call rake -T'
+end

data/example_box/README.md

@@ -0,0 +1,29 @@
+# Vagrant Libvirt Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `libvirt` provider.
+To turn this into a box create a vagrant image according documentation (don't
+forget to install rsync command) and create box with following command:
+
+```
+$ tar cvzf custom_box.box ./metadata.json ./Vagrantfile ./box.img
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for Libvirt. These defaults can easily be overwritten by higher-level
+Vagrantfiles (such as project root Vagrantfiles).
+
+## Box Metadata
+
+Libvirt box should define at least three data fields in `metadata.json` file.
+
+* provider - Provider name is libvirt.
+* format - Currently supported format is qcow2.
+* virtual_size - Virtual size of image in GBytes.
+
+## Converting Boxes
+
+Instead of creating a box from scratch, you can use 
+[vagrant-mutate](https://github.com/sciurus/vagrant-mutate) 
+to take boxes created for other Vagrant providers and use them 
+with vagrant-libvirt.

data/example_box/Vagrantfile

@@ -0,0 +1,60 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+
+  # Example configuration of new VM..
+  # 
+  #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
+    # 
+    # Networking features in the form of `config.vm.network`
+    #
+    #test_vm.vm.network :private_network, :ip => '10.20.30.40'
+    #test_vm.vm.network :public_network, :ip => '10.20.30.41'
+  #end
+
+  # Options for libvirt vagrant provider.
+  config.vm.provider :libvirt do |libvirt|
+
+    # A hypervisor name to access. Different drivers can be specified, but
+    # this version of provider creates KVM machines only. Some examples of
+    # drivers are kvm (qemu hardware accelerated), qemu (qemu emulated),
+    # xen (Xen hypervisor), lxc (Linux Containers),
+    # esx (VMware ESX), vmwarews (VMware Workstation) and more. Refer to
+    # documentation for available drivers (http://libvirt.org/drivers.html).
+    libvirt.driver = "kvm"
+
+    # The name of the server, where libvirtd is running.
+    # libvirt.host = "localhost"
+
+    # If use ssh tunnel to connect to Libvirt.
+    libvirt.connect_via_ssh = false
+
+    # The username and password to access Libvirt. Password is not used when
+    # connecting via ssh.
+    libvirt.username = "root"
+    #libvirt.password = "secret"
+
+    # Libvirt storage pool name, where box image and instance snapshots will
+    # be stored.
+    libvirt.storage_pool_name = "default"
+
+    # Set a prefix for the machines that's different than the project dir name.
+    #libvirt.default_prefix = ''
+  end
+end
+

data/example_box/metadata.json

@@ -0,0 +1,5 @@
+{
+  "provider"     : "libvirt",
+  "format"       : "qcow2",
+  "virtual_size" : 16 
+}

data/lib/vagrant-libvirt.rb

@@ -0,0 +1,29 @@
+require 'pathname'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    lib_path = Pathname.new(File.expand_path('../vagrant-libvirt', __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Errors, lib_path.join('errors')
+    autoload :Util, lib_path.join('util')
+
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end
+
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant Libvirt plugin must be run within Vagrant.'
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < '1.5.0'
+  raise 'The Vagrant Libvirt plugin is only compatible with Vagrant 1.5+.'
+end
+
+# make sure base module class defined before loading plugin
+require 'vagrant-libvirt/plugin'

data/lib/vagrant-libvirt/action.rb

@@ -0,0 +1,370 @@
+require 'vagrant/action/builder'
+require 'log4r'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+      @logger = Log4r::Logger.new('vagrant_libvirt::action')
+
+      # remove image from libvirt storage pool
+      def self.remove_libvirt_image
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use RemoveLibvirtImage
+        end
+      end
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            # Create VM if not yet created.
+            if !env[:result]
+              b2.use SetNameOfDomain
+              if !env[:machine].config.vm.box
+                b2.use CreateDomain
+                b2.use CreateNetworks
+                b2.use CreateNetworkInterfaces
+                b2.use SetBootOrder
+                b2.use StartDomain
+              else
+                b2.use HandleStoragePool
+                b2.use HandleBox
+                b2.use HandleBoxImage
+                b2.use CreateDomainVolume
+                b2.use CreateDomain
+
+                b2.use Provision
+                b2.use PrepareNFSValidIds
+                b2.use SyncedFolderCleanup
+                b2.use SyncedFolders
+                b2.use PrepareNFSSettings
+                b2.use ShareFolders
+                b2.use CreateNetworks
+                b2.use CreateNetworkInterfaces
+                b2.use SetBootOrder
+
+                b2.use StartDomain
+                b2.use WaitTillUp
+
+                b2.use ForwardPorts
+                b2.use SetHostname
+                # b2.use SyncFolders
+              end
+            else
+              env[:halt_on_error] = true
+              b2.use action_start
+            end
+          end
+        end
+      end
+
+      # Assuming VM is created, just start it. This action is not called
+      # directly by any subcommand. VM can be suspended, already running or in
+      # poweroff state.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is running, run the necessary provisioners
+            if env[:result]
+              b2.use action_provision
+              next
+            end
+
+            b2.use Call, IsSuspended do |env2, b3|
+              # if vm is suspended resume it then exit
+              if env2[:result]
+                b3.use CreateNetworks
+                b3.use ResumeDomain
+                next
+              end
+
+              if !env[:machine].config.vm.box
+                # With no box, we just care about network creation and starting it
+                b3.use CreateNetworks
+                b3.use SetBootOrder
+                b3.use StartDomain
+              else
+                # VM is not running or suspended.
+
+                b3.use Provision
+
+                # Ensure networks are created and active
+                b3.use CreateNetworks
+                b3.use SetBootOrder
+
+                b3.use PrepareNFSValidIds
+                b3.use SyncedFolderCleanup
+                b3.use SyncedFolders
+
+                # Start it..
+                b3.use StartDomain
+
+                # Machine should gain IP address when comming up,
+                # so wait for dhcp lease and store IP into machines data_dir.
+                b3.use WaitTillUp
+
+                b3.use ForwardPorts
+                b3.use PrepareNFSSettings
+                b3.use ShareFolders
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for halting the
+      # virtual machine.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ClearForwardedPorts
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsSuspended do |env2, b3|
+              b3.use CreateNetworks if env2[:result]
+              b3.use ResumeDomain if env2[:result]
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              next unless env2[:result]
+
+              # VM is running, halt it.
+              b3.use HaltDomain
+            end
+          end
+        end
+      end
+
+      # This is the action implements the reload command
+      # It uses the halt and start actions
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConfigValidate
+            b2.use action_halt
+            b2.use action_start
+          end
+        end
+      end
+
+      # not implemented and looks like not require
+      def self.action_package
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use PackageDomain
+        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 ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              # Try to remove stale volumes anyway
+              b2.use SetNameOfDomain
+              b2.use RemoveStaleVolume if env[:machine].config.vm.box
+              b2.use MessageNotCreated unless env[:result]
+
+              next
+            end
+
+            b2.use Call, DestroyConfirm do |env2, b3|
+              if env2[:result]
+                b3.use ClearForwardedPorts
+                # b3.use PruneNFSExports
+                b3.use DestroyDomain
+                b3.use DestroyNetworks
+                b3.use ProvisionerCleanup
+              else
+                b3.use MessageWillNotDestroy
+              end
+            end
+          end
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use SSHExec
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use Provision
+              # b3.use SyncFolders
+            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 ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+              b3.use SuspendDomain
+            end
+          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 ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsSuspended do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotSuspended
+                next
+              end
+              b3.use CreateNetworks
+              b3.use ResumeDomain
+            end
+          end
+        end
+      end
+
+      def self.action_read_mac_addresses
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ReadMacAddresses
+        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 ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use SSHRun
+            end
+          end
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :PackageDomain, action_root.join('package_domain')
+      autoload :CreateDomain, action_root.join('create_domain')
+      autoload :CreateDomainVolume, action_root.join('create_domain_volume')
+      autoload :CreateNetworkInterfaces, action_root.join('create_network_interfaces')
+      autoload :CreateNetworks, action_root.join('create_networks')
+      autoload :DestroyDomain, action_root.join('destroy_domain')
+      autoload :DestroyNetworks, action_root.join('destroy_networks')
+      autoload :ForwardPorts, action_root.join('forward_ports')
+      autoload :ClearForwardedPorts, action_root.join('forward_ports')
+      autoload :HaltDomain, action_root.join('halt_domain')
+      autoload :HandleBoxImage, action_root.join('handle_box_image')
+      autoload :HandleStoragePool, action_root.join('handle_storage_pool')
+      autoload :RemoveLibvirtImage, action_root.join('remove_libvirt_image')
+      autoload :IsCreated, action_root.join('is_created')
+      autoload :IsRunning, action_root.join('is_running')
+      autoload :IsSuspended, action_root.join('is_suspended')
+      autoload :MessageAlreadyCreated, action_root.join('message_already_created')
+      autoload :MessageNotCreated, action_root.join('message_not_created')
+      autoload :MessageNotRunning, action_root.join('message_not_running')
+      autoload :MessageNotSuspended, action_root.join('message_not_suspended')
+      autoload :MessageWillNotDestroy, action_root.join('message_will_not_destroy')
+
+      autoload :RemoveStaleVolume, action_root.join('remove_stale_volume')
+
+      autoload :PrepareNFSSettings, action_root.join('prepare_nfs_settings')
+      autoload :PrepareNFSValidIds, action_root.join('prepare_nfs_valid_ids')
+      autoload :PruneNFSExports, action_root.join('prune_nfs_exports')
+
+      autoload :ReadMacAddresses, action_root.join('read_mac_addresses')
+      autoload :ResumeDomain, action_root.join('resume_domain')
+      autoload :SetNameOfDomain, action_root.join('set_name_of_domain')
+      autoload :SetBootOrder, action_root.join('set_boot_order')
+
+      # I don't think we need it anymore
+      autoload :ShareFolders, action_root.join('share_folders')
+      autoload :StartDomain, action_root.join('start_domain')
+      autoload :SuspendDomain, action_root.join('suspend_domain')
+      autoload :TimedProvision, action_root.join('timed_provision')
+
+      autoload :WaitTillUp, action_root.join('wait_till_up')
+      autoload :PrepareNFSValidIds, action_root.join('prepare_nfs_valid_ids')
+
+      autoload :SSHRun, 'vagrant/action/builtin/ssh_run'
+      autoload :HandleBox, 'vagrant/action/builtin/handle_box'
+      autoload :SyncedFolders, 'vagrant/action/builtin/synced_folders'
+      autoload :SyncedFolderCleanup, 'vagrant/action/builtin/synced_folder_cleanup'
+      autoload :ProvisionerCleanup, 'vagrant/action/builtin/provisioner_cleanup'
+    end
+  end
+end