bosh_cpi 0.4.2

data/README

@@ -0,0 +1 @@
+BOSH Cloud Provider Interface

data/Rakefile

@@ -0,0 +1,50 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+$:.unshift(File.expand_path("../../rake", __FILE__))
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rake"
+begin
+  require "rspec/core/rake_task"
+rescue LoadError
+end
+
+require "bundler_task"
+require "ci_task"
+
+gem_helper = Bundler::GemHelper.new(Dir.pwd)
+
+desc "Build CPI gem into the pkg directory"
+task "build" do
+  gem_helper.build_gem
+end
+
+desc "Build and install CPI into system gems"
+task "install" do
+  Rake::Task["bundler:install"].invoke
+  gem_helper.install_gem
+end
+
+BundlerTask.new
+
+if defined?(RSpec)
+  namespace :spec do
+    desc "Run Unit Tests"
+    rspec_task = RSpec::Core::RakeTask.new(:unit) do |t|
+      t.pattern = "spec/unit/**/*_spec.rb"
+      t.rspec_opts = %w(--format progress --colour)
+    end
+
+    CiTask.new do |task|
+      task.rspec_task = rspec_task
+    end
+  end
+
+  desc "Run tests"
+  task :spec => %w(spec:unit)
+end

data/lib/cloud/config.rb

@@ -0,0 +1,14 @@
+module Bosh::Clouds
+  class Config
+
+    class << self
+      extend Forwardable
+      def_delegators :@delegate, :db, :logger, :uuid
+    end
+
+    def self.configure(config)
+      @delegate = config
+    end
+
+  end
+end

data/lib/cloud/errors.rb

@@ -0,0 +1,21 @@
+module Bosh::Clouds
+
+  class CpiError < StandardError; end
+  class NotImplemented < CpiError; end
+
+  class CloudError < StandardError; end
+  class VMNotFound < CloudError; end
+
+  class RetriableCloudError < CloudError
+    attr_accessor :ok_to_retry
+
+    def initialize(ok_to_retry)
+      @ok_to_retry = ok_to_retry
+    end
+  end
+
+  class NoDiskSpace < RetriableCloudError; end
+  class DiskNotAttached < RetriableCloudError; end
+  class DiskNotFound < RetriableCloudError; end
+
+end

data/lib/cloud/provider.rb

@@ -0,0 +1,14 @@
+module Bosh::Clouds
+  class Provider
+
+    def self.create(plugin, options)
+      begin
+        require "cloud/#{plugin}"
+      rescue LoadError
+        raise CloudError, "Could not find Cloud Provider Plugin: #{plugin}"
+      end
+      Bosh::Clouds.const_get(plugin.capitalize).new(options)
+    end
+
+  end
+end

data/lib/cloud/version.rb

@@ -0,0 +1,5 @@
+module Bosh
+  module Clouds
+    VERSION = "0.4.2"
+  end
+end

data/lib/cloud.rb

@@ -0,0 +1,177 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh; module Clouds; end; end
+
+require "cloud/config"
+require "cloud/errors"
+require "cloud/provider"
+
+module Bosh
+
+  ##
+  # CPI - Cloud Provider Interface, used for interfacing with various IaaS APIs.
+  #
+  # Key terms:
+  # Stemcell: template used for creating VMs (shouldn't be powered on)
+  # VM:       VM created from a stemcell with custom settings (networking and resources)
+  # Disk:     volume that can be attached and detached from the VMs,
+  #           never attached to more than a single VM at one time
+  class Cloud
+
+    ##
+    # Cloud initialization
+    #
+    # @param [Hash] options cloud options
+    def initialize(options)
+    end
+
+    ##
+    # Creates a stemcell
+    #
+    # @param [String] image_path path to an opaque blob containing the stemcell image
+    # @param [Hash] cloud_properties properties required for creating this template
+    #               specific to a CPI
+    # @return [String] opaque id later used by {#create_vm} and {#delete_stemcell}
+    def create_stemcell(image_path, cloud_properties)
+      not_implemented(:create_stemcell)
+    end
+
+    ##
+    # Deletes a stemcell
+    #
+    # @param [String] stemcell stemcell id that was once returned by {#create_stemcell}
+    # @return nil
+    def delete_stemcell(stemcell_id)
+      not_implemented(:delete_stemcell)
+    end
+
+    ##
+    # Creates a VM - creates (and powers on) a VM from a stemcell with the proper resources
+    # and on the specified network. When disk locality is present the VM will be placed near
+    # the provided disk so it won't have to move when the disk is attached later.
+    #
+    # Sample networking config:
+    #  {"network_a" =>
+    #    {
+    #      "netmask"          => "255.255.248.0",
+    #      "ip"               => "172.30.41.40",
+    #      "gateway"          => "172.30.40.1",
+    #      "dns"              => ["172.30.22.153", "172.30.22.154"],
+    #      "cloud_properties" => {"name" => "VLAN444"}
+    #    }
+    #  }
+    #
+    # Sample resource pool config (CPI specific):
+    #  {
+    #    "ram"  => 512,
+    #    "disk" => 512,
+    #    "cpu"  => 1
+    #  }
+    # or similar for EC2:
+    #  {"name" => "m1.small"}
+    #
+    # @param [String] agent_id UUID for the agent that will be used later on by the director
+    #                 to locate and talk to the agent
+    # @param [String] stemcell stemcell id that was once returned by {#create_stemcell}
+    # @param [Hash] resource_pool cloud specific properties describing the resources needed
+    #               for this VM
+    # @param [Hash] networks list of networks and their settings needed for this VM
+    # @param [optional, String, Array] disk_locality disk id(s) if known of the disk(s) that will be
+    #                                    attached to this vm
+    # @param [optional, Hash] env environment that will be passed to this vm
+    # @return [String] opaque id later used by {#configure_networks}, {#attach_disk},
+    #                  {#detach_disk}, and {#delete_vm}
+    def create_vm(agent_id, stemcell_id, resource_pool,
+                  networks, disk_locality = nil, env = nil)
+      not_implemented(:create_vm)
+    end
+
+    ##
+    # Deletes a VM
+    #
+    # @param [String] vm vm id that was once returned by {#create_vm}
+    # @return nil
+    def delete_vm(vm_id)
+      not_implemented(:delete_vm)
+    end
+
+    ##
+    # Reboots a VM
+    #
+    # @param [String] vm vm id that was once returned by {#create_vm}
+    # @param [Optional, Hash] CPI specific options (e.g hard/soft reboot)
+    # @return nil
+    def reboot_vm(vm_id)
+      not_implemented(:reboot_vm)
+    end
+
+    ##
+    # Configures networking an existing VM.
+    #
+    # @param [String] vm vm id that was once returned by {#create_vm}
+    # @param [Hash] networks list of networks and their settings needed for this VM,
+    #               same as the networks argument in {#create_vm}
+    # @return nil
+    def configure_networks(vm_id, networks)
+      not_implemented(:configure_networks)
+    end
+
+    ##
+    # Creates a disk (possibly lazily) that will be attached later to a VM. When
+    # VM locality is specified the disk will be placed near the VM so it won't have to move
+    # when it's attached later.
+    #
+    # @param [Integer] size disk size in MB
+    # @param [optional, String] vm_locality vm id if known of the VM that this disk will
+    #                           be attached to
+    # @return [String] opaque id later used by {#attach_disk}, {#detach_disk}, and {#delete_disk}
+    def create_disk(size, vm_locality = nil)
+      not_implemented(:create_disk)
+    end
+
+    ##
+    # Deletes a disk
+    # Will raise an exception if the disk is attached to a VM
+    #
+    # @param [String] disk disk id that was once returned by {#create_disk}
+    # @return nil
+    def delete_disk(disk_id)
+      not_implemented(:delete_disk)
+    end
+
+    ##
+    # Attaches a disk
+    #
+    # @param [String] vm vm id that was once returned by {#create_vm}
+    # @param [String] disk disk id that was once returned by {#create_disk}
+    # @return nil
+    def attach_disk(vm_id, disk_id)
+      not_implemented(:attach_disk)
+    end
+
+    ##
+    # Detaches a disk
+    #
+    # @param [String] vm vm id that was once returned by {#create_vm}
+    # @param [String] disk disk id that was once returned by {#create_disk}
+    # @return nil
+    def detach_disk(vm_id, disk_id)
+      not_implemented(:detach_disk)
+    end
+
+    ##
+    # Validates the deployment
+    # @api not_yet_used
+    def validate_deployment(old_manifest, new_manifest)
+      not_implemented(:validate_deployment)
+    end
+
+    private
+
+    def not_implemented(method)
+      raise Bosh::Clouds::NotImplemented,
+            "`#{method}' is not implemented by #{self.class}"
+    end
+
+  end
+end

data/spec/lib/cloud/spec.rb

@@ -0,0 +1,9 @@
+#used by unit/provider_spec.rb to test Provider.create
+module Bosh
+  module Clouds
+    class Spec
+      def initialize(options)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rspec"
+require "cloud"
+require "logger"
+
+class CloudSpecConfig
+
+  attr_accessor :db, :uuid
+
+  def logger
+    if @logger.nil?
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::ERROR
+    end
+    @logger
+  end
+
+  def uuid
+    @uuid ||= self.class.name
+  end
+end
+
+Bosh::Clouds::Config.configure(CloudSpecConfig.new)

data/spec/unit/config_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe Bosh::Clouds::Config do
+  it "configure a logger" do
+    Bosh::Clouds::Config.logger.should be_kind_of(Logger)
+  end
+
+  it "should configure a uuid" do
+    Bosh::Clouds::Config.uuid.should be_kind_of(String)
+  end
+
+  it "should not have a db configured" do
+    Bosh::Clouds::Config.db.should be_nil
+  end
+end

data/spec/unit/provider_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path("../../spec_helper", __FILE__)
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+describe Bosh::Clouds::Provider do
+  it "should create a provider instance" do
+
+    provider = Bosh::Clouds::Provider.create("spec", {})
+    provider.should be_kind_of(Bosh::Clouds::Spec)
+
+  end
+
+  it "should fail to create an invalid provider" do
+
+    lambda {
+      Bosh::Clouds::Provider.create("enoent", {})
+    }.should raise_error(Bosh::Clouds::CloudError)
+
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: bosh_cpi
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+  prerelease: 
+platform: ruby
+authors:
+- VMware
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bosh_common
+  requirement: &70217789535540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70217789535540
+description: BOSH CPI
+email: support@vmware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cloud.rb
+- lib/cloud/config.rb
+- lib/cloud/errors.rb
+- lib/cloud/provider.rb
+- lib/cloud/version.rb
+- README
+- Rakefile
+- spec/lib/cloud/spec.rb
+- spec/spec_helper.rb
+- spec/unit/config_spec.rb
+- spec/unit/provider_spec.rb
+homepage: http://www.vmware.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2486536985115199089
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2486536985115199089
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: BOSH CPI
+test_files:
+- spec/lib/cloud/spec.rb
+- spec/spec_helper.rb
+- spec/unit/config_spec.rb
+- spec/unit/provider_spec.rb