vm_shepherd 0.0.1

data/lib/vm_shepherd/shepherd.rb

@@ -0,0 +1,166 @@
+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
+
+    def initialize(settings:)
+      @settings = settings
+    end
+
+    def deploy(path:)
+      case settings.iaas_type
+        when VCLOUD_IAAS_TYPE then
+          vcloud_deployer.deploy(
+            path,
+            vcloud_deploy_options,
+          )
+        when VSPHERE_IAAS_TYPE then
+          vsphere_deployer.deploy(
+            VSPHERE_TEMPLATE_PREFIX,
+            path,
+            vsphere_deploy_options,
+          )
+        when AWS_IAAS_TYPE then
+          ami_manager.deploy(path)
+        else
+          fail(InvalidIaas, "Unknown IaaS type: #{settings.iaas_type.inspect}")
+      end
+    end
+
+    def destroy
+      case settings.iaas_type
+        when VCLOUD_IAAS_TYPE then
+          VmShepherd::VappManager::Destroyer.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,
+            },
+            Logger.new(STDOUT).tap { |l| l.level = Logger::Severity::ERROR }
+          ).destroy(settings.vapp_deployer.vapp.name)
+        when VSPHERE_IAAS_TYPE then
+          VmShepherd::OvaManager::Destroyer.new(
+            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
+          ami_manager.destroy
+        else
+          fail(InvalidIaas, "Unknown IaaS type: #{settings.iaas_type.inspect}")
+      end
+    end
+
+    private
+
+    attr_reader :settings
+
+    def logger
+      Logger.new(STDOUT).tap do |lggr|
+        lggr.level = Logger::Severity::ERROR
+      end
+    end
+
+    def debug_logger
+      Logger.new(STDOUT).tap do |lggr|
+        lggr.level = Logger::Severity::DEBUG
+      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
+      {
+        name: vm.name,
+        ip: vm.ip,
+        gateway: vm.gateway,
+        netmask: vm.netmask,
+        dns: vm.dns,
+        ntp: vm.ntp,
+      }
+    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(
+        aws_access_key: vm_deployer.aws_access_key,
+        aws_secret_key: vm_deployer.aws_secret_key,
+        ssh_key_name: vm_deployer.ssh_key_name,
+        security_group_id: vm_deployer.security_group,
+        public_subnet_id: vm_deployer.public_subnet_id,
+        private_subnet_id: vm_deployer.private_subnet_id,
+        elastic_ip_id: vm_deployer.elastic_ip_id,
+        vm_name: vm_deployer.vm_name,
+      )
+    end
+  end
+end

data/lib/vm_shepherd/vapp_manager/deployer.rb

@@ -0,0 +1,151 @@
+require 'tmpdir'
+require 'fileutils'
+require 'ruby_vcloud_sdk'
+
+module VmShepherd
+  module VappManager
+    class Deployer
+      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
+
+      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
+    end
+  end
+end

data/lib/vm_shepherd/vapp_manager/destroyer.rb

@@ -0,0 +1,46 @@
+require 'ruby_vcloud_sdk'
+
+module VmShepherd
+  module VappManager
+    class Destroyer
+      def initialize(login_info, location, logger)
+        @login_info = login_info
+        @location = location
+        @logger = logger
+      end
+
+      def destroy(vapp_name)
+        delete_vapp(vapp_name)
+        delete_catalog
+      end
+
+      private
+
+      def client
+        @client ||= VCloudSdk::Client.new(
+          @login_info[:url],
+          "#{@login_info[:user]}@#{@login_info[:organization]}",
+          @login_info[:password],
+          {},
+          @logger,
+        )
+      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
+end

data/lib/vm_shepherd/version.rb

@@ -0,0 +1,3 @@
+module VmShepherd
+  VERSION = '0.0.1'.freeze
+end

data/spec/fixtures/shepherd/aws.yml

@@ -0,0 +1,11 @@
+iaas_type: aws
+
+vm_deployer:
+  aws_access_key: aws-access-key
+  aws_secret_key: aws-secret-key
+  ssh_key_name: ssh-key-name
+  security_group: security-group-id
+  public_subnet_id: public-subnet-id
+  private_subnet_id: private-subnet-id
+  elastic_ip_id: elastic-ip-id
+  vm_name: vm-name

data/spec/fixtures/shepherd/unknown.yml

@@ -0,0 +1 @@
+iaas_type: unknown

data/spec/fixtures/shepherd/vcloud.yml

@@ -0,0 +1,19 @@
+iaas_type: vcloud
+vapp_deployer:
+  creds:
+    url: VAPP_URL
+    organization: VAPP_ORGANIZATION
+    user: VAPP_USERNAME
+    password: VAPP_PASSWORD
+  vdc:
+    name: VDC_NAME
+    catalog: VDC_CATALOG
+    network: VDC_NETWORK
+  vapp:
+    name: VAPP_NAME
+    ip: VAPP_IP
+    public_ip:
+    gateway: VAPP_GATEWAY
+    netmask: VAPP_NETMASK
+    dns: VAPP_DNS
+    ntp: VAPP_NTP

data/spec/fixtures/shepherd/vsphere.yml

@@ -0,0 +1,20 @@
+iaas_type: vsphere
+vm_deployer:
+  vcenter_creds:
+    ip: OVA_URL
+    username: OVA_ORGANIZATION
+    password: OVA_PASSWORD
+  vsphere:
+    host:
+    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

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+SPEC_ROOT = File.expand_path(__dir__)
+
+$LOAD_PATH << SPEC_ROOT
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  # config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 3
+
+  config.order = :random
+
+  Kernel.srand config.seed #this allows you to use `--seed` to deterministically reproduce failures
+end