vagrant-softlayer 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.2.0 (December 5, 2013)
+
+NEW FEATURES:
+
+  - Automatic joining of local load balancers.
+
+## 0.1.0 (November 18, 2013)
+
+  - Initial release.

data/LICENSE

@@ -1,20 +1,20 @@
-The MIT License (MIT)
-
-Copyright (c) 2013 audiolize
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2013 audiolize
+
+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,5 +1,7 @@
 # Vagrant SoftLayer Provider
 
+[![Code Climate](https://codeclimate.com/github/audiolize/vagrant-softlayer.png)](https://codeclimate.com/github/audiolize/vagrant-softlayer)
+
 This is a [Vagrant](http://www.vagrantup.com) 1.3+ plugin that adds a [SoftLayer](http://www.softlayer.com)
 provider to Vagrant, allowing Vagrant to control and provision SoftLayer CCI instances.
 
@@ -102,6 +104,10 @@ Parameter    | Description                           | Default | Required
 ------------ | ------------------------------------- | ------- | --------
 `manage_dns` | Add/remove A record on create/destroy | false   | no
 
+### Join Local Load Balancers
+
+See [Join load balancers](https://github.com/audiolize/vagrant-softlayer/wiki/Join-load-balancers).
+
 ### Instance Configuration
 
 Parameter          | Description                                 | Default                 | Required
@@ -231,3 +237,7 @@ Use bundler to execute Vagrant:
 ```
 $ bundle exec vagrant up --provider=softlayer
 ```
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/audiolize/vagrant-softlayer/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new
-
-task :default => "spec"
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => "spec"

data/lib/vagrant-softlayer/action/destroy_instance.rb

@@ -10,12 +10,12 @@ module VagrantPlugins
         end
 
         def call(env)
-          @app.call(env)
-
           env[:ui].info I18n.t("vagrant_softlayer.vm.destroying")
           
           sl_warden { env[:sl_machine].deleteObject }
           env[:machine].id = nil
+
+          @app.call(env)
         end
       end
     end

data/lib/vagrant-softlayer/action/join_load_balancer.rb

@@ -0,0 +1,95 @@
+module VagrantPlugins
+  module SoftLayer
+    module Action
+      # Look for defined load balancers and perform join operations.
+      class JoinLoadBalancer
+        include Util::LoadBalancer
+        include Util::Network
+        include Util::Warden
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_softlayer::action::join_load_balancer")
+        end
+
+        def call(env)
+          @env = env
+
+          if enabled?
+            setup
+            prepare
+            join!
+            rebalance!
+          end
+
+          @app.call(@env)
+        end
+
+        def append_service_group(cfg, idx)
+          {}.tap do |virtual_server|
+            virtual_server["allocation"]    = 1
+            virtual_server["port"]          = cfg[:port]
+            virtual_server["serviceGroups"] = [
+              {
+                "routingMethodId" => (@enums["Routing_Method"][cfg[:method]] || 10),
+                "routingTypeId"   => (@enums["Routing_Type"][cfg[:type]] || 3),
+                "services"        => []
+              }
+            ]
+            @load_balancers[idx]["virtualServers"] << virtual_server
+          end
+        end
+
+        def join!
+          @pending = []
+
+          until @queue.empty?
+            job = @queue.pop
+            merge(job[:cfg], job[:idx])
+          end
+
+          # Perform the API calls for join.
+          @load_balancers.each_with_index do |lb, idx|
+            next unless @pending[idx]
+            @logger.debug("Updating VIP #{lb['id']} with: #{lb['virtualServers']}")
+            vip_id = @services["VirtualIpAddress"].object_with_id(lb["id"])
+            sl_warden { vip_id.editObject("virtualServers" => lb["virtualServers"]) }  
+          end
+        end
+
+        def merge(cfg, idx)
+          # Get the service group. Create it if not found.
+          sg = @load_balancers[idx]["virtualServers"].find(lambda { append_service_group(cfg, idx) }) { |g| g["port"] == cfg[:port] }
+          # Get the IP address ID of the current machine.
+          ip_id = ip_address_id(@env)
+          unless sg["serviceGroups"].first["services"].index { |s| s["ipAddressId"] == ip_id }
+            @logger.debug("Merging service: #{cfg[:service]}")
+            # Add the service to the group.
+            sg["serviceGroups"].first["services"] << {
+              "enabled"         => 1,
+              "ipAddressId"     => ip_id,
+              "groupReferences" => [ { "weight" => cfg[:service].weight } ],
+              "healthChecks"    => [ { "healthCheckTypeId" => (@enums["Health_Check_Type"][cfg[:service].health_check] || 21) } ],
+              "port"            => cfg[:service].destination_port
+            }
+            # Mark the load balancer object as pending update
+            @pending[idx] = true
+          end
+        end
+
+        def prepare
+          @env[:ui].info I18n.t("vagrant_softlayer.vm.joining_load_balancers")
+          
+          # For each definition, check if the load balancer exists and enqueue
+          # the join operation.
+          @queue = []
+          @env[:machine].provider_config.load_balancers.each do |cfg|
+            idx = @load_balancers.index { |lb| lb["ipAddress"]["ipAddress"] == cfg[:vip] }
+            raise Errors::SLLoadBalancerNotFound unless idx
+            @queue << { :cfg => cfg, :idx => idx }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-softlayer/action/load_balancer_cleanup.rb

@@ -0,0 +1,44 @@
+module VagrantPlugins
+  module SoftLayer
+    module Action
+      # Cleanup orphaned virtual servers from load balancers.
+      class LoadBalancerCleanup
+        include Util::LoadBalancer
+        include Util::Warden
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_softlayer::action::load_balancer_cleanup")
+        end
+
+        def call(env)
+          @env = env
+
+          if enabled?
+            setup
+            cleanup!
+            rebalance!
+          end
+
+          @app.call(@env)
+        end
+
+        def cleanup!
+          @env[:ui].info I18n.t("vagrant_softlayer.vm.load_balancer_cleanup")
+
+          # Keep it safe here. We delete a virtual server only if
+          # no services exist on any service group. In the future,
+          # we will find a way to selectively delete empty service groups.
+          @load_balancers.each do |load_balancer|
+            load_balancer["virtualServers"].each do |vs|
+              if vs["serviceGroups"].inject(0) { |sum, sg| sum + sg["services"].count } == 0
+                @logger.debug("Found empty virtual server (ID #{vs['id']}). Deleting.")
+                sl_warden { @services["VirtualServer"].object_with_id(vs["id"]).deleteObject }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-softlayer/action/update_dns.rb

@@ -16,11 +16,30 @@ module VagrantPlugins
         def call(env)
           @env = env
 
-          @env[:dns_zone] = setup_dns
+          update_dns
 
           @app.call(@env)
+        end
 
-          update_dns
+        def add_record
+          template = {
+            "data"     => ip_address(@env),
+            "domainId" => @dns_zone["id"],
+            "host"     => hostname(@env),
+            "ttl"      => 86400,
+            "type"     => "a"
+          }
+          @env[:ui].info I18n.t("vagrant_softlayer.vm.creating_dns_record")
+          @logger.debug("Creating DNS A record for #{template['host']}.#{@dns_zone[:name]} (IP address #{template['data']}).")
+          resource = sl_warden { @resource.createObject(template) }
+          self.dns_id = resource["id"]
+        end
+
+        def delete_record
+          @env[:ui].info I18n.t("vagrant_softlayer.vm.deleting_dns_record")
+          @logger.debug("Deleting stored DNS A record (ID #{self.dns_id}).")
+          warn_msg = lambda { @env[:ui].warn I18n.t("vagrant_softlayer.errors.dns_record_not_found") }
+          sl_warden(warn_msg) { @resource.object_with_id(self.dns_id).deleteObject }
         end
 
         def dns_id
@@ -45,49 +64,28 @@ module VagrantPlugins
           end
         end
 
-        def setup_dns
+        def update_dns
           unless @env[:machine].provider_config.manage_dns
             @logger.debug("Not managing DNS. Going ahead.")
             return
           end
 
-          dns_zone = ::SoftLayer::Service.new("SoftLayer_Dns_Domain", @env[:sl_credentials])
-
+          # Lookup the DNS zone
+          zone   = ::SoftLayer::Service.new("SoftLayer_Dns_Domain", @env[:sl_credentials])
           domain = @env[:machine].provider_config.domain
-          @logger.debug("Looking for #{domain} zone into the SoftLayer zone list.")
-          dns_zone_obj = sl_warden { dns_zone.getByDomainName(domain).first }
-          raise Errors::SLDNSZoneNotFound, :zone => domain unless dns_zone_obj
-          @logger.debug("Found DNS zone: #{dns_zone_obj.inspect}")
-          return dns_zone_obj
-        end
-
-        def update_dns
-          unless @env[:machine].provider_config.manage_dns
-            @logger.debug("Not managing DNS. Going ahead.")
-            return
-          end
 
-          dns_resource = ::SoftLayer::Service.new("SoftLayer_Dns_Domain_ResourceRecord", @env[:sl_credentials])
+          @logger.debug("Looking for #{domain} zone into the SoftLayer zone list.")
+          @dns_zone = sl_warden { zone.getByDomainName(domain).first }
+          raise Errors::SLDNSZoneNotFound, :zone => domain unless @dns_zone
+          @logger.debug("Found DNS zone: #{@dns_zone.inspect}")
 
-          case @env[:action_name]
-          when :machine_action_up
-            hostname          = @env[:machine].provider_config.hostname || @env[:machine].config.vm.hostname
-            @env[:sl_machine] = @env[:sl_connection].object_with_id(@env[:machine].id.to_i)
-            res_template      = {
-              "data"     => ip_address(@env),
-              "domainId" => @env[:dns_zone]["id"],
-              "host"     => hostname,
-              "ttl"      => 86400,
-              "type"     => "a"
-            }
-            @env[:ui].info I18n.t("vagrant_softlayer.vm.creating_dns_record")
-            @logger.debug("Creating DNS A record for #{hostname}.#{@env[:dns_zone][:name]} (IP address #{res_template['data']}).")
-            new_rr = sl_warden { dns_resource.createObject(res_template) }
-            self.dns_id = new_rr["id"]
-          when :machine_action_destroy
-            @env[:ui].info I18n.t("vagrant_softlayer.vm.deleting_dns_record")
-            @logger.debug("Deleting stored DNS A record (ID #{self.dns_id}).")
-            sl_warden { dns_resource.object_with_id(self.dns_id).deleteObject }
+          # Add or remove the resource record
+          @resource = ::SoftLayer::Service.new("SoftLayer_Dns_Domain_ResourceRecord", @env[:sl_credentials])
+          case @env[:machine_action]
+          when :up
+            add_record unless self.dns_id
+          when :destroy
+            delete_record
           end
         end
       end

data/lib/vagrant-softlayer/action.rb

@@ -1,4 +1,5 @@
 require "pathname"
+require "vagrant-softlayer/util/load_balancer"
 require "vagrant-softlayer/util/network"
 require "vagrant-softlayer/util/warden"
 
@@ -21,8 +22,10 @@ module VagrantPlugins
                 end
               end
               b2.use SetupSoftLayer
-              b2.use DestroyInstance
               b2.use UpdateDNS
+              b2.use DestroyInstance
+              b2.use LoadBalancerCleanup
+              b2.use ProvisionerCleanup
             else
               b2.use Message, :warn, "vagrant_softlayer.vm.not_destroying"
             end
@@ -157,9 +160,10 @@ module VagrantPlugins
               b1.use SetupSoftLayer
               b1.use Provision
               b1.use SyncFolders
-              b1.use UpdateDNS
               b1.use CreateInstance
               b1.use WaitForProvision
+              b1.use UpdateDNS
+              b1.use JoinLoadBalancer
               b1.use WaitForCommunicator
             else
               b1.use Call, Is, :halted do |env2, b2|
@@ -168,6 +172,8 @@ module VagrantPlugins
                   b2.use Provision
                   b2.use SyncFolders
                   b2.use StartInstance
+                  b2.use UpdateDNS
+                  b2.use JoinLoadBalancer
                   b2.use WaitForCommunicator
                 else
                   b2.use Message, :warn, "vagrant_softlayer.vm.already_running"
@@ -181,20 +187,22 @@ module VagrantPlugins
       # The autoload farm
       action_root = Pathname.new(File.expand_path("../action", __FILE__))
 
-      autoload :CreateInstance,   action_root.join("create_instance")
-      autoload :DestroyInstance,  action_root.join("destroy_instance")
-      autoload :Is,               action_root.join("is")
-      autoload :Message,          action_root.join("message")
-      autoload :ReadSSHInfo,      action_root.join("read_ssh_info")
-      autoload :ReadState,        action_root.join("read_state")
-      autoload :RebuildInstance,  action_root.join("rebuild_instance")
-      autoload :SetupSoftLayer,   action_root.join("setup_softlayer")
-      autoload :StartInstance,    action_root.join("start_instance")
-      autoload :StopInstance,     action_root.join("stop_instance")
-      autoload :SyncFolders,      action_root.join("sync_folders")
-      autoload :UpdateDNS,        action_root.join("update_dns")
-      autoload :WaitForProvision, action_root.join("wait_for_provision")
-      autoload :WaitForRebuild,   action_root.join("wait_for_rebuild")
+      autoload :CreateInstance,      action_root.join("create_instance")
+      autoload :DestroyInstance,     action_root.join("destroy_instance")
+      autoload :Is,                  action_root.join("is")
+      autoload :JoinLoadBalancer,    action_root.join("join_load_balancer")
+      autoload :LoadBalancerCleanup, action_root.join("load_balancer_cleanup")
+      autoload :Message,             action_root.join("message")
+      autoload :ReadSSHInfo,         action_root.join("read_ssh_info")
+      autoload :ReadState,           action_root.join("read_state")
+      autoload :RebuildInstance,     action_root.join("rebuild_instance")
+      autoload :SetupSoftLayer,      action_root.join("setup_softlayer")
+      autoload :StartInstance,       action_root.join("start_instance")
+      autoload :StopInstance,        action_root.join("stop_instance")
+      autoload :SyncFolders,         action_root.join("sync_folders")
+      autoload :UpdateDNS,           action_root.join("update_dns")
+      autoload :WaitForProvision,    action_root.join("wait_for_provision")
+      autoload :WaitForRebuild,      action_root.join("wait_for_rebuild")
     end
   end
 end

data/lib/vagrant-softlayer/config.rb

@@ -1,3 +1,5 @@
+require "ostruct"
+
 module VagrantPlugins
   module SoftLayer
     class Config < Vagrant.plugin("2", :config)
@@ -58,6 +60,9 @@ module VagrantPlugins
       # The ID of the public VLAN.
       attr_accessor :vlan_public
 
+      # The load balancers service groups to join.
+      attr_reader :load_balancers
+
       # Automatically update DNS on create and destroy.
       attr_accessor :manage_dns
 
@@ -83,7 +88,41 @@ module VagrantPlugins
         @vlan_private     = UNSET_VALUE
         @vlan_public      = UNSET_VALUE
 
-        @manage_dns = UNSET_VALUE
+        @load_balancers = []
+        @manage_dns     = UNSET_VALUE
+      end
+
+      # Set the load balancer service group to join.
+      #
+      # Available options:
+      #
+      # :method => Routing method. Default to round robin.
+      # :port   => Load balancer virtual port.
+      # :type   => Routing type. Default to TCP.
+      # :vip    => Load balancer virtual IP address.
+      #
+      # An optional block will accept parameters for the
+      # balanced service. Available parameters:
+      #
+      # :destination_port => TCP port on the node.
+      # :health_check     => Service health check. Default to ping.
+      # :weight           => Service weight. Default to 1.
+      #
+      def join_load_balancer(opts = {}, &block)
+        # Defaults
+        opts[:method] ||= "ROUND ROBIN"
+        opts[:type]   ||= "TCP"
+        opts[:service]  = OpenStruct.new(:destination_port => nil, :health_check => "PING", :weight => 1)
+        
+        yield opts[:service] if block_given?
+        
+        # Convert all options that belongs to
+        # an enumeration in uppercase.
+        opts[:method].upcase!
+        opts[:type].upcase!
+        opts[:service].health_check.upcase!
+
+        @load_balancers << opts
       end
 
       def finalize!
@@ -148,7 +187,7 @@ module VagrantPlugins
         @manage_dns = false if @manage_dns == UNSET_VALUE
       end
 
-      # Aliases for ssh_key for beautiful semantic
+      # Aliases for ssh_key for beautiful semantic.
       def ssh_keys=(value)
         @ssh_key = value
       end
@@ -171,6 +210,18 @@ module VagrantPlugins
           errors << I18n.t("vagrant_softlayer.config.hostname_required")
         end
 
+        # Fail if a load balancer has been specified without vip, port or destination port.
+        unless @load_balancers.empty?
+          @load_balancers.each do |lb|
+            errors << I18n.t("vagrant_softlayer.config.lb_port_vip_required") unless (lb[:vip] && lb[:port] && lb[:service].destination_port)
+          end
+        end
+
+        # Fail if two or more load balancers has been specified with same vip and port.
+        if @load_balancers.map { |lb| { :port => lb[:port], :vip => lb[:vip] } }.uniq!
+          errors << I18n.t("vagrant_softlayer.config.lb_duplicate")
+        end
+
         { "SoftLayer" => errors }
       end
     end

data/lib/vagrant-softlayer/errors.rb

@@ -17,6 +17,10 @@ module VagrantPlugins
         error_key(:dns_zone_not_found)
       end
 
+      class SLLoadBalancerNotFound < VagrantSoftLayerError
+        error_key(:load_balancer_not_found)
+      end
+
       class SLSshKeyNotFound < VagrantSoftLayerError
         error_key(:ssh_key_not_found)
       end

data/lib/vagrant-softlayer/util/load_balancer.rb

@@ -0,0 +1,103 @@
+module VagrantPlugins
+  module SoftLayer
+    module Util
+      # This mixin contains utility methods for load balancer management.
+      module LoadBalancer
+        # Whether load balancer management is enabled or not.
+        def enabled?
+          if @env[:machine].provider_config.load_balancers.empty?
+            @logger.debug("No load balancer has been defined. Going ahead.")
+            return false
+          end
+
+          # Currently we don't do load balancing for private machines.
+          if @env[:machine].provider_config.private_only
+            @logger.info("Load balancing doesn't work for private machines. Going ahead.")
+            return false
+          end
+          true
+        end
+
+        # Get existing stuff.
+        def read_load_balancers
+          mask    = [
+            "id",
+            "ipAddress.ipAddress",
+            "virtualServers.serviceGroups.services.groupReferences",
+            "virtualServers.serviceGroups.services.healthChecks"
+          ]
+          @logger.debug("Looking for existing load balancers.")
+          @load_balancers = sl_warden { @services["Account"].object_mask(mask).getAdcLoadBalancers }
+          @logger.debug("Got load balancer configuration:")
+          @logger.debug("-- #{@load_balancers}")
+        end
+
+        # For each load balancer, check if total connections
+        # are less than 100% and, if so, rebalance the allocations.
+        def rebalance!
+          read_load_balancers
+          
+          @load_balancers.each do |load_balancer|
+            next if load_balancer["virtualServers"].empty?
+            next if 100 == load_balancer["virtualServers"].inject(0) { |sum, vs| sum += vs["allocation"] }
+
+            # Create allocation slots.
+            count      = load_balancer["virtualServers"].count
+            allocation = [100 / count] * count
+            (100 % count).times { |i| allocation[i] += 1 }
+
+            # Rebalance allocations.
+            load_balancer["virtualServers"].each do |vs|
+              vs["allocation"] = allocation.pop
+            end
+
+            # Update the VIP object.
+            @logger.debug("Rebalancing VIP #{load_balancer['id']}")
+            @logger.debug("-- #{load_balancer}")
+            @services["VirtualIpAddress"].object_with_id(load_balancer["id"]).editObject("virtualServers" => load_balancer["virtualServers"])
+          end
+        end
+
+        # Initial setup.
+        def setup
+          # A plethora of service objects is required for managing
+          # load balancers. We instanciate'em all here.
+          @services = {
+            "Account" => ::SoftLayer::Service.new("SoftLayer_Account", @env[:sl_credentials])
+          }
+          [
+            "Health_Check_Type",
+            "Routing_Method",
+            "Routing_Type",
+            "Service",
+            "Service_Group",
+            "VirtualIpAddress",
+            "VirtualServer"
+          ].each do |service|
+            @services[service] = ::SoftLayer::Service.new(
+              "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_#{service}",
+              @env[:sl_credentials]
+            )
+          end
+
+          # We create enumerations for the various configurables.
+          @enums = {}
+          [
+            "Health_Check_Type",
+            "Routing_Method",
+            "Routing_Type"
+          ].each do |service|
+            {}.tap do |enum|
+              sl_warden { @services[service].getAllObjects }.each do |record|
+                enum[record["name"].upcase] = record["id"]
+              end
+              @enums[service] = enum
+            end
+          end
+
+          read_load_balancers
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-softlayer/util/network.rb

@@ -2,13 +2,44 @@ module VagrantPlugins
   module SoftLayer
     module Util
       module Network
-        # Gets instance's IP address.
+        # Gets hostname of the instance starting from the environment.
+        def hostname(env)
+          env[:machine].provider_config.hostname || env[:machine].config.vm.hostname
+        end
+
+        # Gets IP address of the instance starting from the environment.
         #
         # Returns the private IP address if the instance has been
         # defined as private only, the public IP address otherwise.
         def ip_address(env)
-          service = env[:machine].provider_config.private_only ? :getPrimaryBackendIpAddress : :getPrimaryIpAddress
-          return sl_warden { env[:sl_machine].send(service) }
+          ip_address_record(env)[:address]
+        end
+
+        # Gets IP address ID of the instance starting from the environment.
+        #
+        # Returns the private IP address ID if the instance has been
+        # defined as private only, the public IP address ID otherwise.
+        def ip_address_id(env)
+          ip_address_record(env)[:id]
+        end
+
+        # Gets IP address record of the instance starting from the environment.
+        #
+        # Returns an hash with the following structure:
+        #
+        # :address
+        # :id
+        #
+        # Returns the private IP address record if the instance has been
+        # defined as private only, the public IP address record otherwise.
+        def ip_address_record(env)
+          data_type = env[:machine].provider_config.private_only ? "primaryBackendNetworkComponent" : "primaryNetworkComponent"
+          mask      = { data_type => { "primaryIpAddressRecord" => ["id", "ipAddress"] } }
+          record    = sl_warden { env[:sl_machine].object_mask(mask).getObject }
+          return {
+            :address => record[data_type]["primaryIpAddressRecord"]["ipAddress"],
+            :id      => record[data_type]["primaryIpAddressRecord"]["id"]
+          }
         end
 
         # Returns SSH keys starting from the configuration parameter.

data/lib/vagrant-softlayer/util/warden.rb

@@ -19,7 +19,7 @@ module VagrantPlugins
           rescue ::OpenSSL::SSL::SSLError
             raise Errors::SLCertificateError
           rescue SocketError, ::SoftLayer::SoftLayerAPIException => e
-            if e.class == ::SoftLayer::SoftLayerAPIException && e.message.start_with?("Unable to find object with id")
+            if e.class == ::SoftLayer::SoftLayerAPIException && (e.message.start_with?("Unable to find object") || e.message.start_with?("Object does not exist"))
               out = rescue_proc.call if rescue_proc
               if retry_interval > 0
                 sleep retry_interval

data/lib/vagrant-softlayer/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module SoftLayer
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/locales/en.yml

@@ -26,6 +26,20 @@ en:
         config.vm.provider :softlayer do |sl|
           sl.hostname = "vagrant"
         end
+      lb_duplicate: |-
+        A load balancer service group has been specified multiple
+        times. Only one directive for any { :vip, :port } combination
+        is allowed.
+      lb_port_vip_required: |-
+        For joining a load balancer, you need to specify at least
+        virtual IP address, virtual server port and destination
+        port in the provider section of the Vagrantfile:
+
+        config.vm.provider :softlayer do |sl|
+          sl.join_load_balancer :port => 443, :vip => "1.1.1.1" do |service|
+            service.destination_port = 443
+          end
+        end
       ssh_key_required: |-
         At least an SSH key for the instance is required.
         Please specify it, either using name or id, in the
@@ -67,9 +81,15 @@ en:
         Windows example:
 
         set SSL_CERT_FILE=C:\HashiCorp\Vagrant\embedded\cacert.pem
+      dns_record_not_found: |-
+        The DNS record you're trying to delete has not been found.
       dns_zone_not_found: |-
         The DNS zone you're trying to manage (%{zone}) has not been
         found in the zone list.
+      load_balancer_not_found: |-
+        The load balancer you're trying to join has not been found.
+
+        Please check the configuration parameter for virtual IP address.
       ssh_key_not_found: |-
         The SSH key you're trying to set (%{key}) does not exists in the
         SoftLayer account's keychain.
@@ -116,6 +136,10 @@ en:
         Deleting DNS record for the instance...
       destroying: |-
         Destroying the SoftLayer instance...
+      joining_load_balancers: |-
+        Joining load balancer(s)...
+      load_balancer_cleanup: |-
+        Running cleanup tasks for load balancers...
       not_destroying: |-
         The SoftLayer instance will not be destroyed, since the confirmation
         was declined.

data/spec/vagrant-softlayer/config_spec.rb

@@ -32,7 +32,8 @@ describe VagrantPlugins::SoftLayer::Config do
     its("vlan_private")     { should be_nil }
     its("vlan_public")      { should be_nil }
 
-    its("manage_dns") { should be_false }
+    its("load_balancers") { should eq [] }
+    its("manage_dns")     { should be_false }
   end
 
   describe "overriding defaults" do
@@ -69,6 +70,34 @@ describe VagrantPlugins::SoftLayer::Config do
     end
   end
 
+  describe "joining load balancer" do
+    it "should set weight to 1 by default" do
+      config.join_load_balancer :port => 443, :vip => "1.1.1.1"
+      config.finalize!
+      expect(config.load_balancers.first[:service].weight).to eq(1)
+    end
+
+    it "should set passed options" do
+      config.join_load_balancer :foo => "bar", :port => 443, :vip => "1.1.1.1"
+      config.finalize!
+      expect(config.load_balancers.first[:foo]).to eq("bar")
+    end
+
+    it "should set service parameters" do
+      config.join_load_balancer :port => 443, :vip => "1.1.1.1" do |srv|
+        srv.destination_port = 443
+        srv.health_check     = "DNS"
+        srv.notes            = "Some notes"
+        srv.weight           = 9
+      end
+      config.finalize!
+      expect(config.load_balancers.first[:service].destination_port).to eq(443)
+      expect(config.load_balancers.first[:service].health_check).to eq("DNS")
+      expect(config.load_balancers.first[:service].notes).to eq("Some notes")
+      expect(config.load_balancers.first[:service].weight).to eq(9)
+    end
+  end
+
   describe "using SL_ environment variables" do
     before :each do
       ENV.stub(:[]).with("SL_API_KEY").and_return("env_api_key")
@@ -143,6 +172,7 @@ describe VagrantPlugins::SoftLayer::Config do
 
     it "should validate if hostname is not given but config.vm.hostname is set" do
       config.hostname = nil
+      config.finalize!
       machine.stub_chain(:config, :vm, :hostname).and_return("vagrant")
       expect(config.validate(machine)["SoftLayer"]).to have(:no).item
     end
@@ -152,5 +182,46 @@ describe VagrantPlugins::SoftLayer::Config do
       config.finalize!
       expect(config.validate(machine)["SoftLayer"]).to have(1).item
     end
+
+    it "should fail if a load balancer is specified without vip" do
+      config.join_load_balancer :port => 443 do |srv|
+        srv.destination_port = 443
+      end
+      config.finalize!
+      expect(config.validate(machine)["SoftLayer"]).to have(1).item
+    end
+
+    it "should fail if a load balancer is specified without port" do
+      config.join_load_balancer :vip => "1.1.1.1" do |srv|
+        srv.destination_port = 443
+      end
+      config.finalize!
+      expect(config.validate(machine)["SoftLayer"]).to have(1).item
+    end
+
+    it "should fail if a load balancer is specified without destination port" do
+      config.join_load_balancer :port => 443, :vip => "1.1.1.1"
+      config.finalize!
+      expect(config.validate(machine)["SoftLayer"]).to have(1).item
+    end
+
+    it "should fail if two load balancers han been defined with same vip and port" do
+      config.join_load_balancer :port => 443, :vip => "1.1.1.1" do |srv|
+        srv.destination_port = 443
+      end
+      config.join_load_balancer :port => 443, :vip => "1.1.1.1" do |srv|
+        srv.destination_port = 8443
+      end
+      config.finalize!
+      expect(config.validate(machine)["SoftLayer"]).to have(1).item
+    end
+
+    it "should validate if a load balancer if specified with vip, port and destination port" do
+      config.join_load_balancer :port => 443, :vip => "1.1.1.1" do |srv|
+        srv.destination_port = 443
+      end
+      config.finalize!
+      expect(config.validate(machine)["SoftLayer"]).to have(:no).item
+    end
   end
 end

data/vagrant-softlayer.gemspec

@@ -1,53 +1,53 @@
-$:.unshift File.expand_path("../lib", __FILE__)
-require "vagrant-softlayer/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "vagrant-softlayer"
-  spec.version       = VagrantPlugins::SoftLayer::VERSION
-  spec.authors       = "Audiolize GmbH"
-  spec.email         = ""
-  spec.description   = "Enables Vagrant to manages SoftLayer CCI."
-  spec.summary       = "Enables Vagrant to manages SoftLayer CCI."
-  
-  # The following block of code determines the files that should be included
-  # in the gem. It does this by reading all the files in the directory where
-  # this gemspec is, and parsing out the ignored files from the gitignore.
-  # Note that the entire gitignore(5) syntax is not supported, specifically
-  # the "!" syntax, but it should mostly work correctly.
-  root_path      = File.dirname(__FILE__)
-  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
-  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
-  gitignore_path = File.join(root_path, ".gitignore")
-  gitignore      = File.readlines(gitignore_path)
-  gitignore.map!    { |line| line.chomp.strip }
-  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
-
-  unignored_files = all_files.reject do |file|
-    # Ignore any directories, the gemspec only cares about files
-    next true if File.directory?(file)
-
-    # Ignore any paths that match anything in the gitignore. We do
-    # two tests here:
-    #
-    #   - First, test to see if the entire path matches the gitignore.
-    #   - Second, match if the basename does, this makes it so that things
-    #     like '.DS_Store' will match sub-directories too (same behavior
-    #     as git).
-    #
-    gitignore.any? do |ignore|
-      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
-        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
-    end
-  end
-
-  spec.files        = unignored_files
-  spec.executables  = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files   = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_path = "lib"
-
-  spec.add_dependency "softlayer_api"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-end
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-softlayer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-softlayer"
+  spec.version       = VagrantPlugins::SoftLayer::VERSION
+  spec.authors       = "Audiolize GmbH"
+  spec.email         = ""
+  spec.description   = "Enables Vagrant to manages SoftLayer CCI."
+  spec.summary       = "Enables Vagrant to manages SoftLayer CCI."
+  
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  spec.files        = unignored_files
+  spec.executables  = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files   = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path = "lib"
+
+  spec.add_dependency "softlayer_api"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-softlayer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: softlayer_api
@@ -81,6 +81,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - dummy.box
 - example_box/metadata.json
 - example_box/README.md
@@ -88,6 +89,8 @@ files:
 - lib/vagrant-softlayer/action/create_instance.rb
 - lib/vagrant-softlayer/action/destroy_instance.rb
 - lib/vagrant-softlayer/action/is.rb
+- lib/vagrant-softlayer/action/join_load_balancer.rb
+- lib/vagrant-softlayer/action/load_balancer_cleanup.rb
 - lib/vagrant-softlayer/action/message.rb
 - lib/vagrant-softlayer/action/read_ssh_info.rb
 - lib/vagrant-softlayer/action/read_state.rb
@@ -105,6 +108,7 @@ files:
 - lib/vagrant-softlayer/errors.rb
 - lib/vagrant-softlayer/plugin.rb
 - lib/vagrant-softlayer/provider.rb
+- lib/vagrant-softlayer/util/load_balancer.rb
 - lib/vagrant-softlayer/util/network.rb
 - lib/vagrant-softlayer/util/warden.rb
 - lib/vagrant-softlayer/version.rb
@@ -131,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3883830637352667112
+      hash: 2669020036350751985
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -140,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3883830637352667112
+      hash: 2669020036350751985
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23