vm_shepherd 3.5.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a056d918fa69521babd0636b90a36bbc4e75a9bc
-  data.tar.gz: 23ec4f0d83d118542fc213139604efaaa5b52fd2
+SHA256:
+  metadata.gz: f0c4eae538ba72ae93a1bc16e07b93153be92fb3730b0c1ee995c75aaa7bbec6
+  data.tar.gz: c46d2af2473fb238bfb1bec5e85f8ec13d19f9a0e32f5d7c88db23bd0ad3ac25
 SHA512:
-  metadata.gz: ce2cf10d6f705dd3633ec9d3c537c97131568ca6d91f5692a3c887d2f42fb44ffbd28ed854814f0d953a842f4424fcad651410c0b0b436a7b8af26dba7ab3a0d
-  data.tar.gz: be9a971752b45af0359c8bd41825ef85f545ba97a1f69b29119a96816e4821de46ee7e43aeca36705127d99551860c932da318aa5b6c89df0a81fb33b9e586f3
+  metadata.gz: c24318537ae944dc68ccd6c214baa05c1906ba78011ae2391a4a1e8b115c5fddc20813f1556a0634a95436dfcf6b73679570bccb35386ac77936e576cc76628e
+  data.tar.gz: 8db0afde7bfa78be5acaf6d0736cd0a4d0fb75cce46054777873125a5ead9f6c4a479834bbeb69ab765cba7ca4bc9189708ec9b4ae6119148e231189bc04dcbc

data/.rubocop.yml

@@ -3,4 +3,4 @@ AllCops:
     - Gemfile
     - Rakefile
     - vm_shepherd.gemspec
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.6

data/.ruby-version

@@ -1 +1 @@
-2.2.4
+2.6.3

data/lib/vm_shepherd/aws_manager.rb

@@ -167,7 +167,7 @@ module VmShepherd
           key_name: vm_config.fetch('key_name'),
           security_group_ids: [env_config.fetch('outputs').fetch('security_group')],
           subnet: env_config.fetch('outputs').fetch('public_subnet_id'),
-          instance_type: OPS_MANAGER_INSTANCE_TYPE
+          instance_type: vm_config.dig('instance_type') || OPS_MANAGER_INSTANCE_TYPE
         }
 
       if (instance_profile = env_config.fetch('outputs').fetch('instance_profile', nil))

data/lib/vm_shepherd/shepherd.rb

@@ -38,7 +38,7 @@ module VmShepherd
               path,
               vcloud_deploy_options(vm_shepherd_config),
             )
-          when VmShepherd::VSPHERE_IAAS_TYPE then
+        when VmShepherd::VSPHERE_IAAS_TYPE then
             VmShepherd::VsphereManager.new(
               vm_shepherd_config.dig('vcenter_creds', 'ip'),
               vm_shepherd_config.dig('vcenter_creds', 'username'),
@@ -164,6 +164,8 @@ module VmShepherd
               datacenter_folders_to_clean: vm_shepherd_config.dig('cleanup', 'datacenter_folders_to_clean'),
               datastores: vm_shepherd_config.dig('cleanup', 'datastores'),
               datastore_folders_to_clean: vm_shepherd_config.dig('cleanup', 'datastore_folders_to_clean'),
+              cluster_name: vm_shepherd_config.dig('vsphere', 'cluster'),
+              resource_pool_name: vm_shepherd_config.dig('vsphere', 'resource_pool'),
             )
           end
         when VmShepherd::AWS_IAAS_TYPE then
@@ -182,20 +184,31 @@ module VmShepherd
     end
 
     def vsphere_vm_options(input_config)
-      {
+      vsphere_vm_options = {
         ip: input_config.dig('vm', 'ip'),
         gateway: input_config.dig('vm', 'gateway'),
         netmask: input_config.dig('vm', 'netmask'),
         dns: input_config.dig('vm', 'dns'),
         ntp_servers: input_config.dig('vm', 'ntp_servers'),
         cpus: input_config.dig('vm', 'cpus'),
-        ram_mb: input_config.dig('vm', 'ram_mb'),
-        vm_password: (input_config.dig('vm', 'vm_password') || 'tempest'),
-        public_ssh_key: read_assets_home(input_config.dig('vm', 'public_ssh_key')),
+        ram_mb: input_config.dig('vm', 'ram_mb')
       }.tap do |result|
         hostname = input_config.dig('vm', 'custom_hostname')
         result[:custom_hostname] = hostname unless hostname.nil?
       end
+
+      vsphere_vm_options.merge!(vm_password: get_vsphere_vm_password(input_config))
+      vsphere_vm_options.merge!(public_ssh_key: get_vsphere_vm_public_ssh_key(input_config))
+
+      vsphere_vm_options
+    end
+
+    def get_vsphere_vm_password(input_config)
+      ENV['PROVISION_WITH_PASSWORD'] == 'false' ? nil : (input_config.dig('vm', 'vm_password') || ENV['VSPHERE_VM_PASSWORD'] || 'tempest')
+    end
+
+    def get_vsphere_vm_public_ssh_key(input_config)
+      ENV['PROVISION_WITH_SSH_KEY'] == 'false' ? nil : (read_assets_home(input_config.dig('vm', 'public_ssh_key')))
     end
 
     def read_assets_home(path_or_value)

data/lib/vm_shepherd/version.rb

@@ -1,3 +1,3 @@
 module VmShepherd
-  VERSION = '3.5.0'.freeze
+  VERSION = '3.7.1'.freeze
 end

data/lib/vm_shepherd/vsphere_manager.rb

@@ -27,12 +27,12 @@ module VmShepherd
       FileUtils.remove_entry_secure(ovf_file_path, force: true) unless ovf_file_path.nil?
     end
 
-    def clean_environment(datacenter_folders_to_clean:, datastores:, datastore_folders_to_clean:)
+    def clean_environment(datacenter_folders_to_clean:, datastores:, datastore_folders_to_clean:, cluster_name: nil, resource_pool_name: nil)
       return if datacenter_folders_to_clean.nil? || datastores.nil? || datacenter_folders_to_clean.nil?
 
       datacenter_folders_to_clean.each do |folder_name|
         validate_folder_name!(folder_name)
-        delete_folder_and_vms(folder_name)
+        delete_folder_and_vms(folder_name, cluster_name, resource_pool_name)
       end
 
       datastore_folders_to_clean.each do |folder_name|
@@ -105,18 +105,23 @@ module VmShepherd
     end
 
     def create_network_mappings(ovf_file_path, vsphere_config)
-      ovf = Nokogiri::XML(File.read(ovf_file_path))
-      ovf.remove_namespaces!
+      ovf = parse_ovf(ovf_file_path)
       networks = ovf.xpath('//NetworkSection/Network').map { |x| x['name'] }
       Hash[networks.map { |ovf_network| [ovf_network, network(vsphere_config)] }]
     end
 
+    def parse_ovf(ovf_file_path)
+      ovf = Nokogiri::XML(File.read(ovf_file_path))
+      ovf.remove_namespaces!
+      ovf
+    end
+
     def boot_vm(ovf_file_path, vm_config, vsphere_config)
       ensure_folder_exists(vsphere_config[:folder])
       template = deploy_ovf_template(ovf_file_path, vsphere_config)
       vm       = create_vm_from_template(template, vm_config, vsphere_config)
 
-      reconfigure_vm(vm, vm_config)
+      reconfigure_vm(vm, vm_config, ovf_file_path)
       power_on_vm(vm)
     end
 
@@ -124,12 +129,13 @@ module VmShepherd
       datacenter.vmFolder.traverse(folder_name, RbVmomi::VIM::Folder, true)
     end
 
-    def delete_folder_and_vms(folder_name)
+    def delete_folder_and_vms(folder_name, cluster_name = nil, resource_pool_name = nil)
       3.times do |attempt|
         break unless (folder = datacenter.vmFolder.traverse(folder_name))
 
         find_vms(folder).each do |vm|
           power_off_vm(vm)
+          convert_template_to_vm(vm, cluster_name, resource_pool_name)
         end
 
         begin
@@ -155,6 +161,7 @@ module VmShepherd
 
     def power_off_vm(vm)
       2.times do
+        # This will implicitly skip over VM templates, which always are in the "poweredOff" state
         break if vm.runtime.powerState == 'poweredOff'
 
         begin
@@ -168,6 +175,14 @@ module VmShepherd
       end
     end
 
+    def convert_template_to_vm(vm, cluster_name, resource_pool_name)
+      return unless vm.config.template
+
+      cluster = datacenter.find_compute_resource(cluster_name)
+      pool = cluster.resourcePool.resourcePool.find { |rp| rp.name == resource_pool_name }
+      vm.MarkAsVirtualMachine(pool: pool)
+    end
+
     def deploy_ovf_template(ovf_file_path, vsphere_config)
       template_name = [TEMPLATE_PREFIX, Time.new.strftime('%F-%H-%M'), cluster(vsphere_config).name].join('-')
       logger.info("BEGIN deploy_ovf ovf_file=#{ovf_file_path} template_name=#{template_name}")
@@ -233,8 +248,8 @@ module VmShepherd
       }
     end
 
-    def reconfigure_vm(vm, vm_config)
-      virtual_machine_config_spec = create_virtual_machine_config_spec(vm_config)
+    def reconfigure_vm(vm, vm_config, ovf_file_path)
+      virtual_machine_config_spec = create_virtual_machine_config_spec(vm_config, ovf_file_path)
       logger.info("BEGIN reconfigure_vm_task virtual_machine_config_spec=#{virtual_machine_config_spec.inspect}")
       vm.ReconfigVM_Task(
         spec: virtual_machine_config_spec
@@ -243,12 +258,12 @@ module VmShepherd
       }
     end
 
-    def create_virtual_machine_config_spec(vm_config)
+    def create_virtual_machine_config_spec(vm_config, ovf_file_path)
       logger.info('BEGIN VmConfigSpec creation')
       vm_config_spec =
         RbVmomi::VIM::VmConfigSpec.new.tap do |vcs|
           vcs.ovfEnvironmentTransport = ['com.vmware.guestInfo']
-          vcs.property                = create_vapp_property_specs(vm_config)
+          vcs.property                = create_vapp_property_specs(vm_config, ovf_file_path)
         end
       logger.info("END  VmConfigSpec creation: #{vm_config_spec.inspect}")
 
@@ -259,57 +274,36 @@ module VmShepherd
       end
     end
 
-    def create_vapp_property_specs(vm_config)
-      ip_configuration = {
-        'ip0'         => vm_config[:ip],
-        'netmask0'    => vm_config[:netmask],
-        'gateway'     => vm_config[:gateway],
-        'DNS'         => vm_config[:dns],
+    def create_vapp_property_specs(vm_config, ovf_file_path)
+      property_value_map = {
+        'ip0' => vm_config[:ip],
+        'netmask0' => vm_config[:netmask],
+        'gateway' => vm_config[:gateway],
+        'DNS' => vm_config[:dns],
         'ntp_servers' => vm_config[:ntp_servers],
+        'admin_password' => vm_config[:vm_password],
+        'public_ssh_key' => vm_config[:public_ssh_key],
+        'custom_hostname' => vm_config[:custom_hostname],
       }
 
       vapp_property_specs = []
 
-      logger.info("BEGIN VAppPropertySpec creation configuration=#{ip_configuration.inspect}")
-      # IP Configuration key order must match OVF template property order
-      ip_configuration.each_with_index do |(key, value), i|
+      logger.info("BEGIN VAppPropertySpec creation configuration=#{property_value_map.inspect}")
+
+      # VAppPropertySpec order must match OVF template property order
+      ovf = parse_ovf(ovf_file_path)
+      ovf.xpath('//ProductSection/Property').each_with_index do |property, index|
+        label = property.attribute('key').value
         vapp_property_specs << RbVmomi::VIM::VAppPropertySpec.new.tap do |spec|
           spec.operation = 'edit'
           spec.info      = RbVmomi::VIM::VAppPropertyInfo.new.tap do |p|
-            p.key   = i
-            p.label = key
-            p.value = value
+            p.key   = index
+            p.label = label
+            p.value = property_value_map[label]
           end
         end
       end
 
-      vapp_property_specs << RbVmomi::VIM::VAppPropertySpec.new.tap do |spec|
-        spec.operation = 'edit'
-        spec.info      = RbVmomi::VIM::VAppPropertyInfo.new.tap do |p|
-          p.key   = 5 # this needs to be 5th to match the ovf template property order.
-          p.label = 'admin_password'
-          p.value = vm_config[:vm_password]
-        end
-      end
-
-      vapp_property_specs << RbVmomi::VIM::VAppPropertySpec.new.tap do |spec|
-        spec.operation = 'edit'
-        spec.info      = RbVmomi::VIM::VAppPropertyInfo.new.tap do |p|
-          p.key   = 6 # ditto. see above. it makes me sad, too.
-          p.label = 'public_ssh_key'
-          p.value = vm_config[:public_ssh_key]
-        end
-      end
-
-      vapp_property_specs << RbVmomi::VIM::VAppPropertySpec.new.tap do |spec|
-        spec.operation = 'edit'
-        spec.info      = RbVmomi::VIM::VAppPropertyInfo.new.tap do |p|
-          p.key   = 7 # ditto. see above. it makes me sad, too.
-          p.label = 'custom_hostname'
-          p.value = vm_config[:custom_hostname]
-        end
-      end unless vm_config[:custom_hostname].nil?
-
       logger.info("END   VAppPropertySpec creation vapp_property_specs=#{vapp_property_specs.inspect}")
       vapp_property_specs
     end

data/spec/fixtures/ova_manager/default.ovf

@@ -0,0 +1,136 @@
+<?xml version="1.0"?>
+<Envelope ovf:version="1.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xml:lang="en-US" xmlns="http://schemas.dmtf.org/ovf/envelope/1"
+          xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+          xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
+          xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
+          xmlns:vmw="http://www.vmware.com/schema/ovf">
+
+  <References>
+    <File ovf:href="pivotal-ops-manager-disk1.vmdk" ovf:size="4243996160" ovf:id="file1"/>
+  </References>
+
+  <DiskSection>
+    <Info>List of the virtual disks used in the package</Info>
+    <Disk ovf:capacity="171798603879"
+          ovf:diskId="vmdisk1"
+          ovf:fileRef="file1"
+          ovf:format="http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"/>
+  </DiskSection>
+
+  <NetworkSection>
+    <Info>Logical networks used in the package</Info>
+    <Network ovf:name="Network 1">
+      <Description>Logical network used by this appliance.</Description>
+    </Network>
+  </NetworkSection>
+
+  <vmw:IpAssignmentSection ovf:required="false" vmw:protocols="IPv4" vmw:schemes="">
+    <Info>Supported IP assignment schemes</Info>
+  </vmw:IpAssignmentSection>
+
+  <VirtualSystem ovf:id="FAKE_FILENAME">
+    <Info>A virtual machine</Info>
+
+    <ProductSection>
+      <Info/>
+      <Product>Ops Manager</Product>
+      <Vendor>Pivotal</Vendor>
+      <Version>2.3-build.203</Version>
+      <Property ovf:key="ip0" ovf:userConfigurable="true" ovf:type="string">
+        <Label>IP Address</Label>
+        <Description>The IP address for the Ops Manager. Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="netmask0" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Netmask</Label>
+        <Description>The netmask for the Ops Manager's network. Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="gateway" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Default Gateway</Label>
+        <Description>The default gateway address for the Ops Manager's network. Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="DNS" ovf:userConfigurable="true" ovf:type="string">
+        <Label>DNS</Label>
+        <Description>The domain name servers for the Ops Manager (comma separated). Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="ntp_servers" ovf:userConfigurable="true" ovf:type="string">
+        <Label>NTP Servers</Label>
+        <Description>Comma-delimited list of NTP servers</Description>
+      </Property>
+      <Property ovf:key="admin_password" ovf:userConfigurable="true" ovf:type="password">
+        <Label>Admin Password</Label>
+        <Description>This password is used to SSH into the Ops Manager. The username is 'ubuntu'. One or both of Admin Password and SSH Key is required.</Description>
+      </Property>
+      <Property ovf:key="public_ssh_key" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Public SSH Key</Label>
+        <Description>The Public SSH Key is used to allow SSHing into the Ops Manager with your private ssh key. The username is 'ubuntu'. One or both of Admin Password and SSH Key is required.</Description>
+      </Property>
+      <Property ovf:key="custom_hostname" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Custom Hostname</Label>
+        <Description>This will be set as the hostname on the VM. Default: 'pivotal-ops-manager'.</Description>
+      </Property>
+    </ProductSection>
+
+    <AnnotationSection>
+      <Info/>
+      <Annotation>Ops Manager for Pivotal Cloud Foundry
+        installs and manages PCF products and services.</Annotation>
+    </AnnotationSection>
+
+    <VirtualHardwareSection ovf:required="false" ovf:transport="com.vmware.guestInfo">
+      <Info>Virtual hardware requirements for a virtual machine</Info>
+      <System>
+        <vssd:ElementName>Virtual Hardware Family</vssd:ElementName>
+        <vssd:InstanceID>0</vssd:InstanceID>
+        <vssd:VirtualSystemIdentifier>FAKE_FILENAME</vssd:VirtualSystemIdentifier>
+        <vssd:VirtualSystemType>vmx-09</vssd:VirtualSystemType>
+      </System>
+      <Item>
+        <rasd:Caption>1 virtual CPU</rasd:Caption>
+        <rasd:Description>Number of virtual CPUs</rasd:Description>
+        <rasd:ElementName>1 virtual CPU</rasd:ElementName>
+        <rasd:InstanceID>1</rasd:InstanceID>
+        <rasd:ResourceType>3</rasd:ResourceType>
+        <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
+      </Item>
+      <Item>
+        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
+        <rasd:Caption>8192 MB of memory</rasd:Caption>
+        <rasd:Description>Memory Size</rasd:Description>
+        <rasd:ElementName>8192 MB of memory</rasd:ElementName>
+        <rasd:InstanceID>2</rasd:InstanceID>
+        <rasd:ResourceType>4</rasd:ResourceType>
+        <rasd:VirtualQuantity>8192</rasd:VirtualQuantity>
+      </Item>
+      <Item>
+        <rasd:Address>0</rasd:Address>
+        <rasd:Caption>scsiController0</rasd:Caption>
+        <rasd:Description>SCSI Controller</rasd:Description>
+        <rasd:ElementName>scsiController0</rasd:ElementName>
+        <rasd:InstanceID>3</rasd:InstanceID>
+        <rasd:ResourceSubType>lsilogic</rasd:ResourceSubType>
+        <rasd:ResourceType>6</rasd:ResourceType>
+      </Item>
+      <Item>
+        <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
+        <rasd:Caption>Ethernet adapter on 'Network 1'</rasd:Caption>
+        <rasd:Connection>Network 1</rasd:Connection>
+        <rasd:ElementName>Ethernet adapter on 'Network 1'</rasd:ElementName>
+        <rasd:InstanceID>4</rasd:InstanceID>
+        <rasd:ResourceSubType>E1000</rasd:ResourceSubType>
+        <rasd:ResourceType>10</rasd:ResourceType>
+      </Item>
+      <Item>
+        <rasd:AddressOnParent>0</rasd:AddressOnParent>
+        <rasd:Caption>disk1</rasd:Caption>
+        <rasd:Description>Disk Image</rasd:Description>
+        <rasd:ElementName>disk1</rasd:ElementName>
+        <rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
+        <rasd:InstanceID>5</rasd:InstanceID>
+        <rasd:Parent>3</rasd:Parent>
+        <rasd:ResourceType>17</rasd:ResourceType>
+      </Item>
+    </VirtualHardwareSection>
+  </VirtualSystem>
+</Envelope>

data/spec/fixtures/ova_manager/without_public_ssh_key.ovf

@@ -0,0 +1,132 @@
+<?xml version="1.0"?>
+<Envelope ovf:version="1.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xml:lang="en-US" xmlns="http://schemas.dmtf.org/ovf/envelope/1"
+          xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+          xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
+          xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
+          xmlns:vmw="http://www.vmware.com/schema/ovf">
+
+  <References>
+    <File ovf:href="pivotal-ops-manager-disk1.vmdk" ovf:size="4223308288" ovf:id="file1"/>
+  </References>
+
+  <DiskSection>
+    <Info>List of the virtual disks used in the package</Info>
+    <Disk ovf:capacity="171798603879"
+          ovf:diskId="vmdisk1"
+          ovf:fileRef="file1"
+          ovf:format="http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"/>
+  </DiskSection>
+
+  <NetworkSection>
+    <Info>Logical networks used in the package</Info>
+    <Network ovf:name="Network 1">
+      <Description>Logical network used by this appliance.</Description>
+    </Network>
+  </NetworkSection>
+
+  <vmw:IpAssignmentSection ovf:required="false" vmw:protocols="IPv4" vmw:schemes="">
+    <Info>Supported IP assignment schemes</Info>
+  </vmw:IpAssignmentSection>
+
+  <VirtualSystem ovf:id="FAKE_FILENAME">
+    <Info>A virtual machine</Info>
+
+    <ProductSection>
+      <Info/>
+      <Product>Ops Manager</Product>
+      <Vendor>Pivotal</Vendor>
+      <Version>2.2-build.365</Version>
+      <Property ovf:key="ip0" ovf:userConfigurable="true" ovf:type="string">
+        <Label>IP Address</Label>
+        <Description>The IP address for the Ops Manager. Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="netmask0" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Netmask</Label>
+        <Description>The netmask for the Ops Manager's network. Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="gateway" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Default Gateway</Label>
+        <Description>The default gateway address for the Ops Manager's network. Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="DNS" ovf:userConfigurable="true" ovf:type="string">
+        <Label>DNS</Label>
+        <Description>The domain name servers for the Ops Manager (comma separated). Leave blank if DHCP is desired.</Description>
+      </Property>
+      <Property ovf:key="ntp_servers" ovf:userConfigurable="true" ovf:type="string">
+        <Label>NTP Servers</Label>
+        <Description>Comma-delimited list of NTP servers</Description>
+      </Property>
+      <Property ovf:key="admin_password" ovf:required="true" ovf:userConfigurable="true" ovf:type="password">
+        <Label>Admin Password</Label>
+        <Description>This password is used to SSH into the Ops Manager. The username is 'ubuntu'.</Description>
+      </Property>
+      <Property ovf:key="custom_hostname" ovf:userConfigurable="true" ovf:type="string">
+        <Label>Custom Hostname</Label>
+        <Description>This will be set as the hostname on the VM. Default: 'pivotal-ops-manager'.</Description>
+      </Property>
+    </ProductSection>
+
+    <AnnotationSection>
+      <Info/>
+      <Annotation>Ops Manager for Pivotal Cloud Foundry
+        installs and manages PCF products and services.</Annotation>
+    </AnnotationSection>
+
+    <VirtualHardwareSection ovf:required="false" ovf:transport="com.vmware.guestInfo">
+      <Info>Virtual hardware requirements for a virtual machine</Info>
+      <System>
+        <vssd:ElementName>Virtual Hardware Family</vssd:ElementName>
+        <vssd:InstanceID>0</vssd:InstanceID>
+        <vssd:VirtualSystemIdentifier>FAKE_FILENAME</vssd:VirtualSystemIdentifier>
+        <vssd:VirtualSystemType>vmx-09</vssd:VirtualSystemType>
+      </System>
+      <Item>
+        <rasd:Caption>1 virtual CPU</rasd:Caption>
+        <rasd:Description>Number of virtual CPUs</rasd:Description>
+        <rasd:ElementName>1 virtual CPU</rasd:ElementName>
+        <rasd:InstanceID>1</rasd:InstanceID>
+        <rasd:ResourceType>3</rasd:ResourceType>
+        <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
+      </Item>
+      <Item>
+        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
+        <rasd:Caption>8192 MB of memory</rasd:Caption>
+        <rasd:Description>Memory Size</rasd:Description>
+        <rasd:ElementName>8192 MB of memory</rasd:ElementName>
+        <rasd:InstanceID>2</rasd:InstanceID>
+        <rasd:ResourceType>4</rasd:ResourceType>
+        <rasd:VirtualQuantity>8192</rasd:VirtualQuantity>
+      </Item>
+      <Item>
+        <rasd:Address>0</rasd:Address>
+        <rasd:Caption>scsiController0</rasd:Caption>
+        <rasd:Description>SCSI Controller</rasd:Description>
+        <rasd:ElementName>scsiController0</rasd:ElementName>
+        <rasd:InstanceID>3</rasd:InstanceID>
+        <rasd:ResourceSubType>lsilogic</rasd:ResourceSubType>
+        <rasd:ResourceType>6</rasd:ResourceType>
+      </Item>
+      <Item>
+        <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
+        <rasd:Caption>Ethernet adapter on 'Network 1'</rasd:Caption>
+        <rasd:Connection>Network 1</rasd:Connection>
+        <rasd:ElementName>Ethernet adapter on 'Network 1'</rasd:ElementName>
+        <rasd:InstanceID>4</rasd:InstanceID>
+        <rasd:ResourceSubType>E1000</rasd:ResourceSubType>
+        <rasd:ResourceType>10</rasd:ResourceType>
+      </Item>
+      <Item>
+        <rasd:AddressOnParent>0</rasd:AddressOnParent>
+        <rasd:Caption>disk1</rasd:Caption>
+        <rasd:Description>Disk Image</rasd:Description>
+        <rasd:ElementName>disk1</rasd:ElementName>
+        <rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
+        <rasd:InstanceID>5</rasd:InstanceID>
+        <rasd:Parent>3</rasd:Parent>
+        <rasd:ResourceType>17</rasd:ResourceType>
+      </Item>
+    </VirtualHardwareSection>
+  </VirtualSystem>
+</Envelope>

data/spec/fixtures/shepherd/vsphere-one-vm-config.yml

@@ -0,0 +1,35 @@
+iaas_type: vsphere
+vm_shepherd:
+  vm_configs:
+  - vcenter_creds:
+      ip: OVA_URL
+      username: OVA_ORGANIZATION
+      password: OVA_PASSWORD
+    vsphere:
+      datacenter: VSPHERE_DATACENTER
+      cluster: VSPHERE_CLUSTER
+      network: VSPHERE_NETWORK
+      resource_pool: VSPHERE_RESOURCE_POOL
+      datastore: VSPHERE_DATASTORE
+      folder: VSPHERE_FOLDER
+    vm:
+      ip: OVA_IP
+      gateway: OVA_GATEWAY
+      netmask: OVA_NETMASK
+      dns: OVA_DNS
+      ntp_servers: OVA_NTP
+      public_ssh_key: OVA_SSH_KEY
+      cpus: OVA_CPUS
+      ram_mb: OVA_RAM_MB
+      vm_password: not-tempest
+      custom_hostname: not-default-hostname
+    cleanup:
+      datacenter: VSPHERE_OTHER_DATACENTER
+      datastores:
+        - VSPHERE_DATASTORE_ONE
+        - VSPHERE_DATASTORE_TWO
+      datacenter_folders_to_clean:
+        - DC_FOLDER_ONE
+        - DC_FOLDER_TWO
+      datastore_folders_to_clean:
+        - DS_DISK_FOLDER

data/spec/vm_shepherd/aws_manager_spec.rb

@@ -320,6 +320,27 @@ module VmShepherd
         end
       end
 
+      context 'when the instance type is specified in the vm config' do
+        let(:vm_config) do
+          {
+            'vm_name' => 'some-vm-name',
+            'key_name' => 'ssh-key-name',
+            'instance_type' => 't3.medium'
+          }
+        end
+
+        it 'creates an instance' do
+          expect(ec2).to receive_message_chain(:instances, :create).with(
+            image_id: ami_id,
+            key_name: 'ssh-key-name',
+            security_group_ids: ['security-group-id'],
+            subnet: 'public-subnet-id',
+            instance_type: 't3.medium').and_return(instance)
+
+          ami_manager.deploy(ami_file_path: ami_file_path, vm_config: vm_config)
+        end
+      end
+
       context 'when the ip address is in use' do
         it 'retries until the IP address is available' do
           expect(instances).to receive(:create).and_raise(AWS::EC2::Errors::InvalidIPAddress::InUse).once

data/spec/vm_shepherd/shepherd_spec.rb

@@ -281,6 +281,215 @@ module VmShepherd
             manager.deploy(paths: ['FIRST_FAKE_PATH', 'LAST_FAKE_PATH'])
           end
         end
+
+        context 'when provision environment variables are set' do
+          before do
+            allow(VsphereManager).to receive(:new).with(
+              first_config.dig('vcenter_creds', 'ip'),
+              first_config.dig('vcenter_creds', 'username'),
+              first_config.dig('vcenter_creds', 'password'),
+              first_config.dig('vsphere', 'datacenter'),
+              instance_of(Logger),
+            ).and_return(first_ova_manager)
+
+            allow_any_instance_of(Shepherd).to receive(:read_assets_home).and_return('A PUBLIC KEY')
+          end
+          let(:settings_fixture_name) { 'vsphere-one-vm-config.yml' }
+
+          context 'when the PROVISION_WITH_PASSWORD environment variable is set' do
+            context 'and it is true' do
+              before { stub_const('ENV', {'PROVISION_WITH_PASSWORD' => 'true'}) }
+
+              context 'when the vm_password is set' do
+                before { stub_const('ENV', {'PROVISION_WITH_PASSWORD' => 'true', 'VSPHERE_VM_PASSWORD' => 'a-password'}) }
+                it 'deploys with the set vm password' do
+                  expect(first_ova_manager).to receive(:deploy).with(
+                    'FIRST_FAKE_PATH',
+                    {
+                      ip:          first_config.dig('vm', 'ip'),
+                      gateway:     first_config.dig('vm', 'gateway'),
+                      netmask:     first_config.dig('vm', 'netmask'),
+                      dns:         first_config.dig('vm', 'dns'),
+                      ntp_servers: first_config.dig('vm', 'ntp_servers'),
+                      cpus:        first_config.dig('vm', 'cpus'),
+                      ram_mb:      first_config.dig('vm', 'ram_mb'),
+                      vm_password: first_config.dig('vm', 'vm_password'),
+                      public_ssh_key: 'A PUBLIC KEY',
+                      custom_hostname: first_config.dig('vm', 'custom_hostname')
+                    },
+                    {
+                      cluster:       first_config.dig('vsphere', 'cluster'),
+                      resource_pool: first_config.dig('vsphere', 'resource_pool'),
+                      datastore:     first_config.dig('vsphere', 'datastore'),
+                      network:       first_config.dig('vsphere', 'network'),
+                      folder:        first_config.dig('vsphere', 'folder'),
+                    },
+                  )
+
+                  manager.deploy(paths: ['FIRST_FAKE_PATH'])
+                end
+              end
+
+              context 'when the ENV vsphere VM password is set' do
+                before do
+                  stub_const('ENV', { 'PROVISION_WITH_PASSWORD' => 'true', 'VSPHERE_VM_PASSWORD' => 'a-password' })
+                  first_config['vm']['vm_password'] = nil
+                end
+
+                it 'deploys with the ENV vm password' do
+                  expect(first_ova_manager).to receive(:deploy).with(
+                    'FIRST_FAKE_PATH',
+                    {
+                      ip:          first_config.dig('vm', 'ip'),
+                      gateway:     first_config.dig('vm', 'gateway'),
+                      netmask:     first_config.dig('vm', 'netmask'),
+                      dns:         first_config.dig('vm', 'dns'),
+                      ntp_servers: first_config.dig('vm', 'ntp_servers'),
+                      cpus:        first_config.dig('vm', 'cpus'),
+                      ram_mb:      first_config.dig('vm', 'ram_mb'),
+                      vm_password: 'a-password',
+                      public_ssh_key: 'A PUBLIC KEY',
+                      custom_hostname: first_config.dig('vm', 'custom_hostname')
+                    },
+                    {
+                      cluster:       first_config.dig('vsphere', 'cluster'),
+                      resource_pool: first_config.dig('vsphere', 'resource_pool'),
+                      datastore:     first_config.dig('vsphere', 'datastore'),
+                      network:       first_config.dig('vsphere', 'network'),
+                      folder:        first_config.dig('vsphere', 'folder'),
+                    },
+                  )
+
+                  manager.deploy(paths: ['FIRST_FAKE_PATH'])
+                end
+              end
+
+              context 'and neither vm password is set' do
+                before do
+                  first_config['vm']['vm_password'] = nil
+                end
+
+                it 'deploys with the hardcoded vm password' do
+                  expect(first_ova_manager).to receive(:deploy).with(
+                    'FIRST_FAKE_PATH',
+                    {
+                      ip:          first_config.dig('vm', 'ip'),
+                      gateway:     first_config.dig('vm', 'gateway'),
+                      netmask:     first_config.dig('vm', 'netmask'),
+                      dns:         first_config.dig('vm', 'dns'),
+                      ntp_servers: first_config.dig('vm', 'ntp_servers'),
+                      cpus:        first_config.dig('vm', 'cpus'),
+                      ram_mb:      first_config.dig('vm', 'ram_mb'),
+                      vm_password: 'tempest',
+                      public_ssh_key: 'A PUBLIC KEY',
+                      custom_hostname: first_config.dig('vm', 'custom_hostname')
+                    },
+                    {
+                      cluster:       first_config.dig('vsphere', 'cluster'),
+                      resource_pool: first_config.dig('vsphere', 'resource_pool'),
+                      datastore:     first_config.dig('vsphere', 'datastore'),
+                      network:       first_config.dig('vsphere', 'network'),
+                      folder:        first_config.dig('vsphere', 'folder'),
+                    },
+                  )
+                  manager.deploy(paths: ['FIRST_FAKE_PATH'])
+                end
+              end
+            end
+
+            context 'and it is false' do
+              before { stub_const('ENV', {'PROVISION_WITH_PASSWORD' => 'false'}) }
+
+              it 'deploys with a nil vm password' do
+                expect(first_ova_manager).to receive(:deploy).with(
+                  'FIRST_FAKE_PATH',
+                  {
+                    ip:          first_config.dig('vm', 'ip'),
+                    gateway:     first_config.dig('vm', 'gateway'),
+                    netmask:     first_config.dig('vm', 'netmask'),
+                    dns:         first_config.dig('vm', 'dns'),
+                    ntp_servers: first_config.dig('vm', 'ntp_servers'),
+                    cpus:        first_config.dig('vm', 'cpus'),
+                    ram_mb:      first_config.dig('vm', 'ram_mb'),
+                    vm_password: nil,
+                    public_ssh_key: 'A PUBLIC KEY',
+                    custom_hostname: first_config.dig('vm', 'custom_hostname')
+                  },
+                  {
+                    cluster:       first_config.dig('vsphere', 'cluster'),
+                    resource_pool: first_config.dig('vsphere', 'resource_pool'),
+                    datastore:     first_config.dig('vsphere', 'datastore'),
+                    network:       first_config.dig('vsphere', 'network'),
+                    folder:        first_config.dig('vsphere', 'folder'),
+                  },
+                )
+                manager.deploy(paths: ['FIRST_FAKE_PATH'])
+              end
+            end
+          end
+
+          context 'when the PROVISION_WITH_SSH_KEY environment variable is set' do
+            context 'and it is true' do
+              before { stub_const('ENV', {'PROVISION_WITH_SSH_KEY' => 'true'}) }
+
+              it 'deploys with the set public ssh key' do
+                expect(first_ova_manager).to receive(:deploy).with(
+                  'FIRST_FAKE_PATH',
+                  {
+                    ip:          first_config.dig('vm', 'ip'),
+                    gateway:     first_config.dig('vm', 'gateway'),
+                    netmask:     first_config.dig('vm', 'netmask'),
+                    dns:         first_config.dig('vm', 'dns'),
+                    ntp_servers: first_config.dig('vm', 'ntp_servers'),
+                    cpus:        first_config.dig('vm', 'cpus'),
+                    ram_mb:      first_config.dig('vm', 'ram_mb'),
+                    vm_password: first_config.dig('vm', 'vm_password'),
+                    public_ssh_key: 'A PUBLIC KEY',
+                    custom_hostname: first_config.dig('vm', 'custom_hostname')
+                  },
+                  {
+                    cluster:       first_config.dig('vsphere', 'cluster'),
+                    resource_pool: first_config.dig('vsphere', 'resource_pool'),
+                    datastore:     first_config.dig('vsphere', 'datastore'),
+                    network:       first_config.dig('vsphere', 'network'),
+                    folder:        first_config.dig('vsphere', 'folder'),
+                  },
+                )
+                manager.deploy(paths: ['FIRST_FAKE_PATH'])
+              end
+            end
+
+            context 'and it is false' do
+              before { stub_const('ENV', {'PROVISION_WITH_SSH_KEY' => 'false'}) }
+
+              it 'deploys with a nil public ssh key' do
+                expect(first_ova_manager).to receive(:deploy).with(
+                  'FIRST_FAKE_PATH',
+                  {
+                    ip:          first_config.dig('vm', 'ip'),
+                    gateway:     first_config.dig('vm', 'gateway'),
+                    netmask:     first_config.dig('vm', 'netmask'),
+                    dns:         first_config.dig('vm', 'dns'),
+                    ntp_servers: first_config.dig('vm', 'ntp_servers'),
+                    cpus:        first_config.dig('vm', 'cpus'),
+                    ram_mb:      first_config.dig('vm', 'ram_mb'),
+                    vm_password: first_config.dig('vm', 'vm_password'),
+                    public_ssh_key: nil,
+                    custom_hostname: first_config.dig('vm', 'custom_hostname')
+                  },
+                  {
+                    cluster:       first_config.dig('vsphere', 'cluster'),
+                    resource_pool: first_config.dig('vsphere', 'resource_pool'),
+                    datastore:     first_config.dig('vsphere', 'datastore'),
+                    network:       first_config.dig('vsphere', 'network'),
+                    folder:        first_config.dig('vsphere', 'folder'),
+                  },
+                )
+                manager.deploy(paths: ['FIRST_FAKE_PATH'])
+              end
+            end
+          end
+        end
       end
 
       context 'with AWS settings' do
@@ -616,6 +825,8 @@ module VmShepherd
             datacenter_folders_to_clean: first_config.dig('cleanup', 'datacenter_folders_to_clean'),
             datastores:                  first_config.dig('cleanup', 'datastores'),
             datastore_folders_to_clean:  first_config.dig('cleanup', 'datastore_folders_to_clean'),
+            cluster_name:  first_config.dig('vsphere', 'cluster'),
+            resource_pool_name:  first_config.dig('vsphere', 'resource_pool'),
           }
         end
         let(:last_ova_manager) { instance_double(VsphereManager) }
@@ -624,6 +835,8 @@ module VmShepherd
             datacenter_folders_to_clean: last_config.dig('cleanup', 'datacenter_folders_to_clean'),
             datastores:                  last_config.dig('cleanup', 'datastores'),
             datastore_folders_to_clean:  last_config.dig('cleanup', 'datastore_folders_to_clean'),
+            cluster_name:  last_config.dig('vsphere', 'cluster'),
+            resource_pool_name:  last_config.dig('vsphere', 'resource_pool'),
           }
         end
 

data/spec/vm_shepherd/vsphere_manager_spec.rb

@@ -48,18 +48,20 @@ module VmShepherd
       let(:ovf_template) { instance_double(RbVmomi::VIM::VirtualMachine, name: 'vm_name', add_delta_disk_layer_on_all_disks: nil, MarkAsTemplate: nil) }
       let(:vsphere_config) { { folder: folder_name, datastore: datastore_name } }
       let(:vm_config) { {ip: '10.0.0.1'} }
+      let(:ovf_path) { 'spec/fixtures/ova_manager/default.ovf' }
 
       before do
         allow(vsphere_manager).to receive(:system).with("nc -z -w 1 #{vm_config[:ip]} 443").and_return(false)
         allow(vsphere_manager).to receive(:system).with(/tar xfv/).and_return(true)
-        allow(Dir).to receive(:[]).and_return(['foo.ovf'])
+        allow(Dir).to receive(:[]).and_return([ovf_path])
+        allow(FileUtils).to receive(:remove_entry_secure)
         allow(vsphere_manager).to receive(:datacenter).and_return(datacenter)
         allow(vsphere_manager).to receive(:connection).and_return(connection)
         allow(ovf_manager).to receive(:deployOVF).and_return(ovf_template)
         allow(vsphere_manager).to receive(:ovf_template_options).and_return({})
       end
 
-      context 'When custom hostname is not set' do
+      context 'When a property value is not set' do
         it 'verifies the value of custom hostname is nil' do
           expect(vsphere_manager).to receive(:create_vm_from_template).and_return(vm1)
           allow(subject).to receive(:power_on_vm)
@@ -69,7 +71,34 @@ module VmShepherd
             custom_hostname_property = options[:spec].vAppConfig.property.find do |prop|
               prop.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:label] == 'custom_hostname'
             end
+            expect(custom_hostname_property.info.value).to be_nil
+            task
+          end
+
+          subject.deploy(ova_path, vm_config, vsphere_config)
+        end
+      end
+
+      context 'When the ovf does not contain a public_ssh_key property' do
+        let(:ovf_path) { 'spec/fixtures/ova_manager/without_public_ssh_key.ovf' }
+        let(:vm_config) { {ip: '10.0.0.1', custom_hostname: 'meow' } }
+
+        it 'does not create a property spec' do
+          expect(vsphere_manager).to receive(:create_vm_from_template).and_return(vm1)
+          allow(subject).to receive(:power_on_vm)
+          allow(task).to receive(:wait_for_completion)
+
+          expect(vm1).to receive(:ReconfigVM_Task) do |options|
+            custom_hostname_property = options[:spec].vAppConfig.property.find do |prop|
+              prop.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:label] == 'custom_hostname'
+            end
+            expect(custom_hostname_property.info.key).to eq(6)
+
+            custom_hostname_property = options[:spec].vAppConfig.property.find do |prop|
+              prop.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:label] == 'public_ssh_key'
+            end
             expect(custom_hostname_property).to be_nil
+
             task
           end
 

data/vm_shepherd.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ruby_vcloud_sdk', '0.7.4'
 
   spec.add_dependency 'rbvmomi', '1.11.3'
+  spec.add_dependency 'xmlrpc'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vm_shepherd
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Ops Manager Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-v1
@@ -80,6 +80,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.11.3
+- !ruby/object:Gem::Dependency
+  name: xmlrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,12 +181,15 @@ files:
 - lib/vm_shepherd/version.rb
 - lib/vm_shepherd/vsphere_manager.rb
 - spec/backport_refinements_spec.rb
+- spec/fixtures/ova_manager/default.ovf
 - spec/fixtures/ova_manager/foo.ova
+- spec/fixtures/ova_manager/without_public_ssh_key.ovf
 - spec/fixtures/shepherd/aws-no-elb.yml
 - spec/fixtures/shepherd/aws.yml
 - spec/fixtures/shepherd/openstack.yml
 - spec/fixtures/shepherd/unknown.yml
 - spec/fixtures/shepherd/vcloud.yml
+- spec/fixtures/shepherd/vsphere-one-vm-config.yml
 - spec/fixtures/shepherd/vsphere.yml
 - spec/spec_helper.rb
 - spec/support/patched_fog.rb
@@ -190,7 +207,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,19 +222,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A tool for booting and tearing down Ops Manager VMs on various Infrastructures.
 test_files:
 - spec/backport_refinements_spec.rb
+- spec/fixtures/ova_manager/default.ovf
 - spec/fixtures/ova_manager/foo.ova
+- spec/fixtures/ova_manager/without_public_ssh_key.ovf
 - spec/fixtures/shepherd/aws-no-elb.yml
 - spec/fixtures/shepherd/aws.yml
 - spec/fixtures/shepherd/openstack.yml
 - spec/fixtures/shepherd/unknown.yml
 - spec/fixtures/shepherd/vcloud.yml
+- spec/fixtures/shepherd/vsphere-one-vm-config.yml
 - spec/fixtures/shepherd/vsphere.yml
 - spec/spec_helper.rb
 - spec/support/patched_fog.rb