knife-vsphere 0.1.4 → 0.1.5

data/lib/chef/knife/{VsphereBaseCommand.rb → BaseVsphereCommand.rb}

@@ -2,24 +2,14 @@
 # Author:: Ezra Pagel (<ezra@cpan.org>)
 # License:: Apache License, Version 2.0
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 require 'chef/knife'
 require 'rbvmomi'
 
+# Base class for vsphere knife commands
 class Chef
   class Knife
-    class VsphereBaseCommand < Knife
+    class BaseVsphereCommand < Knife
 
       deps do
         require 'chef/knife/bootstrap'
@@ -34,11 +24,6 @@ class Chef
 
       def self.get_common_options
 
-      option :host,
-      :short => "-H HOST",
-      :long => "--host HOST",
-      :description => "The host to create the VM on"
-      
       option :vsphere_user,
       :short => "-u USERNAME",
       :long => "--user USERNAME",
@@ -115,6 +100,10 @@ class Chef
           find { |o| o.name == name }
       end
 
+      def fatal_exit(msg)
+        ui.fatal(msg)
+        exit 1
+      end
      
 
     end

data/lib/chef/knife/vsphere_customization_list.rb

@@ -1,42 +1,29 @@
-#r# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# License:: Apache License, Version 2.0
 #
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 require 'chef/knife'
-require 'chef/knife/VsphereBaseCommand'
+require 'chef/knife/BaseVsphereCommand'
 
-class Chef
-  class Knife
-    class VsphereCustomizationList < VsphereBaseCommand
+# Lists all customization specifications in the configured datacenter
+class Chef::Knife::VsphereCustomizationList < Chef::Knife::BaseVsphereCommand
 
-      banner "knife vsphere customization list"
+  banner "knife vsphere customization list"
 
-      get_common_options
-      
-      def run
+  get_common_options
+  
+  def run
 
-        $stdout.sync = true
-        
-        vim = get_vim_connection
+    $stdout.sync = true
+    
+    vim = get_vim_connection
 
-        csm = vim.serviceContent.customizationSpecManager
-        csm.info.each do |c|
-          puts "#{ui.color("Customization Name", :cyan)}: #{c.name}"
-          
-        end
-
-      end
+    csm = vim.serviceContent.customizationSpecManager
+    csm.info.each do |c|
+      puts "#{ui.color("Customization Name", :cyan)}: #{c.name}"
+      
     end
+
   end
 end
+

data/lib/chef/knife/vsphere_template_list.rb

@@ -2,48 +2,34 @@
 # Author:: Ezra Pagel (<ezra@cpan.org>)
 # License:: Apache License, Version 2.0
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 require 'chef/knife'
-require 'chef/knife/VsphereBaseCommand'
+require 'chef/knife/BaseVsphereCommand'
 
-class Chef
-  class Knife
-    class VsphereTemplateList < VsphereBaseCommand
+# Lists all known VM templates in the configured datacenter
+class Chef::Knife::VsphereTemplateList < Chef::Knife::BaseVsphereCommand
 
-      banner "knife vsphere template list"
+  banner "knife vsphere template list"
 
-      get_common_options
-      
+  get_common_options
+  
+  def run
 
-      def run
+    $stdout.sync = true
+    $stderr.sync = true
 
-        $stdout.sync = true
-        
-        vim = get_vim_connection
+    vim = get_vim_connection
 
-        dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-        dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-                       
-        vmFolders = get_folders(dc.vmFolder)
+    dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+    dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+    
+    vmFolders = get_folders(dc.vmFolder)
 
-        vms = find_all_in_folders(dc.vmFolder, RbVmomi::VIM::VirtualMachine).
-          select {|v| !v.config.nil? && v.config.template == true }
-      
-        vms.each do |vm|          
-          puts "#{ui.color("Template Name", :cyan)}: #{vm.name}"
-        end
-      end
+    vms = find_all_in_folders(dc.vmFolder, RbVmomi::VIM::VirtualMachine).
+      select {|v| !v.config.nil? && v.config.template == true }
+    
+    vms.each do |vm|          
+      puts "#{ui.color("Template Name", :cyan)}: #{vm.name}"
     end
   end
 end

data/lib/chef/knife/vsphere_vm_clone.rb

@@ -2,48 +2,48 @@
 # Author:: Ezra Pagel (<ezra@cpan.org>)
 # License:: Apache License, Version 2.0
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 require 'chef/knife'
-require 'chef/knife/VsphereBaseCommand'
+require 'chef/knife/BaseVsphereCommand'
 require 'rbvmomi'
 require 'netaddr'
 
-class Chef::Knife::VsphereVmClone < Chef::Knife::VsphereBaseCommand
+# Clone an existing template into a new VM, optionally applying a customization specification.
+# 
+# usage:
+# knife vsphere vm clone NewNode UbuntuTemplate --cspec StaticSpec \
+#     --cips 192.168.0.99/24,192.168.1.99/24 \
+#     --chostname NODENAME --cdomain NODEDOMAIN
+class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
 
-  banner "knife vsphere vm clone (options)"
+  banner "knife vsphere vm clone VMNAME TEMPLATE (options)"
 
   get_common_options
 
-  option :template,
-  :short => "-t TEMPLATE",
-  :long => "--template TEMPLATE",
-  :description => "The template to create the VM from"
-  
-  option :vmname,
-  :short => "-N VMNAME",
-  :long => "--vmname VMNAME",
-  :description => "The name for the new virtual machine"
-
   option :customization_spec,
-  :long => "--cspec CUSTOMIZATION_SPEC",
+  :long => "--cspec CUST_SPEC",
   :description => "The name of any customization specification to apply"
 
   option :customization_ips,
-  :long => "--cips CUSTOMIZATION_IPS",
-  :description => "A comma-delimited list of CIDR notation static IPs to be mapped in order for "+
-    "any applied customization specification that expects IP addresses"
+  :long => "--cips CUST_IPS",
+  :description => "Comma-delimited list of CIDR IPs for customization"
+
+  option :customization_hostname,
+  :long => "--chostname CUST_HOSTNAME",
+  :description => "Unqualified hostname for customization"
+ 
+  option :customization_domain,
+  :long => "--cdomain CUST_DOMAIN",
+  :description => "Domain name for customization"
 
+  option :customization_tz,
+  :long => "--ctz CUST_TIMEZONE",
+  :description => "Timezone invalid 'Area/Location' format"
+
+  option :power,  
+  :long => "--start STARTVM",
+  :description => "Indicates whether to start the VM after a successful clone",
+  :default => true
 
 
 
@@ -51,9 +51,18 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::VsphereBaseCommand
   
     $stdout.sync = true
 
-    template = config[:template] or abort "source template name required"
-    vmname = config[:vmname] or abort "destination vm name required"
-    
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit("You must specify a virtual machine name")
+    end
+
+    template = @name_args[1]
+    if template.nil?
+      show_usage
+      fatal_exit("You must specify a template name")
+    end
+
     vim = get_vim_connection
 
     dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
@@ -74,20 +83,54 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::VsphereBaseCommand
 
     if config[:customization_spec]
       csi = find_customization(vim, config[:customization_spec]) or
-        abort "failed to find customization specification named #{config[:customization_spec]}"
+        fatal_exit("failed to find customization specification named #{config[:customization_spec]}")
+
+      if csi.info.type != "Linux"
+        fatal_exit("Only Linux customization specifications are currently supported")
+      end
 
       if config[:customization_ips]
         csi.spec.nicSettingMap = config[:customization_ips].split(',').map { |i| generate_adapter_map(i) }
       end
 
+      use_ident = !config[:customization_hostname].nil? || !config[:customization_domain].nil?
+
+      if use_ident
+        # TODO - verify that we're deploying a linux spec, at least warn
+        ident = RbVmomi::VIM.CustomizationLinuxPrep
+
+        if config[:customization_hostname]
+          ident.hostName = RbVmomi::VIM.CustomizationFixedName
+          ident.hostName.name = config[:customization_hostname]
+        else
+          ident.hostName = RbVmomi::VIM.CustomizationFixedName
+          ident.hostName.name = config[:customization_domain]
+        end
+        
+        if config[:customization_domain]
+          ident.domain = config[:customization_domain]
+        end
+        
+        csi.spec.identity = ident
+      end
+
       clone_spec.customization = csi.spec
 
     end
 
     task = src_vm.CloneVM_Task(:folder => src_vm.parent, :name => vmname, :spec => clone_spec)
     puts "Cloning template #{template} to new VM #{vmname}"
-    task.wait_for_completion        
+    task.wait_for_completion
     puts "Finished creating virtual machine #{vmname}"
+    
+    if config[:power]
+      vm = find_in_folders(dc.vmFolder, RbVmomi::VIM::VirtualMachine, vmname) or
+      fatal_exit("VM #{vmname} not found")
+      vm.PowerOnVM_Task.wait_for_completion
+      puts "Powered on virtual machine #{vmname}"
+    end
+        
+    
   end
   
 
@@ -116,7 +159,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::VsphereBaseCommand
       settings.subnetMask = cidr_ip.netmask_ext
 
       # TODO - want to confirm gw/ip are in same subnet?
-      if [gw.nil?]
+      if gw.nil?
         settings.gateway = [cidr_ip.network(:Objectify => true).next_ip]
       else
         gw_cidr = NetAddr::CIDR.create(gw)
@@ -127,7 +170,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::VsphereBaseCommand
     adapter_map = RbVmomi::VIM.CustomizationAdapterMapping
     adapter_map.adapter = settings
     adapter_map
-    #end
+   
   end
   
 end

data/lib/chef/knife/vsphere_vm_delete.rb

@@ -2,55 +2,40 @@
 # Author:: Ezra Pagel (<ezra@cpan.org>)
 # License:: Apache License, Version 2.0
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 require 'chef/knife'
-require 'chef/knife/VsphereBaseCommand'
+require 'chef/knife/BaseVsphereCommand'
 require 'rbvmomi'
 
-class Chef
-  class Knife
-    class VsphereVmDelete < VsphereBaseCommand
-
+# Delete a virtual machine from vCenter
+class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
 
-      banner "knife vsphere vm delete (options)"
+  banner "knife vsphere vm delete VMNAME"
 
-      get_common_options
-      
-      option :vmname,
-      :short => "-N VMNAME",
-      :long => "--vmname VMNAME",
-      :description => "The name of the virtual machine to delete"
+  get_common_options
+  
+  def run
+    $stdout.sync = true
 
-      def run
+    vmname = @name_args[0]
 
-        $stdout.sync = true
-        
-        vmname = config[:vmname] or abort "virtual machine name required"
-
-        vim = get_vim_connection
+    if vmname.nil?
+      show_usage
+      fatal_exit("You must specify a virtual machine name")
+    end
+    
+    vim = get_vim_connection
 
-        dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-        dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+    dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+    dc = vim.serviceInstance.find_datacenter(dcname) or
+      fatal_exit("datacenter not found")
 
-        vm = find_in_folders(dc.vmFolder, RbVmomi::VIM::VirtualMachine, vmname) or
-          abort "VM #{vmname} not found"
+    vm = find_in_folders(dc.vmFolder, RbVmomi::VIM::VirtualMachine, vmname) or
+      fatal_exit("VM #{vmname} not found")
 
-        vm.PowerOffVM_Task.wait_for_completion unless vm.runtime.powerState == "poweredOff"
-        vm.Destroy_Task
-        puts "Deleted virtual machine #{vmname}"
+    vm.PowerOffVM_Task.wait_for_completion unless vm.runtime.powerState == "poweredOff"
+    vm.Destroy_Task
+    puts "Deleted virtual machine #{vmname}"
 
-      end
-    end
   end
 end

data/lib/chef/knife/vsphere_vm_list.rb

@@ -1,56 +1,42 @@
-#r# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# License:: Apache License, Version 2.0
 #
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 require 'chef/knife'
-require 'chef/knife/VsphereBaseCommand'
+require 'chef/knife/BaseVsphereCommand'
 
-class Chef
-  class Knife
-    class VsphereVmList < VsphereBaseCommand
+# Lists all known virtual machines in the configured datacenter
+class Chef::Knife::VsphereVmList < Chef::Knife::BaseVsphereCommand
 
-      banner "knife vsphere vm list"
+  banner "knife vsphere vm list"
 
-      get_common_options
-      
-      option :folder,
-      :short => "-f SHOWFOLDER",
-      :long => "--folder",
-      :description => "The folder to list VMs in"
+  get_common_options
+  
+  option :folder,
+  :short => "-f SHOWFOLDER",
+  :long => "--folder",
+  :description => "The folder to list VMs in"
 
-      def run
+  def run
 
-        $stdout.sync = true
-        
-        vim = get_vim_connection
+    $stdout.sync = true
+    
+    vim = get_vim_connection
 
 
-        dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-        dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-                       
-        baseFolder = dc.vmFolder;
+    dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+    dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+    
+    baseFolder = dc.vmFolder;
 
-        if config[:folder]
-          baseFolder = get_folders(dc.vmFolder).find { |f| f.name == config[:folder]} or
-            abort "no such folder #{config[:folder]}"
-        end
+    if config[:folder]
+      baseFolder = get_folders(dc.vmFolder).find { |f| f.name == config[:folder]} or
+        abort "no such folder #{config[:folder]}"
+    end
 
-        vms = find_all_in_folders(baseFolder, RbVmomi::VIM::VirtualMachine)      
-        vms.each do |vm|          
-          puts "#{ui.color("Template Name", :cyan)}: #{vm.name}"
-        end
-      end
+    vms = find_all_in_folders(baseFolder, RbVmomi::VIM::VirtualMachine)      
+    vms.each do |vm|          
+      puts "#{ui.color("VM Name", :cyan)}: #{vm.name}"
     end
   end
 end

data/lib/chef/knife/vsphere_vm_state.rb

@@ -2,20 +2,9 @@
 # Author:: Ezra Pagel (<ezra@cpan.org>)
 # License:: Apache License, Version 2.0
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 require 'chef/knife'
-require 'chef/knife/VsphereBaseCommand'
+require 'chef/knife/BaseVsphereCommand'
 require 'rbvmomi'
 require 'netaddr'
 
@@ -29,17 +18,13 @@ PowerStates = {
   PsSuspended => 'suspended'
 }
 
-class Chef::Knife::VsphereVmState < Chef::Knife::VsphereBaseCommand
+# Manage power state of a virtual machine
+class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
 
-  banner "knife vsphere vm state (options)"
+  banner "knife vsphere vm state VMNAME (options)"
 
   get_common_options
 
-  option :vmname,
-  :short => "-N VMNAME",
-  :long => "--vmname VMNAME",
-  :description => "The name for the new virtual machine"
-
   option :state,
   :short => "-s STATE",
   :long => "--state STATE",
@@ -49,7 +34,12 @@ class Chef::Knife::VsphereVmState < Chef::Knife::VsphereBaseCommand
   
     $stdout.sync = true
 
-    vmname = config[:vmname] or abort "destination vm name required"
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      ui.fatal("You must specify a virtual machine name")
+      exit 1
+    end
    
     vim = get_vim_connection
 

data/lib/knife-vsphere/version.rb

@@ -1,4 +1,4 @@
 module KnifeVsphere
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: knife-vsphere
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Ezra Pagel
@@ -15,13 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 -05:00
+date: 2011-07-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: chef
+  name: netaddr
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: chef
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,11 +49,11 @@ dependencies:
         - 0
         version: 0.10.0
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rbvmomi
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,7 +65,7 @@ dependencies:
         - 3
         version: 1.2.3
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 description: VMware vSphere Support for Chef's Knife Command
 email: ezra@cpan.org
 executables: []
@@ -59,13 +75,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/chef/knife/BaseVsphereCommand.rb
 - lib/chef/knife/vsphere_customization_list.rb
 - lib/chef/knife/vsphere_template_list.rb
 - lib/chef/knife/vsphere_vm_clone.rb
 - lib/chef/knife/vsphere_vm_delete.rb
 - lib/chef/knife/vsphere_vm_list.rb
 - lib/chef/knife/vsphere_vm_state.rb
-- lib/chef/knife/VsphereBaseCommand.rb
 - lib/knife-vsphere/version.rb
 has_rdoc: true
 homepage: