Included Modules

Class/Module Index [+]

Quicksearch

Rudy::AWS::EC2::Instances

Constants

KNOWN_STATES

Public Class Methods

from_hash(h) click to toggle source

h is a hash of instance properties in the format returned by EC2::Base#describe_instances:

kernelId: aki-9b00e5f2
amiLaunchIndex: "0"
keyName: solutious-default
launchTime: "2009-03-14T12:48:15.000Z"
instanceType: m1.small
imageId: ami-0734d36e
privateDnsName: 
reason: 
placement: 
  availabilityZone: us-east-1b
dnsName: 
instanceId: i-cdaa34a4
instanceState: 
  name: pending
  code: "0"

Returns an Instance object.

# File lib/rudy/aws/ec2/instance.rb, line 344
def self.from_hash(h)
  inst = Rudy::AWS::EC2::Instance.new
  inst.aki = h['kernelId']
  inst.ami = h['imageId']
  inst.created = h['launchTime']
  inst.keyname = h['keyName']
  inst.launch_index = h['amiLaunchIndex']
  inst.size = h['instanceType']
  inst.dns_private = h['privateDnsName']
  inst.dns_public = h['dnsName']
  inst.reason = h['reason']
  inst.zone = h['placement']['availabilityZone']
  inst.awsid = h['instanceId']
  inst.state = h['instanceState']['name']
  inst
end
known_state?(state) click to toggle source

Is state a known EC2 machine instance state? See: KNOWN_STATES

# File lib/rudy/aws/ec2/instance.rb, line 362
def self.known_state?(state)
  return false unless state
  state &&= state.to_sym
  state = :shutting_down if state == :'shutting-down'
  KNOWN_STATES.member?(state)
end

Public Instance Methods

any?(state=:any, inst_ids=[]) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 287
def any?(state=:any, inst_ids=[])
  !list(state, inst_ids).nil?
end
any_group?(group=nil, state=:any) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 295
def any_group?(group=nil, state=:any)
  ret = list_group(group, state)
  !ret.nil?
end
attached_volume?(id, device) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 258
def attached_volume?(id, device)
  list = volumes(id)
  list.each do |v|
    return true if v.device == device
  end
  false
end
console(inst_id, &each_inst) click to toggle source

System console output.

  • inst_id instance ID (String) or Instance object.

NOTE: Amazon sends the console outputs as a Base64 encoded string. This method DOES NOT decode in order to remain compliant with the data formats returned by Amazon.

You can decode it like this:

require 'base64'
Base64.decode64(output)
# File lib/rudy/aws/ec2/instance.rb, line 250
def console(inst_id, &each_inst)
  inst_ids = objects_to_instance_ids([inst_id])
  response = Rudy::AWS::EC2.execute_request({}) { 
    @@ec2.get_console_output(:instance_id => inst_ids.first)
  }
  response['output']
end
create(opts={}, &each_inst) click to toggle source

Return an Array of Instance objects. Note: These objects will not have DNS data because they will still be in pending state. The DNS info becomes available once the instance enters the running state.

opts supports the following parameters:

  • :zone

  • :ami

  • :group

  • :size

  • :keypair

  • :private true or false (default)

  • :machine_data

  • :min count

  • :max count

# File lib/rudy/aws/ec2/instance.rb, line 65
def create(opts={}, &each_inst)
  raise NoAMI unless opts[:ami]
  raise NoGroup unless opts[:group]
  
  opts = {
    :size => 'm1.small',
    :min => 1,
    :max => nil
  }.merge(opts)
  
  old_opts = {
    :image_id => opts[:ami].to_s,
    :min_count => opts[:min],
    :max_count => opts[:max] || opts[:min],
    :key_name => (opts[:keypair] || '').to_s,
    :security_group => [opts[:group]].flatten.compact,
    #:user_data => opts[:machine_data],  # Error: Invalid BASE64 encoding of user data ??
    :availability_zone => opts[:zone].to_s,
    :instance_type => opts[:size].to_s,
    :kernel_id => nil
  }
  
  response = Rudy::AWS::EC2.execute_request({}) { @@ec2.run_instances(old_opts) }
  return nil unless response['instancesSet'].is_a?(Hash)
  instances = response['instancesSet']['item'].collect do |inst|
    self.from_hash(inst)
  end
  instances.each { |inst| 
    each_inst.call(inst) 
  } if each_inst
  instances
end
destroy(inst_ids=[], &each_inst) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 108
def destroy(inst_ids=[], &each_inst)
  instances = list(:running, inst_ids, &each_inst) || [] 
  raise NoRunningInstances if instances.empty?

  inst_ids = objects_to_instance_ids(inst_ids)
      
  response = Rudy::AWS::EC2.execute_request({}) {
    @@ec2.terminate_instances(:instance_id => inst_ids)
  }

  #instancesSet: 
  #  item: 
  #  - instanceId: i-ebdcb882
  #    shutdownState: 
  #      code: "48"
  #      name: terminated
  #    previousState: 
  #      code: "48"
  #      name: terminated

  raise MalformedResponse unless response['instancesSet'].is_a?(Hash)
  instances_shutdown = []
  response['instancesSet']['item'].collect do |inst|
    next unless inst['shutdownState'].is_a?(Hash) && inst['shutdownState']['name'] == 'shutting-down'
    instances_shutdown << inst['instanceId']
  end
  success = instances_shutdown.size == inst_ids.size
  success
end
destroy_group(group, &each_inst) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 144
def destroy_group(group, &each_inst)
  instances = list_group(group, :running, &each_inst) || []
  inst_ids = objects_to_instance_ids(instances)
  destroy(inst_ids, :skip_check)
end
device_volume(id, device) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 273
def device_volume(id, device)
  volumes(id).select { |v| v.device === device }
end
exists?(inst_ids) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 291
def exists?(inst_ids)
  any?(:any, inst_ids)
end
get(inst_id) click to toggle source

inst_id is an instance ID Returns an Instance object

# File lib/rudy/aws/ec2/instance.rb, line 279
def get(inst_id)
  return nil if inst_id.nil?
  inst_id = inst_id.awsid if inst_id.is_a?(Rudy::AWS::EC2::Instance)
  inst = list(:any, inst_id) 
  inst &&= inst.first
  inst
end
list(state=nil, inst_ids=[], &each_inst) click to toggle source
  • state is an optional instance state. If specified, must be one of: running (default), pending, terminated.

  • inst_ids is an Array of instance IDs.

Returns an Array of Rudy::AWS::EC2::Instance objects.

# File lib/rudy/aws/ec2/instance.rb, line 153
def list(state=nil, inst_ids=[], &each_inst)
  instances = list_as_hash(state, inst_ids, &each_inst)
  instances &&= instances.values
  instances = nil if instances && instances.empty? # Don't return an empty hash
  instances
end
list_as_hash(state=nil, inst_ids=[], &each_inst) click to toggle source
  • state is an optional instance state. If specified, must be

one of: running (default), pending, terminated, any

Returns a Hash of Rudy::AWS::EC2::Instance objects. The key is the instance ID.

  • each_inst a block to execute for every instance in the list.

# File lib/rudy/aws/ec2/instance.rb, line 190
def list_as_hash(state=nil, inst_ids=[], &each_inst)
  state &&= state.to_sym
  state = nil if state == :any
  raise "Unknown state: #{state}" if state && !Instances.known_state?(state)
  state = :'shutting-down' if state == :shutting_down # EC2 uses a dash

  # If we got Instance objects, we want just the IDs.
  # This method always returns an Array.
  inst_ids = objects_to_instance_ids(inst_ids)

  response = Rudy::AWS::EC2.execute_request({}) {
    @@ec2.describe_instances(:instance_id => inst_ids)
  }

  # requestId: c16878ac-28e4-4859-9878-ef93af45789c
  # reservationSet: 
  #   item: 
  #   - reservationId: r-e493148d
  #     groupSet: 
  #       item: 
  #       - groupId: default
  #     instancesSet: 
  #       item:
  return nil unless response['reservationSet'].is_a?(Hash)  # No instances 

  resids = []
  instances = {}
  response['reservationSet']['item'].each do |res|      
    resids << res['reservationId']
    groups = res['groupSet']['item'].collect { |g| g['groupId'] }
    # And each reservation can have 1 or more instances
    next unless res['instancesSet'].is_a?(Hash)
    res['instancesSet']['item'].each do |props|
      inst = Instances.from_hash(props)
      next if state && inst.state != state.to_s
      inst.groups = groups
      #puts "STATE: #{inst.state} #{state}"
      instances[inst.awsid] = inst
    end
  end
  
  instances.each_value { |inst| each_inst.call(inst) } if each_inst
  
  instances = nil if instances.empty? # Don't return an empty hash
  instances
end
list_group(group=nil, state=nil, inst_ids=[], &each_inst) click to toggle source
  • group is a security group name.

  • state is an optional instance state. If specified, must be one of: running (default), pending, terminated.

  • inst_ids is an Array of instance IDs.

# File lib/rudy/aws/ec2/instance.rb, line 163
def list_group(group=nil, state=nil, inst_ids=[], &each_inst)
  instances = list_group_as_hash(group, state, inst_ids, &each_inst)
  instances &&= instances.values
  instances = nil if instances && instances.empty? # Don't return an empty hash
  instances
end
list_group_as_hash(group=nil, state=nil, inst_ids=[], &each_inst) click to toggle source
  • group is a security group name.

  • state is an optional instance state. If specified, must be one of: running (default), pending, terminated.

  • inst_ids is an Array of instance IDs.

# File lib/rudy/aws/ec2/instance.rb, line 174
def list_group_as_hash(group=nil, state=nil, inst_ids=[], &each_inst)
  instances = list_as_hash(state, inst_ids)
  # Remove instances that are not in the specified group
  if instances
    instances = instances.reject { |id,inst| !inst.groups.member?(group) } if group
    instances.each_value { |inst| each_inst.call(inst) } if each_inst
  end
  instances = nil if instances && instances.empty? # Don't return an empty hash
  instances
end
pending?(inst_ids) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 303
def pending?(inst_ids)
  compare_instance_lists(list(:pending, inst_ids), inst_ids)
end
restart(inst_ids=[], &each_inst) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 98
def restart(inst_ids=[], &each_inst)
  instances = list(:running, inst_ids, &each_inst) || []
  raise NoRunningInstances if instances.empty?
  inst_ids = objects_to_instance_ids(inst_ids)
  response = Rudy::AWS::EC2.execute_request({}) {
    @@ec2.reboot_instances(:instance_id => inst_ids)
  }
  response['return'] == 'true'
end
restart_group(group, &each_inst) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 138
def restart_group(group, &each_inst)
  instances = list_group(group, :running, &each_inst) || []
  inst_ids = objects_to_instance_ids(instances)
  restart(inst_ids, :skip_check)
end
running?(inst_ids) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 300
def running?(inst_ids)
  compare_instance_lists(list(:running, inst_ids), inst_ids)
end
shutting_down?(inst_ids) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 309
def shutting_down?(inst_ids)
  compare_instance_lists(list(:shutting_down, inst_ids), inst_ids)
end
terminated?(inst_ids) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 306
def terminated?(inst_ids)
  compare_instance_lists(list(:terminated, inst_ids), inst_ids)
end
unavailable?(inst_ids) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 313
def unavailable?(inst_ids)
  instances = list(:any, inst_ids) || []
  instances.reject! { |inst| 
    (inst.state == "shutting-down" || 
     inst.state == "pending" || 
     inst.state == "terminated") 
  }
  compare_instance_lists(instances, inst_ids)
end
volumes(id) click to toggle source
# File lib/rudy/aws/ec2/instance.rb, line 266
def volumes(id)
  rvol = Rudy::AWS::EC2::Volumes.new
  rvol.ec2 = @ec2 
  rvol.list || []
  list.select { |v| v.attached? && v.instid === id }
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.