vm_shepherd 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd16c5dc4a8f8276b0c59927637e27a635005091
-  data.tar.gz: a16f15c127599cdf280b3fc4fa21cecced662d8d
+  metadata.gz: a15179c8d68cb360d34b776f21f000a202c9f058
+  data.tar.gz: 279e17c6e5bc45225a888bd3fb70fe750c3e58fe
 SHA512:
-  metadata.gz: 4ef0386504cbf50ec960bccf9e1eead05746441f7e4ff618249e43b0026da0fd6d1c9ffb17166a56ed203cc75b8726bd3a9214d5b0e27cfebc820e84b4e87899
-  data.tar.gz: 58ebe55c5ced17018c1a8666a8e0ff26b502870179c2cba965735ce67117d2bbde06ef17ec286ba1455bb62efea40892d9043daf28a3c7051f630a467f541751
+  metadata.gz: 13ce9b1112ac673d7cc70030814ea929f62cbe9e572c9ba1f70471f7073bea4a0c95893677338048a95cb99de3c2c763737553fe67777efbebba00d6eaef63a9
+  data.tar.gz: d74268270051fe55e7fd6a14037afbbd413c35d2234c210f15deb8d1ff2cef903e47126bf46a6fd215dbba3676820cd29113b6ae2cd67a24772bf8e630d15d47

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'vsphere_clients', git: 'http://github.com/pivotal-cf-experimental/vsphere_clients'
-
 gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pivotal CF
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
 # VmShepherd
 
-TODO: Write a gem description
+Gem for deploying and destroying a VM on different IAASs such as AWS, vSphere, vCloud, and Openstack
 
 ## Installation
 
@@ -20,7 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'vm_shepherd'
+
+settings =  # An OpenStruct with the expected IaaS specific settings.
+            # => See YAML under spec/fixtures/shepherd/ for expected values
+
+# create a new VM
+shep = VmShepherd::Shepherd.new(settings: settings)
+shep.deploy(path: 'path/to/vm.image')
+
+# destroy an existing VM
+shep = VmShepherd::Shepherd.new(settings: settings)
+shep.destroy
+```
 
 ## Contributing
 

data/ci/run_specs.sh

@@ -7,5 +7,10 @@ docker run \
   --rm=true \
   --volume=${PWD}:/vm_shepherd \
   --workdir=/vm_shepherd \
+  --env=VCENTER_IP=${VCENTER_IP} \
+  --env=USERNAME=${USERNAME} \
+  --env=PASSWORD=${PASSWORD} \
+  --env=DATACENTER_NAME=${DATACENTER_NAME} \
+  --env=DATASTORE_NAME=${DATASTORE_NAME} \
   ${DOCKER_REGISTRY}/${DOCKER_IMAGE_NAME} \
-  /bin/sh -c 'bundle && bundle exec rspec --format documentation'
+  /bin/sh -c 'bundle && bundle exec rake -t'

data/lib/vm_shepherd.rb

@@ -0,0 +1,12 @@
+require 'vm_shepherd/shepherd'
+require 'vm_shepherd/aws_manager'
+require 'vm_shepherd/openstack_manager'
+require 'vm_shepherd/vcloud_manager'
+require 'vm_shepherd/vsphere_manager'
+
+module VmShepherd
+  AWS_IAAS_TYPE = 'aws'.freeze
+  OPENSTACK_IAAS_TYPE = 'openstack'.freeze
+  VCLOUD_IAAS_TYPE = 'vcloud'.freeze
+  VSPHERE_IAAS_TYPE = 'vsphere'.freeze
+end

data/lib/vm_shepherd/{ami_manager.rb → aws_manager.rb}

@@ -1,12 +1,11 @@
 require 'aws-sdk-v1'
 
 module VmShepherd
-  class AmiManager
+  class AwsManager
     class RetryLimitExceeded < StandardError
     end
 
     AWS_REGION = 'us-east-1'
-    OPS_MANAGER_PRIVATE_IP = '10.0.1.5'
     OPS_MANAGER_INSTANCE_TYPE = 'm3.medium'
     RETRY_LIMIT = 60
     RETRY_INTERVAL = 5
@@ -31,7 +30,6 @@ module VmShepherd
             key_name: aws_options.fetch(:ssh_key_name),
             security_group_ids: [aws_options.fetch(:security_group_id)],
             subnet: aws_options.fetch(:public_subnet_id),
-            private_ip_address: OPS_MANAGER_PRIVATE_IP,
             instance_type: OPS_MANAGER_INSTANCE_TYPE
           )
         end

data/lib/vm_shepherd/openstack_manager.rb

@@ -0,0 +1,102 @@
+require 'fog'
+
+module VmShepherd
+  class OpenstackManager
+    def initialize(auth_url:, username:, api_key:, tenant:)
+      @auth_url = auth_url
+      @username = username
+      @api_key = api_key
+      @tenant = tenant
+    end
+
+    def deploy(qcow2_file_path, vm_options)
+      say "Uploading the image #{qcow2_file_path}"
+      image = image_service.images.create(
+        name: vm_options[:name],
+        size: File.size(qcow2_file_path),
+        disk_format: 'qcow2',
+        container_format: 'bare',
+        location: qcow2_file_path,
+      )
+      say 'Finished uploading the image'
+
+      flavor = find_flavor(vm_options[:min_disk_size])
+      network = network_service.networks.find { |net| net.name == vm_options[:network_name] }
+      security_groups = vm_options[:security_group_names]
+
+      say('Launching an instance')
+      server = service.servers.create(
+        name: vm_options[:name],
+        flavor_ref: flavor.id,
+        image_ref: image.id,
+        key_name: vm_options[:key_name],
+        security_groups: security_groups,
+        nics: [
+          { net_id: network.id, v4_fixed_ip: vm_options[:private_ip] }
+        ],
+      )
+      server.wait_for { ready? }
+      say('Finished launching an instance')
+
+      say('Assigning a Public IP to the instance')
+      ip = service.addresses.find { |address| address.instance_id.nil? && address.ip == vm_options[:public_ip] }
+      ip.server = server
+      say('Finished assigning a Public IP to the instance')
+    end
+
+    def destroy(vm_options)
+      ip = service.addresses.find { |address| address.ip == vm_options[:public_ip] }
+      server = service.servers.get(ip.instance_id)
+      if server
+        image = image_service.images.get(server.image['id'])
+
+        server.destroy
+        image.destroy
+      end
+    end
+
+    def service
+      @service ||= Fog::Compute.new(
+        provider: 'openstack',
+        openstack_auth_url: auth_url,
+        openstack_username: username,
+        openstack_tenant: tenant,
+        openstack_api_key: api_key,
+      )
+    end
+
+    def image_service
+      @image_service ||= Fog::Image.new(
+        provider: 'openstack',
+        openstack_auth_url: auth_url,
+        openstack_username: username,
+        openstack_tenant: tenant,
+        openstack_api_key: api_key,
+        openstack_endpoint_type: 'publicURL',
+      )
+    end
+
+    def network_service
+      @network_service ||= Fog::Network.new(
+        provider: 'openstack',
+        openstack_auth_url: auth_url,
+        openstack_username: username,
+        openstack_tenant: tenant,
+        openstack_api_key: api_key,
+        openstack_endpoint_type: 'publicURL',
+      )
+    end
+
+    private
+
+    attr_reader :auth_url, :username, :api_key, :tenant
+
+    def say(message)
+      puts message
+    end
+
+    def find_flavor(min_disk)
+      service.flavors.find { |flavor| flavor.disk >= min_disk }
+    end
+  end
+end

data/lib/vm_shepherd/shepherd.rb

@@ -1,16 +1,5 @@
-require 'vm_shepherd/vapp_manager/deployer'
-require 'vm_shepherd/vapp_manager/destroyer'
-require 'vm_shepherd/ova_manager/deployer'
-require 'vm_shepherd/ova_manager/destroyer'
-require 'vm_shepherd/ami_manager'
-
 module VmShepherd
   class Shepherd
-    VCLOUD_IAAS_TYPE = 'vcloud'.freeze
-    VSPHERE_IAAS_TYPE = 'vsphere'.freeze
-    AWS_IAAS_TYPE = 'aws'.freeze
-    VSPHERE_TEMPLATE_PREFIX = 'tpl'.freeze
-
     class InvalidIaas < StandardError
 
     end
@@ -21,19 +10,51 @@ module VmShepherd
 
     def deploy(path:)
       case settings.iaas_type
-        when VCLOUD_IAAS_TYPE then
-          vcloud_deployer.deploy(
+        when VmShepherd::VCLOUD_IAAS_TYPE then
+          VmShepherd::VcloudManager.new(
+            {
+              url: settings.vapp_deployer.creds.url,
+              organization: settings.vapp_deployer.creds.organization,
+              user: settings.vapp_deployer.creds.user,
+              password: settings.vapp_deployer.creds.password,
+            },
+            {
+              vdc: settings.vapp_deployer.vdc.name,
+              catalog: settings.vapp_deployer.vdc.catalog,
+              network: settings.vapp_deployer.vdc.network,
+            },
+            debug_logger
+          ).deploy(
             path,
             vcloud_deploy_options,
           )
-        when VSPHERE_IAAS_TYPE then
-          vsphere_deployer.deploy(
-            VSPHERE_TEMPLATE_PREFIX,
+        when VmShepherd::VSPHERE_IAAS_TYPE then
+          VmShepherd::VsphereManager.new(
+            settings.vm_deployer.vcenter_creds.ip,
+            settings.vm_deployer.vcenter_creds.username,
+            settings.vm_deployer.vcenter_creds.password,
+            settings.vm_deployer.vsphere.datacenter,
+          ).deploy(
             path,
-            vsphere_deploy_options,
+            {
+              ip: settings.vm_deployer.vm.ip,
+              gateway: settings.vm_deployer.vm.gateway,
+              netmask: settings.vm_deployer.vm.netmask,
+              dns: settings.vm_deployer.vm.dns,
+              ntp_servers: settings.vm_deployer.vm.ntp_servers,
+            },
+            {
+              cluster: settings.vm_deployer.vsphere.cluster,
+              resource_pool: settings.vm_deployer.vsphere.resource_pool,
+              datastore: settings.vm_deployer.vsphere.datastore,
+              network: settings.vm_deployer.vsphere.network,
+              folder: settings.vm_deployer.vsphere.folder,
+            }
           )
-        when AWS_IAAS_TYPE then
+        when VmShepherd::AWS_IAAS_TYPE then
           ami_manager.deploy(path)
+        when VmShepherd::OPENSTACK_IAAS_TYPE then
+          openstack_vm_manager.deploy(path, openstack_vm_options)
         else
           fail(InvalidIaas, "Unknown IaaS type: #{settings.iaas_type.inspect}")
       end
@@ -41,8 +62,8 @@ module VmShepherd
 
     def destroy
       case settings.iaas_type
-        when VCLOUD_IAAS_TYPE then
-          VmShepherd::VappManager::Destroyer.new(
+        when VmShepherd::VCLOUD_IAAS_TYPE then
+          VmShepherd::VcloudManager.new(
             {
               url: settings.vapp_deployer.creds.url,
               organization: settings.vapp_deployer.creds.organization,
@@ -52,20 +73,21 @@ module VmShepherd
             {
               vdc: settings.vapp_deployer.vdc.name,
               catalog: settings.vapp_deployer.vdc.catalog,
+              network: settings.vapp_deployer.vdc.network,
             },
-            Logger.new(STDOUT).tap { |l| l.level = Logger::Severity::ERROR }
+            logger
           ).destroy(settings.vapp_deployer.vapp.name)
-        when VSPHERE_IAAS_TYPE then
-          VmShepherd::OvaManager::Destroyer.new(
+        when VmShepherd::VSPHERE_IAAS_TYPE then
+          VmShepherd::VsphereManager.new(
+            settings.vm_deployer.vcenter_creds.ip,
+            settings.vm_deployer.vcenter_creds.username,
+            settings.vm_deployer.vcenter_creds.password,
             settings.vm_deployer.vsphere.datacenter,
-            {
-              host: settings.vm_deployer.vcenter_creds.ip,
-              user: settings.vm_deployer.vcenter_creds.username,
-              password: settings.vm_deployer.vcenter_creds.password,
-            }
-          ).clean_folder(settings.vm_deployer.vsphere.folder)
-        when AWS_IAAS_TYPE then
+          ).destroy(settings.vm_deployer.vsphere.folder)
+        when VmShepherd::AWS_IAAS_TYPE then
           ami_manager.destroy
+        when VmShepherd::OPENSTACK_IAAS_TYPE then
+          openstack_vm_manager.destroy(openstack_vm_options)
         else
           fail(InvalidIaas, "Unknown IaaS type: #{settings.iaas_type.inspect}")
       end
@@ -87,25 +109,6 @@ module VmShepherd
       end
     end
 
-    def vcloud_deployer
-      creds = settings.vapp_deployer.creds
-      vdc = settings.vapp_deployer.vdc
-      VmShepherd::VappManager::Deployer.new(
-        {
-          url: creds.url,
-          organization: creds.organization,
-          user: creds.user,
-          password: creds.password,
-        },
-        {
-          vdc: vdc.name,
-          catalog: vdc.catalog,
-          network: vdc.network,
-        },
-        debug_logger
-      )
-    end
-
     def vcloud_deploy_options
       vm = settings.vapp_deployer.vapp
       {
@@ -118,40 +121,9 @@ module VmShepherd
       }
     end
 
-    def vsphere_deployer
-      vcenter_creds = settings.vm_deployer.vcenter_creds
-      vsphere = settings.vm_deployer.vsphere
-      VmShepherd::OvaManager::Deployer.new(
-        {
-          host: vcenter_creds.ip,
-          user: vcenter_creds.username,
-          password: vcenter_creds.password,
-        },
-        {
-          datacenter: vsphere.datacenter,
-          cluster: vsphere.cluster,
-          resource_pool: vsphere.resource_pool,
-          datastore: vsphere.datastore,
-          network: vsphere.network,
-          folder: vsphere.folder,
-        }
-      )
-    end
-
-    def vsphere_deploy_options
-      vm = settings.vm_deployer.vm
-      {
-        ip: vm.ip,
-        gateway: vm.gateway,
-        netmask: vm.netmask,
-        dns: vm.dns,
-        ntp_servers: vm.ntp_servers,
-      }
-    end
-
     def ami_manager
       vm_deployer = settings.vm_deployer
-      VmShepherd::AmiManager.new(
+      VmShepherd::AwsManager.new(
         aws_access_key: vm_deployer.aws_access_key,
         aws_secret_key: vm_deployer.aws_secret_key,
         ssh_key_name: vm_deployer.ssh_key_name,
@@ -162,5 +134,26 @@ module VmShepherd
         vm_name: vm_deployer.vm_name,
       )
     end
+
+    def openstack_vm_manager
+      OpenstackManager.new(
+        auth_url: settings.vm_deployer.creds.auth_url,
+        username: settings.vm_deployer.creds.username,
+        api_key: settings.vm_deployer.creds.api_key,
+        tenant: settings.vm_deployer.creds.tenant,
+      )
+    end
+
+    def openstack_vm_options
+      {
+        name: settings.vm_deployer.vm.name,
+        min_disk_size: settings.vm_deployer.vm.flavor_parameters.min_disk_size,
+        network_name: settings.vm_deployer.vm.network_name,
+        key_name: settings.vm_deployer.vm.key_name,
+        security_group_names: settings.vm_deployer.vm.security_group_names,
+        public_ip: settings.vm_deployer.vm.public_ip,
+        private_ip: settings.vm_deployer.vm.private_ip,
+      }
+    end
   end
 end

data/lib/vm_shepherd/vcloud_manager.rb

@@ -0,0 +1,170 @@
+require 'tmpdir'
+require 'fileutils'
+require 'ruby_vcloud_sdk'
+
+module VmShepherd
+  class VcloudManager
+    def initialize(login_info, location, logger)
+      @login_info = login_info
+      @location = location
+      @logger = logger
+      raise 'VDC must be set' unless @location[:vdc]
+      raise 'Catalog must be set' unless @location[:catalog]
+      raise 'Network must be set' unless @location[:network]
+    end
+
+    def deploy(vapp_template_tar_path, vapp_config)
+      tmpdir = Dir.mktmpdir
+
+      check_vapp_status(vapp_config)
+
+      untar_vapp_template_tar(File.expand_path(vapp_template_tar_path), tmpdir)
+
+      vapp = deploy_vapp(tmpdir, vapp_config)
+      reconfigure_vm(vapp, vapp_config)
+      vapp.power_on
+    ensure
+      FileUtils.remove_entry_secure(tmpdir, force: true)
+    end
+
+    def destroy(vapp_name)
+      delete_vapp(vapp_name)
+      delete_catalog
+    end
+
+    private
+
+    def check_vapp_status(vapp_config)
+      log('Checking for existing VM') do
+        ip = vapp_config[:ip]
+        raise "VM exists at #{ip}" if system("ping -c 5 #{ip}")
+      end
+    end
+
+    def untar_vapp_template_tar(vapp_template_tar_path, dir)
+      log("Untarring #{vapp_template_tar_path}") do
+        system_or_exit("cd #{dir} && tar xfv '#{vapp_template_tar_path}'")
+      end
+    end
+
+    def client
+      @client ||= VCloudSdk::Client.new(
+        @login_info[:url],
+        "#{@login_info[:user]}@#{@login_info[:organization]}",
+        @login_info[:password],
+        {},
+        @logger,
+      )
+    end
+
+    def deploy_vapp(ovf_dir, vapp_config)
+      # setup the catalog
+      client.delete_catalog_by_name(@location[:catalog]) if client.catalog_exists?(@location[:catalog])
+      catalog = client.create_catalog(@location[:catalog])
+
+      # upload template and instantiate vapp
+      catalog.upload_vapp_template(@location[:vdc], vapp_config[:name], ovf_dir)
+
+      # instantiate template
+      network_config = VCloudSdk::NetworkConfig.new(@location[:network], 'Network 1')
+      catalog.instantiate_vapp_template(
+        vapp_config[:name], @location[:vdc], vapp_config[:name], nil, nil, network_config)
+    rescue => e
+      @logger.error(e.http_body) if e.respond_to?(:http_body)
+      raise e
+    end
+
+    def reconfigure_vm(vapp, vapp_config)
+      vm = vapp.find_vm_by_name(vapp_config[:name])
+      vm.product_section_properties = build_properties(vapp_config)
+      vm
+    end
+
+    def build_properties(vapp_config)
+      [
+        {
+          'type' => 'string',
+          'key' => 'gateway',
+          'value' => vapp_config[:gateway],
+          'password' => 'false',
+          'userConfigurable' => 'true',
+          'Label' => 'Default Gateway',
+          'Description' => 'The default gateway address for the VM network. Leave blank if DHCP is desired.'
+        },
+        {
+          'type' => 'string',
+          'key' => 'DNS',
+          'value' => vapp_config[:dns],
+          'password' => 'false',
+          'userConfigurable' => 'true',
+          'Label' => 'DNS',
+          'Description' => 'The domain name servers for the VM (comma separated). Leave blank if DHCP is desired.',
+        },
+        {
+          'type' => 'string',
+          'key' => 'ntp_servers',
+          'value' => vapp_config[:ntp],
+          'password' => 'false',
+          'userConfigurable' => 'true',
+          'Label' => 'NTP Servers',
+          'Description' => 'Comma-delimited list of NTP servers'
+        },
+        {
+          'type' => 'string',
+          'key' => 'admin_password',
+          'value' => 'tempest',
+          'password' => 'true',
+          'userConfigurable' => 'true',
+          'Label' => 'Admin Password',
+          'Description' => 'This password is used to SSH into the VM. The username is "tempest".',
+        },
+        {
+          'type' => 'string',
+          'key' => 'ip0',
+          'value' => vapp_config[:ip],
+          'password' => 'false',
+          'userConfigurable' => 'true',
+          'Label' => 'IP Address',
+          'Description' => 'The IP address for the VM. Leave blank if DHCP is desired.',
+        },
+        {
+          'type' => 'string',
+          'key' => 'netmask0',
+          'value' => vapp_config[:netmask],
+          'password' => 'false',
+          'userConfigurable' => 'true',
+          'Label' => 'Netmask',
+          'Description' => 'The netmask for the VM network. Leave blank if DHCP is desired.'
+        }
+      ]
+    end
+
+    def log(title, &blk)
+      @logger.debug "--- Begin: #{title.inspect} @ #{DateTime.now}"
+      blk.call
+      @logger.debug "---   End: #{title.inspect} @ #{DateTime.now}"
+    end
+
+    def system_or_exit(command)
+      log(command) do
+        system(command) || raise("Error executing: #{command.inspect}")
+      end
+    end
+
+    def vdc
+      @vdc ||= client.find_vdc_by_name(@location[:vdc])
+    end
+
+    def delete_vapp(vapp_name)
+      vapp = vdc.find_vapp_by_name(vapp_name)
+      vapp.power_off
+      vapp.delete
+    rescue VCloudSdk::ObjectNotFoundError => e
+      @logger.debug "Could not delete vapp '#{vapp_name}': #{e.inspect}"
+    end
+
+    def delete_catalog
+      client.delete_catalog_by_name(@location[:catalog]) if client.catalog_exists?(@location[:catalog])
+    end
+  end
+end