vagrant-kvm 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9a60c53d1481a84c960b7f3abef307b431ceadb
-  data.tar.gz: 51c04fe1ec462079d8d7711d101544227a418c14
+  metadata.gz: 79770b8d1889daab867e796d16fe319c0c0eca24
+  data.tar.gz: db7ef74f5ec15c7fa3c931a4a54723bc890742b7
 SHA512:
-  metadata.gz: 40ce772d899d500bebfbc56f639936a1028c1c7e5bf22f5fc481734e95920702cf14498da92bbc2846933ad8e33e72d63678803c0a4f83f33d433cef9af368d8
-  data.tar.gz: 4ca877c4945e9e8fc67a1c28259c805afbfbf349ed06338ead92855039a069997176d1739770b9ac0b797402f3591444bf9ce6d5f34630a7a0c29ffa7a95be9b
+  metadata.gz: 72729349c6a2aa2c1b529cbb49c4c1ffcf89e6533eacb5e668e539ac8c974d35b22c2cba0ee1916f2b7bee57e2b93efd57757c04f4aaf7e5f77e64ec7bd86d5b
+  data.tar.gz: fbec7423931ee5a19a2d09501eb1c7cd42b1bf50f3ceabfbd7049c40b2f1dd0aa45c771018e894b181a44fe4668cea0a16cc4a83c294c83825dd0ee0e7e81011

data/.gitignore

@@ -7,6 +7,11 @@
 pkg/*
 tags
 Gemfile.lock
+vendor/ruby
+
+# Rbenv/RVM
+.ruby-version
+.rvmrc
 
 # Vagrant
 .vagrant

data/CHANGELOG.md

@@ -1,10 +1,3 @@
-# 0.1.6 (April, ?, 2014)
-
-* Support Vagrant 1.5.x[GH-188][GH-187][GH-186][GH-174]
-* Handle Vagrant 1.5 migration with box folder structure change
-* Document vagrant-1.4 to 1.5 migration [GH-189]
-* Fix spec test error
-
 # 0.1.5 (March 22, 2014)
 
 * Change default box format to qcow2 [GH-63]

data/DEVELOPMENT.md

@@ -59,6 +59,13 @@ There are two `Vagrantfile` to help developers.
 - `spec/fedora/Vagrantfile` make an alternative environment on Fedora guest.
 
 
+## Tests
+
+We use Rspec and Travis-CI for continous integration and unit test.
+
+Tests are located in `spec` directory.
+Every PR should be tested and passes Travis-CI test before merging.
+
 ## Specs
 
 To run specs, you first need to add and prepare the Vagrant box which will be used.
@@ -80,6 +87,68 @@ When you're done, feel free to remove the box.
 $ bundle exec rake box:remove
 ```
 
+## Milestones and versions
+
+### Milestones
+We set milestones for future releases. Vagrant-KVM is under active development and still in development status. The next several milestones are targeted to implement new features such as support of new vagrant versions, multi-vm support, virtfs support, and so on.
+
+### Versions
+
+We use (major).(minor).(patchlevel) versioning.
+In development status, major version is 0.
+When Implementing major features, we increment minor version such as 0.2.0.
+
+When it reaches beta status, it may be 0.9.x.
+
+When it reaches production status, it become 1.0.0.
+
+Before 0.9.x, APIs, configuration parameters and other behaviors will be changed without caution or migration pass.
+
+## Branches
+
+We basically use `master` branch for development in 0.x series.
+It is an exception when we need to release interim release to previous version that includes only single or some fixes. When necessary we make `-maint` branch such as `v0.1.5-maint`.
+It becomes next release and planed version is incremented.
+
+Here is an example.
+
+We have released v0.1.5 in March, 2014. We started development for v0.1.6 to add more feature and merged several changes just after releasing v0.1.5. We found v0.1.5 is not working with Vagrant 1.5 that is released in March, 2014. Because it is not welcome to wait to a normal v0.1.6 release for Vagrant 1.5 support, we decided to release interim fix release as v0.1.6. 
+We start release branch 'v0.1.5-maint' for v0.1.6 release.
+The release number of new features on `master` is changed to v0.1.7 not v0.1.6.
+
+
+### How To Contribute
+
+* Clone: git clone git://github.com/adrahon/vagrant-kvm.git
+
+* Get Setup
+
+* Create a topic branch: git checkout -b awesome_feature
+
+* Hack and Commit away.
+
+* Keep up to date: git fetch && git rebase origin/master
+
+* Test with Rspec
+
+Once you’re ready:
+
+* Fork the project on GitHub
+
+* Add your repository as a remote: git remote add your_remote your_repo
+
+* (Optional) setup Travis-CI for your repository
+
+* Push up your branch: git push your_remote awesome_feature
+
+* (Optional) check your Travis score whether passed
+
+* Create a Pull Request for the topic branch, asking for review.
+
+* Check your PR is passed on Travis
+
+* If not, fix your commit and push to your repository: git push your_remote awesome_feature
+
 ## Travis-CI
 
 TBD

data/INSTALL.md

@@ -89,7 +89,7 @@ and box directory.
 $ sudo yum install policycoreutils-python
 $ semanage fcontext -a -t virt_image_t "~/.vagrant.d/tmp/storage-pool(/.*)?"
 $ restorecon -R ~/.vagrant.d/tmp/storage-pool
-$ semanage fcontext -a -t virt_image_t "~/.vagrant.d/boxes(/.*)?"
+$ semanage fcontext -a -t virt_context_t "~/.vagrant.d/boxes(/.*)?"
 $ restorecon -R ~/.vagrant.d/boxes
 ```
 

data/README.md

@@ -2,7 +2,7 @@
 
 # Vagrant KVM Provider
 
-This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds a KVM
+This is a [Vagrant](http://www.vagrantup.com) 1.4+ plugin that adds a KVM
 provider to Vagrant, allowing Vagrant to control and provision KVM/QEMU VM.
 
 ## Requirements
@@ -19,15 +19,22 @@ Default image format is now qcow2 instead of sparsed raw image, with qcow2
 `vagrant-kvm` uses the box volume as a backing volume so that VM creation is
 a lot faster. In most cases you want to use qcow2.
 
-OVF boxes conversion as been removed, you should use `vagrant-mutate` instead.
+OVF boxes conversion has been removed, you should use `vagrant-mutate` instead.
+
+Synced folders are now provided by a QEMU/KVM Virtfs in default.
+You can also use NFS for file share using `type: "nfs"` option.
+
+There was a known libvirt bug in Ubuntu host:
+https://bugs.launchpad.net/ubuntu/+source/libvirt/+bug/943680
+It was solved in Ubuntu 14.04(Trusty) and a backported libvirt provided by PPA above.
 
 ## Features/Limitations
 
 * Provides the same workflow as the Vagrant VirtualBox provider.
-* Uses NFS for sync folders
+* Uses Virtfs for sync folders
 * Only works with 1 VM per Vagrantfile for now
 * Requires "libvirtd" group membership to run Vagrant (Debian/Ubuntu only)
-* Requires backporting qemu and libvirt from experimental (Debian) or raring (Ubuntu)
+* Requires backporting qemu and libvirt from experimental (Debian) or trusty (Ubuntu)
 * Use qcow2 backing image by default, which should make VM creation very fast
 
 ## Known issues
@@ -38,62 +45,60 @@ Vagrant 1.5 changes a structure of user boxes directories.
 vagrant-KVM handle box directory as libvirt/qemu temporary spool,
 but Vagrant 1.5 changes it at first time launched.
 
-If you got `Call to virStoragePoolCreate failed: cannot open path` error, or
-`Your vagrant-kvm environment should be fixed. see README`,
-please follow the instructions bellow.
+Unfortunately vagrant-KVM 0.1.5 does not run on Vagrant-1.5.x.
+Users who interested in vagrant-kvm 0.1.5 may use with Vagrant 1.4.x.
 
-1. Upgrade vagrant-kvm to vagrant-kvm  0.1.6 or after
+This caused problem when following sinario:
 
-2. Clear all vagrant storage pool definitions
+1. user use vagrant-kvm 0.1.5 with vagrant-1.4.x
+2. user upgrade vagrant 1.5.x
+3. user upgrade vagrant 0.1.5.1 and after
 
-3. restart libvirt daemon
+ We use transient pool instead of persistent one
+in vagrant-kvm 0.1.5.x, 0.1.6 and after
+Pools defined by vagrant-kvm will be removed after system reboot.
+
+We recommend to use following combinations.
+
+- Vagrant 1.3.x or before, and Vagrant-KVM 0.1.4
+
+- Vagrant 1.5.x or after, and  Vagrant-KVM 0.1.5.1 or after
+
+If you are joining test for vagrant-kvm or other reasons you use vagrant-kvm 0.1.5 with vagrant 1.4.x,
+you got `Call to virStoragePoolCreate failed: cannot open path` error, please follow the instructions below.
+Please take care when running commands as root.
 
-#### how to clear storage pool
+1. Upgrade vagrant-kvm to vagrant-kvm  0.1.5.1 or after
+
+2. Clear all storage definitions.
 
 ```bash
-$ sudo -i
-# ls /etc/libvirt/storage/vagrant*
-/etc/libvirt/storage/vagrant_1000_archlinux-x86_64-20140325.xml
-/etc/libvirt/storage/vagrant_1000_centos-6.5-20140316.xml
-/etc/libvirt/storage/vagrant_1000_centos-6.5-20140324.xml
-/etc/libvirt/storage/vagrant_1000_vagrant-kvm.xml
-/etc/libvirt/storage/vagrant.xml
-# rm -i /etc/libvirt/storage/vagrant*
-rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_archlinux-x86_64-20140325.xml’? y
-rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_centos-6.5-20140316.xml’? y
-rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_centos-6.5-20140324.xml’? y
-rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_vagrant-kvm.xml’? y
-rm: remove regular file ‘/etc/libvirt/storage/vagrant.xml’? y
-# ls /etc/libvirt/storage/vagrant*
-ls: cannot access /etc/libvirt/storage/vagrant*: No such file or directory
-# exit
+$ sudo ls /etc/libvirt/storage/vagrant*
+$ sudo rm /etc/libvirt/storage/vagrant*
+$ sudo ls /etc/libvirt/storage/vagrant*
 ```
 
 alternative way:
 
 * open virt-manager
 * connect to localhost
-* right click connection and open details
+* right click and open details
 * click storage tab
-* right click each 'vagrant*' storage pool and delete it.
+* right click 'vagrant*' storage pool and delete it.
 
-#### how to restart libvirt daemon
+3. restart libvirt daemon
 
 Ubuntu/Debian
 ```bash
 $ sudo service libvirt-bin restart
 ```
 
-Fedora/CentOS/SuSE/Arch previous versions
-```bash
-$ sudo service libvirtd restart
-```
-
-Fedora/CentOS/SuSE/Arch recent versions
+Fedora/CentOS/SuSE/Arch
 ```bash
 $ sudo systemctl restart libvirtd
 ```
 
+
 ### Ubuntu
 Some versions of Ubuntu kernel has a bug that will cause vagrant-kvm
 to fail with a permission error on `vagrant up`. It is a kernel bug with the AppArmor security framework.
@@ -129,8 +134,8 @@ Then restart libvirtd.
 $ sudo systemctl restart libvirtd
 ```
 
-This may or may not be sufficient to make it work with Fedora, there are still
-some issues for some users on Fedora 20.
+Another option is to specify an existing local storage pool with the
+`storage-pool` option for the KVM provider in your Vagrantfile (see below).
 
 ## Usage
 
@@ -171,11 +176,13 @@ then you can simply run `vagrant up` to use the kvm provider.
 
 There are some provider specific parameter to control VM definition.
 
-* `cpu_model` - cpu architecture: 'i686' or 'x86_64': default is x86_64. Note
+* `cpu_model` - cpu architecture: 'i686' or 'x86\_64': default is x86\_64. Note
   that your base box should specify this.
 * `core_number` - number of cpu cores.
 * `memory_size` - memory size such as 512m, 1GiB, 100000KiB, unit is KiB if
   unspecified.
+* `storage_pool` - specify an existing local storage pool to use instead of
+  vagrant's own.
 * `gui` - boolean for starting VM with VNC enabled.
 * `vnc_port` - The port the VNC server listens to. Default is automatic port
 assignment.
@@ -189,16 +196,23 @@ in this flag being automatically turned on by KVM.
 * `machine_type` - The type of machine to boot. Default is pc-1.2.
 * `network_model` - The model of the network adapter you want to use. Defaults
 to virtio. Can be set to `:default` if you want to use the KVM default setting.
-Possible values include: ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio.
+Possible values include: ne2k\_isa i82551 i82557b i82559er ne2k\_pci pcnet rtl8139 e1000 virtio.
 * `video_model` - The model of the video adapter. Default to cirrus. Can also be
 set to vga.
 * `image_mode` - Possible value are `clone` or `cow`, defaults to `cow`. If set
 to `clone`, the image disk will be copied rather than use the original box
 image. This is slower but allows multiple VMs to be booted at the same time.
+* `customize` - Customize virtual machine with virsh command. Similar functionality with virtualbox provider.
+* `disk_bus` - disk interface to show virtual disk to guest: 'virtio' or 'sata', 'scsi'
+  A box, which is 'mutate'-ed from virtualbox/vmware box, may specify sata/ide for disk bus.
+  It may be useful to specify 'virtio' for performance, even when box defaults disk bus as sata/ide/scsi.
+* `seclabel` - enables security labelling using selinux, apparmor, dac... based on the host distribution if set to `on`
 * `force_pause` - use `pause` for `vagrant suspend` instead of `suspend`.
   It keeps resource online but execution is stopped.
   When VM has a device that is not supported `hibernate`, automatically use
   `pause` regardless of this.
+* `virtio_rng` - boolean for optional virtio device of random number generator.
+  QEMU 1.3.0 and after support this device. default `false`
 
 
 ## Comparison with [Vagrant-libvirt](https://github.com/pradels/vagrant-libvirt)
@@ -211,7 +225,7 @@ Vagrant-libvirt is a libvirt provider to control machines via the libvirt toolki
 Vagrant-libvirt covers a lot more libvirt options, local and remote hosts and multiple hypervisors,
 such as Xen, LXC and KVM/qemu.
 
-In early 2014, Varant-libvirt only support kvm/qemu in local host, there is no big feature difference.
+In early 2014, Vagrant-libvirt only supports kvm/qemu in local host, there is no big feature difference.
 
 Here are a few difference:
 
@@ -237,7 +251,7 @@ Vagrant-libvirt use qcow2 as disk image.
 ### 3. VNC port/password
 
 Vagrant-kvm allows you to configure how to connect with VNC, which provides virtual guest desktop.
-Vagrant-libvirt is not.
+Vagrant-libvirt does not.
 
 ### 4. Synced folder
 
@@ -248,12 +262,12 @@ without root privilege.
 Vagrant-libvirt provide synced folder with Rsync and NFS.
 They also plan to support virtfs in future.
 
-It is neccesary to fix several bugs in libvirt/qemu to enable
+It is neccesary to fix several bugs in libvirt/qemu to enable the
 virtfs feature in both providers.
 
 ### 5. Snapshots via sahara
 
-Vagrant-kvm plan to support snapshot via sahara.
+Vagrant-kvm plans to support snapshot via sahara.
 We have already proposed to sahara project to add support
 and are waiting for review.
 https://github.com/jedi4ever/sahara/pull/32
@@ -266,11 +280,11 @@ Both are supported by vagrant-mutate as convert target
 
 ### 7. Architecture
 
-Vagrant-kvm control kvm/qemu via ruby-libvirt, libvirt and qemu.
+Vagrant-kvm controls kvm/qemu via ruby-libvirt, libvirt and qemu.
 
-Vagrant-libvirt control machines via fog,
+Vagrant-libvirt controls machines via fog,
 a cloud abstraction library in ruby,
 that is also used by vagrant-aws.
-A fog library control virtual machines on supported platforms and provide
+The fog library controls virtual machines on supported platforms and provides
 control of qemu/kvm machines through ruby-libvirt and libvirt.
 

data/bin/package.sh

@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+
+error() {
+    local msg="${1}"
+    echo "${msg}"
+    exit 1
+}
+
+usage() {
+    echo "Usage: ${0} NAME IMAGE"
+    echo
+    echo "Package a kvm qcow2 image into a kvm vagrant reusable box"
+    echo "It uses virt-install to do so"
+}
+
+if [ -z "$2" ]; then
+    usage
+    exit 1
+fi
+
+# defaults for virtual server
+NAME="$1"
+RAM=2048
+VCPUS=2
+
+IMG=$(readlink -e $2)
+IMG_BASENAME=$(basename $IMG)
+IMG_DIR=$(dirname $IMG)
+
+# Create stuff in tmp dir
+TMP_DIR=$IMG_DIR/_tmp_package
+mkdir -p $TMP_DIR
+
+# We move the image to the tempdir
+# ensure that it's moved back again
+# and the tmp dir removed
+trap "mv $TMP_DIR/$IMG_BASENAME $IMG_DIR; rm -rf $TMP_DIR" EXIT
+
+mv $IMG $TMP_DIR
+IMG=$TMP_DIR/$IMG_BASENAME
+
+cd $TMP_DIR
+
+# generate box.xml
+
+virt-install \
+    --print-xml \
+    --dry-run \
+    --import \
+    --name $NAME \
+    --ram $RAM --vcpus=$VCPUS \
+    --disk path="$IMG",bus=virtio,format=qcow2 \
+    -w network=default,model=virtio > box.xml
+
+# extract the mac for the Vagrantfile
+MAC=$(cat box.xml | grep 'mac address' | cut -d\' -f2 | tr -d :)
+IMG_ABS_PATH=$(cat box.xml | grep 'source file' | cut -d\' -f2)
+
+# replace the absolute image path
+sed -i "s#$IMG_ABS_PATH#$IMG_BASENAME#" box.xml
+
+# Hmm. When not starting the vm (--print-xml) the memory attribute in
+# the XML is missing the unit, which causes an exception in vagrant-kvm
+
+# add the memory unit
+sed -i "s/<memory>/<memory unit='KiB'>/" box.xml
+
+cat > metadata.json <<EOF
+{
+    "provider": "kvm"
+}
+EOF
+
+cat > Vagrantfile <<EOF
+Vagrant.configure("2") do |config|
+  config.vm.base_mac = "$MAC"
+end
+EOF
+
+tar cvzf $NAME.box --totals ./metadata.json ./Vagrantfile ./box.xml ./$IMG_BASENAME
+mv $NAME.box $IMG_DIR
+
+echo "$IMG_DIR/$NAME.box created"

data/install.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require "#{File.dirname(__FILE__)}/lib/vagrant-kvm/version"
+
+version = VagrantPlugins::ProviderKvm::VERSION
+p version
+system('gem build vagrant-kvm.gemspec')
+system("vagrant plugin install vagrant-kvm-%s.gem"%version)

data/lib/vagrant-kvm/action.rb

@@ -13,28 +13,21 @@ module VagrantPlugins
       # a bootup (i.e. not saved).
       def self.action_boot
         Vagrant::Action::Builder.new.tap do |b|
-          b.use Network
           b.use Provision
           b.use Vagrant::Action::Builtin::HandleForwardedPortCollisions
-          if Vagrant::VERSION < "1.4.0"
-            b.use PruneNFSExports
-            b.use NFS
-            b.use PrepareNFSSettings
-          else
-            #FIXME
-            b.use PrepareNFSValidIds
-            b.use SyncedFolderCleanup
-            b.use SyncedFolders
-            b.use PrepareNFSSettings
-          end
+          b.use PrepareNFSValidIds
+          b.use SyncedFolderCleanup
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
           b.use SetHostname
-          #b.use Customize
+          b.use Customize, "pre-boot"
           b.use ForwardPorts
           b.use Boot
           if Vagrant::VERSION >= "1.3.0"
             b.use WaitForCommunicator, [:running]
           end
           b.use ShareFolders
+          b.use Customize, "post-boot"
         end
       end
 
@@ -54,13 +47,11 @@ module VagrantPlugins
                 b3.use ConfigValidate
                 b3.use EnvSet, :force_halt => true
                 b3.use action_halt
-                if Vagrant::VERSION < "1.4.0"
-                  b3.use PruneNFSExports
-                else
-                  b3.use PrepareNFSSettings
-                  b3.use PrepareNFSValidIds
-                  b3.use SyncedFolderCleanup
-                end
+                b3.use PrepareNFSSettings
+                b3.use PrepareNFSValidIds
+                b3.use SyncedFolderCleanup
+                b3.use PrepareNFSSettings
+                b3.use InitStoragePool
                 b3.use Destroy
               else
                 b3.use MessageWillNotDestroy
@@ -108,13 +99,10 @@ module VagrantPlugins
 
             b2.use SetupPackageFiles
             b2.use action_halt
-            if Vagrant::VERSION < "1.4.0"
-              b2.use PruneNFSExports
-            else
-              b2.use PrepareNFSSettings
-              b2.use PrepareNFSValidIds
-              b2.use SyncedFolderCleanup
-            end
+            b2.use PrepareNFSSettings
+            b2.use PrepareNFSValidIds
+            b2.use SyncedFolderCleanup
+            b2.use PrepareNFSSettings
             b2.use Export
             b2.use PackageVagrantfile
             b2.use Package
@@ -226,7 +214,7 @@ module VagrantPlugins
 
                 # The VM is not saved, so we must have to boot it up
                 # like normal. Boot!
-                b4.use PrepareGui
+                b4.use PrepareKvmConfig
                 b4.use action_boot
               end
             end
@@ -254,7 +242,6 @@ 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|
@@ -266,8 +253,13 @@ module VagrantPlugins
                 b2.use HandleBox
               end
               b2.use SetName
+              b2.use Customize, "pre-import"
+              # we need to init storage again after driver is reloaded
+              # XXX there must be a better way
+              b2.use InitStoragePool
               b2.use Import
               b2.use MatchMACAddress
+              b2.use Network
             end
           end
           b.use action_start
@@ -282,6 +274,7 @@ module VagrantPlugins
       autoload :CheckKvm, action_root.join("check_kvm")
       autoload :CheckRunning, action_root.join("check_running")
       autoload :ClearForwardedPorts, action_root.join("clear_forwarded_ports")
+      autoload :Customize, action_root.join("customize")
       autoload :Created, action_root.join("created")
       autoload :Destroy, action_root.join("destroy")
       autoload :DestroyConfirm, action_root.join("destroy_confirm")
@@ -300,10 +293,9 @@ module VagrantPlugins
       autoload :Network, action_root.join("network")
       autoload :PackageVagrantfile, action_root.join("package_vagrantfile")
       autoload :Package, action_root.join("package")
-      autoload :PrepareGui, action_root.join("prepare_gui")
+      autoload :PrepareKvmConfig, action_root.join("prepare_kvmconfig")
       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 :ResetImagePermission, action_root.join("reset_image_permission")
       autoload :Resume, action_root.join("resume")
       autoload :ResumeNetwork, action_root.join("resume_network")