knife-esx 0.1.5 → 0.2

data/CHANGELOG.md

@@ -1,4 +1,63 @@
-# Sat Feb 25 12:16:01 CET 2012 - 0.1.5 
+# 0.2 - 2012/02/28
+
+* Added --batch and --async options 
+
+Inspired by spiceweasel from Matt Ray (https://github.com/mattray/spiceweasel), I've added a batch mode where a YAML file describes the VMs you want to bootstrap.
+    
+    knife esx vm create --batch batch.yml 
+
+Sample batch.yml file:
+
+    ---
+    :test1:
+      'extra-args': --no-host-key-verify
+      'vm-memory': 128
+      'esx-host': esx-server-1 
+      'esx-password': secret 
+      'ssh-user': ubuntu
+      'ssh-password': ubuntu
+      'vm-disk': /home/rubiojr/mnt/mirror/virtual_appliances/ubuntu1110-x64-vmware-tools.vmdk
+      'datastore': datastore2
+    :test2:
+      'extra-args': --no-host-key-verify 
+      'vm-memory': 128
+      'esx-host': esx-server-1 
+      'esx-password': secret
+      'ssh-user': ubuntu
+      'ssh-password': ubuntu
+      'vm-disk': /home/rubiojr/mnt/mirror/virtual_appliances/ubuntu1110-x64-vmware-tools.vmdk
+      'datastore': datastore2
+    :test3:
+      'extra-args': --no-host-key-verify 
+      'vm-memory': 256
+      'esx-host': esx-server-1 
+      'esx-password': secret
+      'ssh-user': ubuntu
+      'ssh-password': ubuntu
+      'vm-disk': /home/rubiojr/mnt/mirror/virtual_appliances/ubuntu1110-x64-vmware-tools.vmdk
+      'datastore': datastore2
+
+This will try to create three VMs (testvm1, testvm2 and testvm3) sequentially. VM definitions inside the batch file accept all the parameters that can be used with knife-esx.
+
+If you want to bootstrap the VMs asynchronously, use the --async flag.
+
+    knife esx vm create --batch batch.yml --async
+
+Standard output and error log is redirected to /tmp/knife_esx_vm_create_VMNAME.log, so if we use the deploy script from above, three log files will be created:
+
+    /tmp/knife_esx_vm_create_test1.log
+    /tmp/knife_esx_vm_create_test2.log
+    /tmp/knife_esx_vm_create_test3.log
+
+* Added --skip-bootstrap flag. If the flag is used the VM will be created but 
+  the bootstrap template/script won't be executed (it also means that Chef won't be installed).
+
+* Fixed bug preventing knife-esx to create a VM when the hypervisor has an empty root password.
+
+KNOWN ISSUES
+* To use --batch without --skip-bootstrap, the ssh user (--ssh-user) needs to be able to sudo without asking for a password (i.e. adding something like 'ubuntu ALL=(ALL) NOPASSWD: ALL' to /etc/sudoers in the appliance template) otherwise the bootstraping process won't work if more than one VM is being deployed. 
+
+# 0.1.5 - 2012/02/25
 
 * Patch from @pperezrubio adding multiple networks support
 
@@ -8,7 +67,27 @@
                         --ssh-password ubuntu \
                         --vm-network "VLAN-Integration,VLAN-Test"
 
-
 This will create a VM with two NICs, attaching them to the VLAN-Integration and VLAN-Test networks respectively.
 
+Fixed MAC addresses can also be assigned to each NIC using the --mac-address parameter:
+    
+    knife esx vm create --vm-disk ubuntu-oneiric.vmdk \
+                        --vm-name testvm --datastore datastore1 \
+                        --esx-host 192.168.88.1 --ssh-user ubuntu \
+                        --ssh-password ubuntu \
+                        --vm-network "VLAN-Integration,VLAN-Test" \
+                        --mac-address "00:01:02:03:04:05,00:01:02:03:04:06"
+
+MAC address 00:01:02:03:04:05 will be assigned to VLAN-Integration NIC and 00:01:02:03:04:06 to the VLAN-Test NIC.
+
+If a MAC address is omitted it will be dynamically generated:
+    
+knife esx vm create --vm-disk ubuntu-oneiric.vmdk \
+                        --vm-name testvm --datastore datastore1 \
+                        --esx-host 192.168.88.1 --ssh-user ubuntu \
+                        --ssh-password ubuntu \
+                        --vm-network "VLAN-Integration,VLAN-Test" \
+                        --mac-address ",00:01:02:03:04:06"
+
+Note that I did not specify the first MAC address, so VLAN-Integration NIC will get a random MAC.
 

data/knife-esx.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.add_dependency "esx", ">= 0.3.2"
   s.add_dependency "terminal-table"
   s.add_dependency "chef", ">= 0.10"
+  s.add_dependency "celluloid", ">= 0.9"
+  s.add_dependency "open4"
   s.require_paths = ["lib"]
 
 end

data/lib/chef/knife/esx_base.rb

@@ -61,7 +61,7 @@ class Chef
           ui.info "#{ui.color("Connecting to ESX host #{config[:esx_host]}... ", :magenta)}"
           @connection = ESX::Host.connect(Chef::Config[:knife][:esx_host],
                                           Chef::Config[:knife][:esx_username],
-                                          Chef::Config[:knife][:esx_password])
+                                          Chef::Config[:knife][:esx_password] || '')
         else
           @connection
         end

data/lib/chef/knife/esx_vm_create.rb

@@ -17,9 +17,121 @@
 #
 
 require 'chef/knife/esx_base'
+require 'open4'
+require 'celluloid'
+require 'singleton'
+
+module KnifeESX
+  class DeployScript
+
+    attr_reader :job_count
+
+    # Sample job
+    #---
+    #:test1:
+    #  'vm-memory':
+    #  'extra-args': 
+    #  'esx-host':
+    #  'template-file': 
+    #  'vm-disk': 
+    #  'ssh-user':
+    #  'ssh-password': 
+    #  'run-list': 
+    #  'network-interface': 
+    def initialize(batch_file)
+      @batch_file = batch_file
+      @jobs = []
+      @job_count = 0 
+      (YAML.load_file batch_file).each do |i|
+        @jobs << DeployJob.new(i)
+        @job_count += 1
+      end
+    end
+
+    def each_job(&block)
+      @jobs.each do |j|
+        yield j
+      end
+    end
+
+  end
+
+  class CLogger
+    include Celluloid
+    include Singleton
+
+    def info(msg)
+      puts "INFO: #{msg}"
+    end
+
+    def error(msg)
+      $stderr.puts "ERROR: #{msg}"
+    end
+  end
+
+  class DeployJob
+
+    include Celluloid
+
+    attr_reader :name
+
+    def initialize(options)
+      @name, @options = options
+      validate
+    end
+
+    def validate
+      if @name.nil? or @name.empty?
+        raise Exception.new("Invalid job name")
+      end
+      if not @options['vm-disk'] or !File.exist?(@options['vm-disk'])
+        raise Exception.new("Invalid VM disk for job #{@name}.")
+      end
+    end
+
+    # returns [status, stdout, stderr]
+    def run
+      args = ""
+      extra_args = ""
+      @options.each do |k, v|
+        if k == 'extra-args'
+          extra_args << v
+        else
+          args << "--#{k} #{v} " unless k == 'extra-args'
+        end
+      end
+
+      @out = ""
+      @err = ""
+      optstring = []
+      @options.each do |k,v|
+        optstring << "   - #{k}:".ljust(25) +  "#{v}\n" unless k =~ /password/
+      end
+      log_file = "/tmp/knife_esx_vm_create_#{@name.to_s.strip.chomp.gsub(/\s/,'_')}.log"
+      CLogger.instance.info! "Bootstrapping VM #{@name} \n#{optstring.join}"
+      CLogger.instance.info! "VM #{@name} bootstrap log: #{log_file}"
+      @status = Open4.popen4("knife esx vm create --vm-name #{@name} #{args} #{extra_args} > #{log_file} 2>&1") do |pid, stdin, stdout, stderr|
+        @out << stdout.read.strip
+        @err << stderr.read.strip
+      end
+      if @status == 0
+        CLogger.instance.info! "[#{@name}] deployment finished OK"
+      else
+        CLogger.instance.error! "[#{@name}] deployment FAILED"
+        @err.each_line do |l|
+          CLogger.instance.error! "[#{@name}] #{l.chomp}"
+        end
+      end
+      return @status, @out, @err 
+    end
+
+  end
+
+end
 
 class Chef
   class Knife
+
     class EsxVmCreate < Knife
 
       include Knife::ESXBase
@@ -125,7 +237,26 @@ class Chef
         :long => "--mac-address",
         :description => "Mac address list",
         :default => nil
-
+      
+      option :skip_bootstrap,
+        :long => "--skip-bootstrap",
+        :description => "Skip bootstrap process (Deploy only mode)",
+        :boolean => true,
+        :default => false,
+        :proc => Proc.new { true }
+      
+      option :async,
+        :long => "--async",
+        :description => "Deploy the VMs asynchronously (Ignored unless combined with --batch)",
+        :boolean => true,
+        :default => false,
+        :proc => Proc.new { true }
+      
+      option :batch,
+        :long => "--batch script.yml",
+        :description => "Use a batch file to deploy multiple VMs",
+        :default => nil
+      
       def tcp_test_ssh(hostname)
         tcp_socket = TCPSocket.new(hostname, 22)
         readable = IO.select([tcp_socket], nil, nil, 5)
@@ -147,6 +278,38 @@ class Chef
 
       def run
         $stdout.sync = true
+        
+        if config[:batch]
+          CLogger.instance.info "Running in batch mode. Extra arguments will be ignored."
+          if not config[:async]
+            counter = 0
+            script = KnifeESX::DeployScript.new(config[:batch])
+            script.each_job do |job|
+              counter += 1
+              status, stdout, stderr = job.run
+              if status == 0 
+                CLogger.instance.info 'Ok'
+              else
+                CLogger.instance.error 'Failed'
+                stderr.each_line do |l|
+                  ui.error l
+                end
+              end
+            end
+          else
+            CLogger.instance.info! "Asynchronous boostrapping selected"
+            CLogger.instance.info! "Now do something productive while I finish my job ;)"
+            script = KnifeESX::DeployScript.new(config[:batch])
+            futures = []
+            script.each_job do |job|
+              futures << job.future(:run)
+            end
+            futures.each do |f|
+              f.value
+            end
+          end
+          return
+        end
 
         unless config[:vm_disk]
           ui.error("You have not provided a valid VMDK file. (--vm-disk)")
@@ -172,7 +335,7 @@ class Chef
         destination_path = "/vmfs/volumes/#{datastore}/#{vm_name}"
 
         connection.remote_command "mkdir #{destination_path}"
-        puts "#{ui.color("Creating VM... ", :magenta)}"
+        puts "#{ui.color("Creating VM #{vm_name}... ", :magenta)}"
         puts "#{ui.color("Importing VM disk... ", :magenta)}"
 
         connection.import_disk vm_disk, destination_path + "/#{vm_name}.vmdk"
@@ -186,6 +349,8 @@ class Chef
         
         puts "#{ui.color("VM Name", :cyan)}: #{vm.name}"
         puts "#{ui.color("VM Memory", :cyan)}: #{(vm.memory_size.to_f/1024/1024).round} MB"
+        
+        return if config[:skip_bootstrap]
 
         # wait for it to be ready to do stuff
         print "\n#{ui.color("Waiting server... ", :magenta)}"
@@ -220,6 +385,7 @@ class Chef
       def bootstrap_for_node(vm)
         bootstrap = Chef::Knife::Bootstrap.new
         bootstrap.name_args = [vm.ip_address]
+        bootstrap.config[:async] = config[:async]
         bootstrap.config[:run_list] = config[:run_list]
         bootstrap.config[:ssh_user] = config[:ssh_user] 
         bootstrap.config[:identity_file] = config[:identity_file]

data/lib/knife-esx/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module ESX 
-    VERSION = "0.1.5"
+    VERSION = "0.2"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-esx
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000 Z
+date: 2012-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: esx
-  requirement: &14262920 !ruby/object:Gem::Requirement
+  requirement: &12088940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *14262920
+  version_requirements: *12088940
 - !ruby/object:Gem::Dependency
   name: terminal-table
-  requirement: &14262220 !ruby/object:Gem::Requirement
+  requirement: &12088520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14262220
+  version_requirements: *12088520
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &14261380 !ruby/object:Gem::Requirement
+  requirement: &12087940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,29 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *14261380
+  version_requirements: *12087940
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: &12087280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12087280
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: &12086840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12086840
 description: ESX Support for Chef's Knife Command
 email:
 - rubiojr@frameos.org