chef-provisioning-vsphere 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9429c5a2889eb0b8c3a74c2aa968e6134d6933df
-  data.tar.gz: e48b0fe64f042425825347c5408fbf33bcdd7fea
+  metadata.gz: 056663797fc34f01df8e90f6f8a09215b52cbd02
+  data.tar.gz: 846498ec8eaa5846614f7fd8feab39707ccfaccc
 SHA512:
-  metadata.gz: 7daa42c1d264122430a212d5b2433f8ebc2e67b2e043853af254d8f9d3d6489d14d3ecb9d5b0303ce99bb6c260c2d29168e9ebd06661f7ec474f9e5b992d576b
-  data.tar.gz: bfffe594fc7914b88753a64f2bf527d6877fbe2e7ea92c100c91368c05523f80c5f69e8013a7a20b7e85920cb7549c678229ead358dab5185b8255b2a79cef77
+  metadata.gz: e7accde606905aa4bcf0273ee976f0f3c421a6479e9af6adf4558d26bac99ccdc87d759110b206aba7a8b1873e91d520d608c2e956a9fc740514fbcba0890939
+  data.tar.gz: 88fd45b249a43a81d4397aab278954c83418c829121d262424601bbc6d158d98170ec975866e24974c272e140032d91ee057ecc44043f0e4e2fd88ea27fd27d3

data/README.md

@@ -3,77 +3,208 @@ chef-provisioning-vsphere
 
 This is a [chef-provisioning](https://github.com/opscode/chef-provisioning) provisioner for [VMware vSphere](http://www.vmware.com/products/vsphere).
 
-Currently, chef-provisioning-vsphere supports provisioning Unix/ssh and Windows/winrm guest VMs.
+chef-provisioning-vsphere supports provisioning Unix/ssh and Windows/winrm guest VMs.
 
-Try It Out
-----------
+## Prerequisites
 
-### vSphere VM Template
+### Vsphere infrastructure
 
-Create or obtain a VM template.  The VM template must:
+A vcenter and valid login credentials.
 
-  - be capable of installing Chef 11.8 or newer
-  - run vmware-tools on system boot (provides visiblity to ip address of the running VM)
-  - provide access via ssh or winrm
-  - provide a user account with NOPASSWD sudo/administrator
+### VM Teplate
 
-### Example recipe
+A VM template capable of installing Chef 11.8 or newer. This can be either windows or linux flavored.
+
+### A provisioning node (can be local)
+
+An environment equipped with the chef client and the chef-Provision-vsphere gem.
+
+## A basic provisioning recipe
+
+This is a minimal machine devinition that will use a dhcp assigned ip (it assumes the presense of a dhcp server). For test purposes this uses a linked clone for a faster provisioning time. This recipe should be used with a linux template. Windows provisioned servers need to point to a chef server for the cookbooks since winrm does not support port forwarding and there fore cannot reach back on the chef-zero port to get the local cookbooks. See examples below.
+
+```
+chef_gem 'chef-provisioning-vsphere' do
+  action :install
+  compile_time true
+end
+
+require 'chef/provisioning/vsphere_driver'
+
+with_vsphere_driver host: 'vcenter-host-name',
+  insecure: true,
+  user:     'you_user_name',
+  password: 'your_mothers_maiden_name'
+
+with_machine_options :bootstrap_options => {
+  use_linked_clone: true,
+  num_cpus: 2,
+  memory_mb: 4096,
+  network_name: ["vlan_20_172.21.20"],
+  datacenter: 'datacenter_name',
+  resource_pool: 'cluster',
+  template_name: 'path to template',
+  customization_spec: {
+    ipsettings: {
+      dnsServerList: ['1.2.3.31','1.2.3.41']
+    },
+    :domain => 'local'
+  }
+  :ssh => {
+    :user => 'root',
+    :password => 'password',
+    :paranoid => false,
+  }
+}
+
+machine "my_machine_name" do
+  run_list ['my_cookbook::default']
+end
 
 ```
-    chef_gem 'chef-provisioning-vsphere' do
-      action :install
-      compile_time true
-    end
-
-    require 'chef/provisioning/vsphere_driver'
-
-    with_vsphere_driver host: 'vcenter-host-name',
-      insecure: true,
-      user:     'you_user_name',
-      password: 'your_mothers_maiden_name'
-
-    machine_options = {
-      :bootstrap_options => {
-        :num_cpus =>        2,
-        :additional_disk_size_gb => 50,
-        :memory_mb =>       4096,
-        :network_name =>    ["vlan_20_172.21.20"],
-        :datacenter         'datacenter_name',
-        :host:               'cluster/host',
-        :resource_pool:      'cluster/resource_pool_name',
-        :datastore:          'datastore_name',
-        :template_name:      'path to template_vm',           # may be a VM or a VM Template
-        :vm_folder          'folder_to_clone_vms_into',
-        :customization_spec => {
-          :ipsettings => {
-            :ip => '1.2.3.125',
-            :subnetMask => '255.255.255.0',
-            :gateway => ["1.2.3.1"],
-            :dnsServerList => ["1.2.3.31","1.2.3.41"]
-          },
-          :domain => 'local',
-          :domainAdmin => "administrator@local",
-          :domainAdminPassword => "Password",
-          :org_name => 'my_company',
-          :product_id => 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx',
-          :win_time_zone => 4
-        }
-        :ssh => {
-          :user => 'administrator',
-          :password => 'password',
-          :paranoid => false,
-          :port => 22
-        },
-        :convergence_options => {
-          :install_msi_url=>"https://opscode-omnibus-packages.s3.amazonaws.com/windows/2008r2/x86_64/chef-windows-11.16.4-1.windows.msi", 
-          :install_sh_url=>"/tmp/chef-install.sh -v 11.16.4"
-        }
-      }
-
-      machine "my_machine_name" do
-        machine_options machine_options
-        run_list ['my_cookbook::default']
-      end
 
+## Provision!
+
+```
+chef-client -z -o 'my_cookbook::provision'
 ```
 
+This will use chef-zero and needs no chef server (only works for ssh). Note that chef-zero does not support berkshelf style cookbook dependency resolution. So this works if the cookbook in the machine's runlist has no external dependencies. If it needs to reach out to supermarket or another berkshelf API server, perform a `berks vendor` to pull down the dependencies first.
+
+## Supported machine bootstrapping options
+
+- `[:use_linked_clone]` - (true/false) great for testing but not recommended for production.
+- `[:datacenter]` - Name of vsphere datacenter (*required*)
+- `[:template_name]` - path to vmware template (can be template or a shutown vm) (*required*)
+- `[:vm_folder]` - path to a folder where the machine will be created.
+- `[:datastore]` - name of datastore to use
+- `[:num_cpus]` -  number of cpus to allocate to machine
+- `[:network_name]` - array of network names to use. A NIC will be added for each
+- `[:memory_mb]` - number of megabytes to allocate for machine
+- `[:host]` - `{cluster}`/`{host}` to use during provisioning
+- `[:resource_pool]` - `{cluster}`/`{resource pool}` to use during provisioning
+- `[:additional_disk_size_gb]` - if provided an additional disk will be added with the specified number of gigabytes (*his requires a datastore to be specified*)
+- `[:ssh][:user]` user to use for ssh/winrm (defaults to root on linux/administrator on windows)
+- `[:ssh][:password]` - password to use for ssh/winrm
+- `[:ssh][:paranoid]` - specifies the strictness of the host key verification checking
+- `[:ssh][:port]` port to use for ssh/winrm (defaults to 22 for ssh or 5985 for winrm)
+- `[:convergence_options][:install_msi_url]` - url to chef client msi to use (defaults to latest) 
+- `[:convergence_options][:install_sh_url]` - the bach script to install chef client on linux (defaults to latest)
+- `[:customization_spec][:ipsettings][:ip]` static ip to assign to machine
+- `[:customization_spec][:ipsettings][:subnetMask]` - subnet to use
+- `[:customization_spec][:ipsettings][:gateway]` - gateway to use
+- `[:customization_spec][:ipsettings][:dnsServerList]` - array of DNS servers to use
+- `[:customization_spec][:domain]` - domain to use (if not 'local' on a windows machine it will attempt to domain join)
+- `[:customization_spec][:domainAdmin]` - domain admin account to use for domain join on windows (should be `{user name}`@`{domain}`)
+- `[:customization_spec][:domainAdminPassword]` - domain administrator password
+- `[:customization_spec][:org_name]` - org name used in sysprep on windows
+- `[:customization_spec][:product_id]` - windows product key
+- `[:customization_spec][:win_time_zone]` - numeric time zone for windows
+
+## More config examples
+
+### Static IP and an additional 50GB disk
+
+```
+with_machine_options :bootstrap_options => {
+  use_linked_clone: true,
+  num_cpus: 2,
+  memory_mb: 4096,
+  network_name: ["vlan_20_172.21.20"],
+  datacenter: 'datacenter_name',
+  resource_pool: 'cluster',
+  template_name: 'path to template',
+  datastore: "my_data_store",
+  additional_disk_size_gb: 50,
+  customization_spec: {
+    ipsettings: {
+      ip: '192.168.3.4',
+      subnetMask: '255.255.255.0',
+      gateway: ["192.168.3.1"],
+      dnsServerList: ['1.2.3.31','1.2.3.41']
+    },
+    :domain => 'local'
+  }
+  :ssh => {
+    :user => 'root',
+    :password => 'password',
+    :paranoid => false,
+  }
+}
+```
+
+### Domain joined windows machine
+
+Note: You must run chef-client against a server for a windows box. You cn do this locally since the provisioning recipe should not change the state of the provisioner. You will need to upload the cookbook (both the one doing the provisioning and the one used in the provisioned machine's runlist) before running `chef-client`.
+
+```
+with_machine_options :bootstrap_options => {
+  use_linked_clone: true,
+  num_cpus: 2,
+  memory_mb: 4096,
+  network_name: ["vlan_20_172.21.20"],
+  datacenter: 'datacenter_name',
+  resource_pool: 'cluster',
+  template_name: 'path to template',
+  customization_spec: {
+    ipsettings: {
+      dnsServerList: ['1.2.3.31','1.2.3.41']
+    },
+    domain => 'blah.com',
+    domainAdmin => "administrator@blah.com",
+    domainAdminPassword => "Passwordyoyoyo",
+    org_name => 'acme',
+    product_id => 'CDAA-87DC-3455-FF77-2AAC',
+    win_time_zone => 4
+  }
+  :ssh => {
+    :user => 'administrator',
+    :password => 'password',
+    :paranoid => false,
+  }
+}
+```
+
+## Kitchen Driver
+
+This chef-provisioning-driver comes with a test-kitchen driver. Here are example driver options you can add to your `kitchen.yml`.
+
+```
+driver_plugin: vsphere
+driver_config:
+  driver_options:
+    host: '1.2.3.5'
+    user: 'user'
+    password: 'pass'
+    insecure: true
+  machine_options:
+    start_timeout: 600
+    create_timeout: 600
+    ready_timeout: 90
+    bootstrap_options:
+      use_linked_clone: true
+      datacenter: 'DC'
+      template_name: 'UBUNTU1264'
+      vm_folder: 'TEST'
+      num_cpus: 2,
+      network_name:
+        - vlan_20_1.2.3.4
+      memory_mb: 4096
+      resource_pool: 'CLSTR/TEST'
+      ssh:
+        user: root
+        paranoid: false
+        password: password
+        port: 22
+      convergence_options:
+      customization_spec:
+        domain: local
+        ipsettings:
+          dnsServerList:
+            - 8.8.8.8
+            - 8.8.4.4
+```
+
+## Contributions are welcome!
+
+We took care to make this driver as generic as possible but there wll certainly be implementation nuances that may not work for everyone. We are happy to accept contributions to improve the driver and make it more accessible to a broader set of use cases.

data/Rakefile

@@ -1,8 +1,13 @@
 require 'bundler/gem_tasks'
+require 'chef/provisioning/vsphere_driver/version'
 require 'rspec/core/rake_task'
+require "rubocop/rake_task"
 
 $:.unshift(File.dirname(__FILE__) + '/lib')
-require 'chef/provisioning/vsphere_driver/version'
+
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end
 
 RSpec::Core::RakeTask.new(:unit) do |task|
   task.pattern = 'spec/unit_tests/*_spec.rb'

data/chef-provisioning-vsphere.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop', '~> 0.29'
 end

data/lib/chef/provisioning/vsphere_driver/driver.rb

@@ -167,7 +167,6 @@ module ChefProvisioningVsphere
         bootstrap_options[:vm_folder],
         machine_spec.name
       )
-      server_id = nil
       if vm
         Chef::Log.info machine_msg(
           machine_spec.name,
@@ -485,14 +484,9 @@ module ChefProvisioningVsphere
     end
 
     def clone_vm(action_handler, bootstrap_options, machine_name)
-      vm = find_vm(bootstrap_options[:vm_folder], machine_name)
-      return vm if vm
-
-      vm_template = vm_template_for(bootstrap_options)
-
       do_vm_clone(
         action_handler,
-        vm_template,
+        vm_template_for(bootstrap_options),
         machine_name,
         bootstrap_options
       )

data/lib/chef/provisioning/vsphere_driver/version.rb

@@ -1,3 +1,3 @@
 module ChefProvisioningVsphere
-  VERSION = '0.5.3'
+  VERSION = '0.5.4'
 end

data/lib/chef/provisioning/vsphere_driver/vsphere_helpers.rb

@@ -26,10 +26,9 @@ module ChefProvisioningVsphere
       @current_connection
     end
 
-    def find_vm(vm_folder, vm_name)
-      folder = find_folder(vm_folder) ||
-        raise("vSphere Folder not found [#{vm_folder}] for vm #{vm_name}")
-      vm     = folder.find(vm_name, RbVmomi::VIM::VirtualMachine)
+    def find_vm(folder, vm_name)
+      folder = find_folder(folder) unless folder.is_a? RbVmomi::VIM::Folder
+      folder.find(vm_name, RbVmomi::VIM::VirtualMachine)
     end
 
     def find_vm_by_id(uuid, connection = vim)
@@ -99,12 +98,10 @@ module ChefProvisioningVsphere
     #folder could be like:  /Level1/Level2/folder_name
     def find_folder(folder_name)
       base = datacenter.vmFolder
-      if folder_name && folder_name.length > 0
-        entityArray = folder_name.split('/').reject(&:empty?)
-        entityArray.each do |item|
-          base = base.childEntity.grep(RbVmomi::VIM::Folder).find do |f|
-            f.name == item
-          end
+      unless folder_name.nil?
+        folder_name.split('/').reject(&:empty?).each do |item|
+          base = base.find(item, RbVmomi::VIM::Folder) ||
+            raise("vSphere Folder not found [#{folder_name}]")
         end
       end
       base
@@ -168,13 +165,14 @@ module ChefProvisioningVsphere
         clone_spec.config.deviceChange = changes
       end
 
+      vm_folder = find_folder(options[:vm_folder])
       vm_template.CloneVM_Task(
         name: vm_name,
-        folder: find_folder(options[:vm_folder]),
+        folder: vm_folder,
         spec: clone_spec
       ).wait_for_completion
 
-      vm = find_vm(options[:vm_folder], vm_name)
+      vm = find_vm(vm_folder, vm_name)
 
       if options[:additional_disk_size_gb].to_i > 0
         task = vm.ReconfigVM_Task(:spec => RbVmomi::VIM.VirtualMachineConfigSpec(:deviceChange => [virtual_disk_for(vm, options)]))

data/spec/integration_tests/vsphere_driver_spec.rb

@@ -33,7 +33,7 @@ require 'chef/provisioning/machine_spec'
   #   }
   # }
 
-describe "vsphere_driver" do
+describe 'vsphere_driver' do
   include ChefProvisioningVsphere::Helpers
 
   before :all do
@@ -54,93 +54,97 @@ describe "vsphere_driver" do
     end
   end
 
-
   context 'when allocating a machine' do
 
-    it "adds machine to the correct folder" do
+    it 'adds machine to the correct folder' do
       expect(@vm.parent.name).to eq(@metal_config[:machine_options][:bootstrap_options][:vm_folder])
     end
-    it "has a matching id with the machine_spec" do
+    it 'has a matching id with the machine_spec' do
       expect(@vm.config.instanceUuid).to eq(@machine_spec.location['server_id'])
     end
-    it "has the correct name" do
+    it 'has the correct name' do
           now = Time.now.utc
           trimmed_name = @vm.config.guestId.start_with?('win') ? @vm_name.byteslice(0,15) : @vm_name
           expected_name="#{trimmed_name}.#{@metal_config[:machine_options][:bootstrap_options][:customization_spec][:domain]}"
           until (Time.now.utc - now) > 30 || (@vm.guest.hostName == expected_name) do
-            print "."
+            print '.'
             sleep 5
           end
       expect(@vm.guest.hostName).to eq(expected_name)
     end
-    it "has the correct number of CPUs" do
+    it 'has the correct number of CPUs' do
       expect(@vm.config.hardware.numCPU).to eq(@metal_config[:machine_options][:bootstrap_options][:num_cpus])
     end
-    it "has the correct amount of memory" do
+    it 'has the correct amount of memory' do
       expect(@vm.config.hardware.memoryMB).to eq(@metal_config[:machine_options][:bootstrap_options][:memory_mb])
     end
-    it "is on the correct networks" do
+    it 'is on the correct networks' do
       expect(@vm.network.map {|n| n.name}).to include(@metal_config[:machine_options][:bootstrap_options][:network_name][0])
       expect(@vm.network.map {|n| n.name}).to include(@metal_config[:machine_options][:bootstrap_options][:network_name][1])
     end
-    it "is on the correct datastore" do
+    it 'is on the correct datastore' do
       expect(@vm.datastore[0].name).to eq(@metal_config[:machine_options][:bootstrap_options][:datastore])
     end
-    it "is in the correct resource pool" do
+    it 'is in the correct resource pool' do
       if @metal_config[:machine_options][:bootstrap_options].has_key?(:resource_pool)
         expect(@vm.resourcePool.name).to eq(@metal_config[:machine_options][:bootstrap_options][:resource_pool].split('/')[1])
       end
     end
-    it "is in the correct host" do
+    it 'is in the correct host' do
       if @metal_config[:machine_options][:bootstrap_options].has_key?(:host)
         expect(@vm.runtime.host.name).to eq(@metal_config[:machine_options][:bootstrap_options][:host].split('/')[1])
       end
     end
-    it "is in the correct cluster" do
+    it 'is in the correct cluster' do
       if @metal_config[:machine_options][:bootstrap_options].has_key?(:resource_pool)
         expect(@vm.resourcePool.owner.name).to eq(@metal_config[:machine_options][:bootstrap_options][:resource_pool].split('/')[0])
       end
     end
-    it "is in the correct datacenter" do
+    it 'is in the correct datacenter' do
       expect(@connection.serviceInstance.find_datacenter(@metal_config[:machine_options][:bootstrap_options][:datacenter]).find_vm("#{@vm.parent.name}/#{@vm_name}")).not_to eq(nil)
     end
-    it "has an added disk of the correct size" do
+    it 'has an added disk of the correct size' do
       disk_count = @vm.disks.count
       expect(@vm.disks[disk_count-1].capacityInKB).to eq(@metal_config[:machine_options][:bootstrap_options][:additional_disk_size_gb] * 1024 * 1024)
     end
-    it "has hot add cpu enabled" do
+    it 'has hot add cpu enabled' do
       expect(@vm.config.cpuHotAddEnabled).to eq(true)
     end
-    it "has hot remove cpu enabled" do
+    it 'has hot remove cpu enabled' do
       expect(@vm.config.cpuHotRemoveEnabled).to eq(true)
     end
-    it "has hot add memory enabled" do
+    it 'has hot add memory enabled' do
       expect(@vm.config.memoryHotAddEnabled).to eq(true)
     end   
-    it "has the correct IP address" do
+    it 'has the correct IP address' do
       now = Time.now.utc
-      until (Time.now.utc - now) > 30 || (@vm.guest.toolsRunningStatus == "guestToolsRunning" && @vm.guest.net.count == 2 && @vm.guest.net[1].ipAddress[1] == @metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip]) do
-        print "."
+      until (Time.now.utc - now) > 30 || (@vm.guest.toolsRunningStatus == 'guestToolsRunning' && @vm.guest.net.count == 2 && @vm.guest.net[1].ipAddress[1] == @metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip]) do
+        print '.'
         sleep 5
       end
       expect(@vm.guest.net.map { |net| net.ipAddress}.flatten).to include(@metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip])
     end
   end
 
-  context "destroy_machine" do
+  context 'destroy_machine' do
 
-    it "removes the machine" do
+    it 'removes the machine' do
       Cheffish.honor_local_mode do
         chef_server = Cheffish.default_chef_server
         url = URI::VsphereUrl.from_config(@metal_config[:driver_options]).to_s
         driver = Chef::Provisioning.driver_for_url(url, @metal_config)
         action_handler = Chef::Provisioning::ActionHandler.new
-        machine_spec = Chef::Provisioning.chef_managed_entry_store(chef_server).new_entry(:machine, @vm_name)
-        machine_spec.location = { 
+        machine_spec = Chef::Provisioning.chef_managed_entry_store(chef_server)
+          .new_entry(:machine, @vm_name)
+        machine_spec.location = {
           'driver_url' => driver.driver_url,
           'server_id' => @server_id
         }
-        driver.destroy_machine(action_handler, machine_spec, @metal_config[:machine_options])
+        driver.destroy_machine(
+          action_handler,
+          machine_spec,
+          @metal_config[:machine_options]
+        )
       end
       vm = find_vm_by_id(@server_id, @connection)
       expect(vm).to eq(nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-provisioning-vsphere
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - CenturyLink Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbvmomi
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
 description: Provisioner for creating vSphere VM instances in Chef Provisioning.
 email: matt.wrock@CenturyLinkCloud.com
 executables: []