vagrant-xenserver 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eaf14c14f04943700ffc16f39647823e4175daa
-  data.tar.gz: 86c9c38a1350cd2b26fb186b2fc2acfc15bed137
+  metadata.gz: f0cec68cbb7af733bd030330a8220b43d73c06b4
+  data.tar.gz: 6d87fb9aa7926950fbaa93df55d395bcfd190032
 SHA512:
-  metadata.gz: f8085d05f42304cabccfa37f54c1f33d0d3a130edd30aadbc1c4953ac8bc7269dfc5ad441fa23813dc8d4209542edbbc57b7d63cca2786c594d204e969278c8f
-  data.tar.gz: 06cacc5f7ac068995cc760f42a63913477074a37d3db2568dd345e7492f8ced2a1703a399ed0e212fffbe966e1dfd417126cf354bc7fbfec8bbf94c82717af1e
+  metadata.gz: f993a2dd8ff4737cf27bc81f3e255af09e3f7f4723c2640ff741a254dc2df846c730e69a65a159b1705bbd1d0fdb9fb818e401f63c3da6e2a23751411258d7ae
+  data.tar.gz: 2ec61fc6f4638f0a77e9051d7744c95e3e43147f5ee7db75c2b90dbda821dfcf0c32e9a1fea6f0749e4ace92f85747e4e185a3295aaeaa44699e15b06849b44d

data/README.md

@@ -4,32 +4,63 @@ This is a Vagrant plugin that adds a XenServer provider, allowing Vagrant to
 control and provision machines on a XenServer host.
 
 ## Dependencies
-* Vagrant >= 1.5(?) (http://www.vagrantup.com/downloads.html)
+* Vagrant >= 1.5 (http://www.vagrantup.com/downloads.html)
+* qemu-img
 
 ## Installation
 ```shell
 vagrant plugin install vagrant-xenserver
 ```
 
-## XenServer host setup
-N.B. Currently this will only work on a trunk build of XenServer:
+# XenServer setup
+
+Make sure the default_SR is set, and that a VHD-based SR is in
+use. Currently the NFS SR is the recommended storage type.
+
+# Usage
+
+## Boxes
+
+Vagrant-xenserver supports 3 types of boxes today. These are:
+
+1. XVA URL - the box simply contains a URL that points to an XVA
+   (XenServer export) file.
+2. XVA - the box contains an XVA (XenServer export).
+3. VHD - the box contains a VHD file.
+
+The recommended format is either 1 or 2, and it is suggested that
+Packer is used to create the XVA files, which is available from
+https://github.com/xenserver/packer-builder-xenserver . If this is not
+available, there is an example script in the `example_box` directory
+that automatically installs a Debian Wheezy guest and exports it. Once
+an XVA file has been built, this can be turned into a box by archiving
+it with `tar` with an included `metadata.json` and optionally a
+`Vagrantfile`. For example, assuming an XVA has been created called
+`ubuntu-15.10-amd64.xva`, to create an XVA URL box, upload the XVA to
+your webserver and execute the following:
+
 ```shell
-# Install netcat
-yum install --enablerepo=base,extras --disablerepo=citrix -y nc
-# Setup NAT - NB, this _disable the firewall_ - be careful!
-echo 1 > /proc/sys/net/ipv4/ip_forward
-/sbin/iptables -F
-
-/sbin/iptables -t nat -A POSTROUTING -o xenbr0 -j MASQUERADE
-/sbin/iptables -A INPUT -i xenbr0 -p tcp -m tcp --dport 53 -j ACCEPT
-/sbin/iptables -A INPUT -i xenbr0 -p udp -m udp --dport 53 -j ACCEPT
-/sbin/iptables -A FORWARD -i xenbr0 -o xenapi -m state --state RELATED,ESTABLISHED -j ACCEPT
-/sbin/iptables -A FORWARD -i xenapi -o xenbr0 -j ACCEPT
+echo "{\"provider\": \"xenserver\"}" > metadata.json
+cat > Vagrantfile <<EOF
+Vagrant.configure(2) do |config|
+  config.vm.provider :xenserver do |xs|
+    xs.xva_url = "http://my.web.server/ubuntu-15.10-amd64.xva"
+  end
+end
+EOF
+tar cf ubuntu.box metadata.json Vagrantfile
 ```
 
-# Usage
+Or to create an XVA box:
+
+```shell
+echo "{\"provider\": \"xenserver\"}" > metadata.json
+cp /path/to/ubuntu-15.10-amd64.xva box.xva
+tar cf ubuntu.box metadata.json Vagrantfile
+```
 
-## Converting a VirtualBox box file
+VHD based boxes are useful if you are converting from a box from
+another provider. For example, to convert a VirtualBox box file:
 
 * Download the box file (e.g. https://vagrantcloud.com/ubuntu/trusty64/version/1/provider/virtualbox.box)
 * Unpack it:
@@ -52,9 +83,18 @@ echo "{\"provider\": \"xenserver\"}" > metadata.json
 ```
 * Create the box:
 ```shell
-tar cf ../xenserver.box .
+tar cf ../ubuntu.box .
 ```
-* Add the box:
+
+Note that since v0.0.12, vagrant-xenserver will assume by default that
+boxes have the XenServer tools installed, which may not be the case
+for converted boxes.
+
+## Add the box
+
+Once you've created your box, this can simply be added to vagrant with
+the following:
+
 ```shell
 vagrant box add ubuntu xenserver.box
 ```
@@ -72,18 +112,56 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   config.vm.box = "ubuntu"
 
   config.vm.provider :xenserver do |xs|
-  xs.xs_host = "st29.uk.xensource.com"
-  xs.xs_username = "root"
-  xs.xs_password = "xenroot"
-  xs.pv = true
-  xs.memory = 2048
+    xs.xs_host = "st29.uk.xensource.com"
+    xs.xs_username = "root"
+    xs.xs_password = "xenroot"
+    xs.pv = true
+    xs.memory = 2048
+    xs.use_himn = false
   end
-end
 
+  config.vm.network "public_network", bridge: "xenbr0"
+end
 ```
 
-and then you can do
+Note that by default there will be no connection to the external
+network, so most configurations will require a 'public_network'
+defined as in the above Vagrantfile.  To bring the VM up, it should
+then be as simple as
 
 ```shell
 vagrant up --provider=xenserver
 ```
+
+## XenServer host setup for HIMN forwarding
+
+Since v0.0.12, boxes are assumed to have XenServer tools installed to
+report the IP address. If the tools are not installed in the box, the
+plugin supports using the 'host internal management network' (HIMN),
+which is an internal-only network on which a DHCP server runs. Use of
+this requires additional setup of dom0:
+
+N.B. Currently this will only work on XenServer 6.5 and later:
+```shell
+# Install netcat (XenServer 7.0 onwards)
+yum install --enablerepo=base,extras -y nc
+# Install netcat (XenServer 6.5)
+yum install --enablerepo=base,extras --disablerepo=citrix -y nc
+```
+
+You will also need to copy your ssh key to the Xenserver host:
+
+    ssh-copy-id root@xenserver
+
+# Changes since 0.0.11
+Note that since v0.0.11 the use of the host internal management network is now
+not default. For backwards compatibility, add `use_himn = true` to the provider
+specific settings in the Vagrantfile. For example:
+
+```ruby
+  config.vm.provider :xenserver do |xs|
+    xs.use_himn = true
+  end
+```
+
+

data/example_box/install_wheezy.sh

@@ -0,0 +1,128 @@
+#!/bin/bash
+
+set -e
+set -x
+
+SERVER=$1 
+USERNAME=$2
+PASSWORD=$3
+VMNAME=wheezy
+DOMAINNAME=local
+
+SERVERIP=`dig +search +short $SERVER`
+
+if [ "x$SERVERIP" == "x" ]; then
+	SERVERIP=$SERVER
+fi
+
+template=`ssh root@$SERVER "xe template-list name-label='Debian Wheezy 7.0 (64-bit)' --minimal"`
+vm=`ssh root@$SERVER xe vm-install template=$template new-name-label=$VMNAME`
+network=`ssh root@$SERVER xe network-list bridge=xenbr0 --minimal`
+vif=`ssh root@$SERVER xe vif-create vm-uuid=$vm network-uuid=$network device=0`
+ssh root@$SERVER xe vm-cd-add uuid=$vm cd-name=guest-tools.iso device=3 || ssh root@$SERVER xe vm-cd-add uuid=$vm cd-name=xs-tools.iso device=3
+
+preseed_blob=`ssh root@$SERVER xe blob-create vm-uuid=$vm name=preseed public=true`
+preseed_file=/tmp/preseed
+
+postinstall_blob=`ssh root@$SERVER xe blob-create vm-uuid=$vm name=postinstall public=true`
+postinstall_file=/tmp/postinstall
+
+cat > $preseed_file <<EOF
+d-i	debian-installer/locale	 	string en_GB
+d-i	keyboard-configuration/layoutcode string en_GB
+d-i	keyboard-configuration/xkb-keymap string en_GB
+d-i	mirror/country			string manual
+d-i	mirror/http/hostname		string ftp.uk.debian.org
+d-i	mirror/http/directory		string /debian/
+d-i	mirror/http/proxy		string 
+#d-i	debian-installer/allow_unauthenticated	string true
+#d-i	anna/no_kernel_modules		boolean true
+d-i	time/zone string		string Europe/London
+d-i	partman-auto/method		string regular
+d-i	partman-auto/choose_recipe \
+		select All files in one partition (recommended for new users)
+d-i	partman/confirm_write_new_label	boolean true
+d-i	partman/choose_partition \
+		select Finish partitioning and write changes to disk
+d-i	partman/confirm			boolean true
+d-i	partman/confirm_nooverwrite	boolean true
+
+d-i	passwd/make-user		boolean true
+
+d-i passwd/user-fullname string vagrant
+d-i passwd/user-password password vagrant
+d-i passwd/user-password-again password vagrant
+d-i passwd/username string vagrant
+
+d-i passwd/root-password-again password vagrant
+d-i passwd/root-password password vagrant
+
+d-i apt-setup/local0/repository string http://www.uk.xensource.com/deb-guest lenny main
+d-i debian-installer/allow_unauthenticated boolean true
+
+popularity-contest	popularity-contest/participate	boolean	false
+tasksel	tasksel/first			multiselect standard
+d-i pkgsel/include string openssh-server vim ntp ethtool tpcdump bridge-util rsync ssmtp strace gdb build-essential xe-guest-utilities wget sudo
+#d-i	mirror/udeb/suite		string squeeze
+#d-i	mirror/suite			string squeeze
+#d-i	mirror/udeb/suite		string sid
+#d-i	mirror/suite			string sid
+d-i	grub-installer/only_debian	boolean true
+d-i grub-installer/with_other_os boolean true
+d-i preseed/late_command string \
+wget http://$SERVERIP/blob?uuid=$postinstall_blob -O /target/post_install.sh;\
+chmod 755 /target/post_install.sh; \
+chroot /target /post_install.sh
+
+d-i	finish-install/reboot_in_progress	note
+#d-i	debian-installer/exit/poweroff	boolean true
+#d-i	debian-installer/exit/always_halt boolean true
+#d-i debian-installer/exit/poweroff boolean true
+
+EOF
+
+cat > $postinstall_file <<EOF
+#!/bin/bash
+
+mount /dev/xvdd /mnt
+cd /mnt/Linux
+./install.sh -n
+
+mkdir ~vagrant/.ssh
+wget --no-check-certificate \
+    'https://raw.githubusercontent.com/mitchellh/vagrant/master/keys/vagrant.pub' \
+    -O ~vagrant/.ssh/authorized_keys
+chown -R vagrant ~vagrant/.ssh
+chmod -R go-rwsx ~vagrant/.ssh
+
+echo 'vagrant ALL=(ALL) NOPASSWD:ALL' > /etc/sudoers.d/99_vagrant
+chmod 440 /etc/sudoers.d/99_vagrant
+
+EOF
+
+scp $preseed_file root@$SERVER:$preseed_file
+scp $postinstall_file root@$SERVER:$postinstall_file
+
+ssh root@$SERVER xe blob-put uuid=$preseed_blob filename=$preseed_file
+rm $preseed_file
+ssh root@$SERVER rm $preseed_file
+
+ssh root@$SERVER xe blob-put uuid=$postinstall_blob filename=$postinstall_file
+rm $postinstall_file
+ssh root@$SERVER rm $postinstall_file
+
+ssh root@$SERVER xe vm-param-set uuid=$vm other-config:install-repository=http://ftp.uk.debian.org/debian other-config:debian-release=wheezy
+ssh root@$SERVER "xe vm-param-set uuid=$vm PV-args=\"auto-install/enable=true url=http://$SERVERIP/blob?uuid=$preseed_blob interface=auto netcfg/dhcp_timeout=600 hostname=$VMNAME domain=$DOMAINNAME\""
+ssh root@$SERVER xe vm-start uuid=$vm
+
+sleep 30
+
+starttime=`ssh root@$SERVER xe vm-param-get uuid=$vm param-name=start-time`
+ssh root@$SERVER xe event-wait class=vm uuid=$vm start-time=/=$starttime
+echo "rebooted..."
+ssh root@$SERVER xe event-wait class=vm uuid=$vm networks=/=
+echo "networks detected"
+ssh root@$SERVER xe vm-shutdown uuid=$vm
+echo $vm
+
+

data/example_box/mkbox.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+server=$1
+username=$2
+password=$3
+
+vm=`./install_wheezy.sh $1 $2 $3 | tail -n 1`
+rm -rf tmp
+mkdir tmp
+curl -k https://$username:$password@$server/export\?uuid=$vm\&use_compression=true -o tmp/box.xva
+echo "{\"provider\": \"xenserver\"}" > tmp/metadata.json
+pushd tmp
+tar cf ../wheezy.box .
+popd
+
+
+

data/lib/vagrant-xenserver/action.rb

@@ -13,7 +13,11 @@ module VagrantPlugins
           b.use PrepareNFSValidIds
           b.use SyncedFolderCleanup
           b.use SyncedFolders
-          b.use StartVM
+          b.use Call, IsRunning do |env, b2|
+            if !env[:result]
+              b2.use StartVM
+            end
+          end
           b.use WaitForCommunicator, ["Running"]
           b.use PrepareNFSSettings         
         end
@@ -28,8 +32,11 @@ module VagrantPlugins
             # Create the VM
             if !env[:result]
               b2.use UploadVHD
-              b2.use CloneDisk
-              b2.use CreateVM
+              b2.use UploadXVA
+              b2.use DownloadXVA
+              b2.use CreateTemplate
+              b2.use CloneVM
+              b2.use SetVMParams
               b2.use CreateVIFs
             end
             b2.use action_boot
@@ -216,7 +223,9 @@ module VagrantPlugins
       autoload :UploadXVA, action_root.join('upload_xva')
       autoload :UploadVHD, action_root.join('upload_vhd')
       autoload :CloneDisk, action_root.join('clone_disk')
-      autoload :CreateVM, action_root.join('create_vm')
+      autoload :SetVMParams, action_root.join('set_vm_params')
+      autoload :CloneVM, action_root.join('clone_vm')
+      autoload :CreateTemplate, action_root.join('create_template')
       autoload :DestroyVM, action_root.join('destroy_vm')
       autoload :StartVM, action_root.join('start_vm')
       autoload :HaltVM, action_root.join('halt_vm')
@@ -225,6 +234,7 @@ module VagrantPlugins
       autoload :ReadSSHInfo, action_root.join('read_ssh_info')
       autoload :PrepareNFSSettings, action_root.join('prepare_nfs_settings')
       autoload :PrepareNFSValidIds, action_root.join('prepare_nfs_valid_ids')
+      autoload :DownloadXVA, action_root.join('download_xva')
     end
   end
 end

data/lib/vagrant-xenserver/action/clone_disk.rb

@@ -16,7 +16,7 @@ module VagrantPlugins
         def call(env)
           vdi_ref = env[:box_vdi]
 
-          clone = env[:xc].call("VDI.clone", env[:session], vdi_ref, {})['Value']
+          clone = env[:xc].VDI.clone(vdi_ref, {})
 
           env[:my_vdi] = clone
 

data/lib/vagrant-xenserver/action/clone_vm.rb

@@ -0,0 +1,35 @@
+require "log4r"
+require "xmlrpc/client"
+
+module VagrantPlugins
+  module XenServer
+    module Action
+      class CloneVM
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::xenserver::actions::clone_vm")
+        end
+
+        def call(env)
+          template_ref = env[:template]
+          box_name = env[:machine].box.name.to_s
+          box_version = env[:machine].box.version.to_s
+          username = Etc.getlogin
+          
+          if env[:machine].provider_config.name.nil?
+            vm_name = "#{username}/#{box_name}/#{box_version}"
+          else
+            vm_name = env[:machine].provider_config.name
+          end
+          
+          vm = env[:xc].VM.clone(template_ref, vm_name)
+          env[:xc].VM.provision(vm)
+
+          env[:machine].id = vm
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-xenserver/action/connect_xs.rb

@@ -1,5 +1,6 @@
 require "log4r"
-require "xmlrpc/client"
+require "xenapi"
+require "uri"
 
 module VagrantPlugins
   module XenServer
@@ -7,22 +8,29 @@ module VagrantPlugins
       class ConnectXS
         def initialize(app, env)
           @app = app
-          @logger = Log4r::Logger.new("vagrant_xenserver::actions::connect_xs")
+          @logger = Log4r::Logger.new("vagrant::xenserver::actions::connect_xs")
         end
 
         def call(env)
-          if not env[:session]
-            env[:xc] = XMLRPC::Client.new(env[:machine].provider_config.xs_host, "/", "80")
-            
+          if not env[:xc]
+            config = env[:machine].provider_config
+            uri = URI::Generic.new(config.xs_use_ssl ? 'https' : 'http',
+                                nil,
+                                config.xs_host,
+                                config.xs_port,
+                                nil,
+                                "/",
+                                nil,
+                                nil, nil)
+            env[:xc] = XenApi::Client.new(uri.to_s, timeout = config.api_timeout)
+
             @logger.info("Connecting to XenServer")
-            
-            sess_result = env[:xc].call("session.login_with_password", env[:machine].provider_config.xs_username, env[:machine].provider_config.xs_password,"1.0")
-            
-            if sess_result["Status"] != "Success"
+
+            if not env[:xc].login_with_password(config.xs_username, config.xs_password)
               raise Errors::LoginError
             end
-            
-            env[:session] = sess_result["Value"]
+
+            @logger.info("Connected to XenServer")
           end
 
           @app.call(env)