Class: Ec2Helper

Inherits:
Object
  • Object
show all
Defined in:
lib/help/ec2_helper.rb

Instance Method Summary collapse

Constructor Details

#initialize(ec2_api) ⇒ Ec2Helper

expects an instance of AWS::EC2::Base from the amazon-ec2 gem



45
46
47
 
# File 'lib/help/ec2_helper.rb', line 45

def initialize(ec2_api)
  @ec2_api = ec2_api
end

Instance Method Details

#ami_blkdevmap_ebs_prop(ami_id, prop) ⇒ Object

Get info from “imagesSet”=>“item”=>“blockDeviceMapping”=>“item”



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/help/ec2_helper.rb', line 138

def ami_blkdevmap_ebs_prop(ami_id, prop)
  amis = @ec2_api.describe_images(:image_id => ami_id)
  begin
    if amis['imagesSet']['item'].size == 0
      raise Exception.new("image #{ami_id} not found")
    end
    if amis['imagesSet']['item'][0]['blockDeviceMapping']['item'].size == 0
      raise Exception.new("blockDeviceMapping not found for image #{ami_id}")
    end
    return amis['imagesSet']['item'][0]['blockDeviceMapping']['item'][0]['ebs'][prop.to_s]
  rescue
    raise Exception.new("image #{ami_id} not found")
  end
end

#ami_prop(ami_id, prop) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/help/ec2_helper.rb', line 125

def ami_prop(ami_id, prop)
  amis = @ec2_api.describe_images(:image_id => ami_id)
  begin
    if amis['imagesSet']['item'].size == 0
      raise Exception.new("image #{ami_id} not found")
    end
    return amis['imagesSet']['item'][0][prop.to_s]
  rescue
    raise Exception.new("image #{ami_id} not found")
  end
end

#check_keypair(keypair_name) ⇒ Object

Check if keypair exist



268
269
270
271
 
# File 'lib/help/ec2_helper.rb', line 268

def check_keypair(keypair_name)
  puts "check if '#{keypair_name}' keypair exists"
  @ec2_api.describe_keypairs(:key_name => keypair_name)
end

#check_open_port(security_group, port, range = "0.0.0.0/0") ⇒ Object

Checks if all ports are opened for the security group on range “0.0.0.0/0”. If an additional range is specified in the parameter, a check returns true if a port is opened for either range 0.0.0.0/0 or the additional range specified. Returns true or false.



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/help/ec2_helper.rb', line 172

def check_open_port(security_group, port, range = "0.0.0.0/0")
  res = @ec2_api.describe_security_groups(:group_name => security_group)
  #puts "res = #{res.inspect}"
  groups = res['securityGroupInfo']['item']
  if groups.size == 0
    raise Exception.new("security group '#{security_group}' not found")
  end
  permissions = groups[0]['ipPermissions']['item']
  if permissions.size == 0
    # no permissions at all
    return false
  end
  permissions.each() {|permission|
    #puts "permission: #{permission.inspect}"
    if permission['ipRanges'] == nil
      #no IP-Ranges defined (group based mode): ignore
      next
    end
    from_port = permission['fromPort'].to_i
    to_port = permission['toPort'].to_i
    prot = permission['ipProtocol']
    if port >= from_port && port <= to_port && prot == "tcp"
      permission['ipRanges']['item'].each() {|ipRange|
        if ipRange['cidrIp'] != "0.0.0.0/0" && ipRange['cidrIp'] != range
          next
        else
          return true
        end
      }
    end
  }
  false
end

#get_attached_volumes(instance_id) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/help/ec2_helper.rb', line 83

def get_attached_volumes(instance_id)
  instances = @ec2_api.describe_instances(:instance_id => instance_id)
  begin
    if instances['reservationSet']['item'][0]['instancesSet']['item'].size == 0
      raise Exception.new("instance #{instance_id} not found")
    end
    puts "instances = #{instances.inspect}"
    puts "attachments: #{instances['reservationSet']['item'][0]['instancesSet']['item'][0]['blockDeviceMapping']['item'].inspect}"
    attached = instances['reservationSet']['item'][0]['instancesSet']['item'][0]['blockDeviceMapping']['item'].collect() { |item|
      #
      puts "item = #{item['ebs'].inspect}"
      item['ebs']
    }
    puts "going to return #{attached.size.to_s}"
    return attached
  rescue Exception => e
    puts "exception: #{e.inspect}"
    puts e.backtrace.join("\n")
    raise Exception.new("error during retrieving attachments from instance #{instance_id} not found")
  end
end

#get_instance_id(instance_info) ⇒ Object

Looks up the instanceId for the output retrieved by EC2::describe_instances(:instance_id => xxx) without the reservation set.



255
256
257
258
 
# File 'lib/help/ec2_helper.rb', line 255

def get_instance_id(instance_info)
  puts "look up instanceId in #{instance_info.inspect}"
  instance_info['instancesSet']['item'][0]['instanceId']
end

#get_instance_prop(instance_info, prop) ⇒ Object

Looks up the instanceId for the output retrieved by EC2::describe_instances(:instance_id => xxx) without the reservation set.



262
263
264
265
 
# File 'lib/help/ec2_helper.rb', line 262

def get_instance_prop(instance_info, prop)
  puts "look up #{prop} in #{instance_info.inspect}"
  instance_info['instancesSet']['item'][0][prop.to_s]
end

#get_security_group_info(group_name, group_infos) ⇒ Object

From the information retrieved via EC2::describe_security_groups, look up all open ports for the group specified



208
209
210
211
212
213
 
# File 'lib/help/ec2_helper.rb', line 208

def get_security_group_info(group_name, group_infos)
  group_infos['securityGroupInfo']['item'].each() do |group_info|
    return group_info if group_info['groupName'] == group_name
  end
  nil
end

#instance_prop(instance_id, prop, instances = nil) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/help/ec2_helper.rb', line 153

def instance_prop(instance_id, prop, instances = nil)
  if instances == nil
    instances = @ec2_api.describe_instances(:instance_id => instance_id)
  end
  begin
    if instances['reservationSet']['item'][0]['instancesSet']['item'].size == 0
      raise Exception.new("instance #{instance_id} not found")
    end
    return instances['reservationSet']['item'][0]['instancesSet']['item'][0][prop.to_s]
  rescue
    raise Exception.new("instance #{instance_id} not found")
  end
end

#is_root_device?(volume_id) ⇒ Boolean

Checks if the specified volume is acting as a root-device for the instance to which it is attached. It therefore first calls ec2_describe_volumes() to retrieve the instance linked to the volume specified, then calls ec2_describe_instance_attribute() to retrieve the rootDeviceName of that instance, and finally calls describe_instances() to retrieve all volumes to check against volume_id and rootDeviceName.

Returns:

  • (Boolean) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/help/ec2_helper.rb', line 55

def is_root_device?(volume_id)
  vols = @ec2_api.describe_volumes(:volume_id => volume_id)
  if vols['volumeSet']['item'][0]['attachmentSet'] == nil || vols['volumeSet']['item'][0]['attachmentSet']['item'].size == 0
    #not linked to any instance, cannot be a root-device
    return false
  end
  instance_id = vols['volumeSet']['item'][0]['attachmentSet']['item'][0]['instanceId']
  res = @ec2_api.describe_instance_attribute(:instance_id => instance_id, :attributes => {:rootDeviceName => true})
  if res["rootDeviceName"] == nil
    return false
  end
  rdn = res['rootDeviceName']['value']
  res = @ec2_api.describe_instances(:instance_id => instance_id)
  if res['reservationSet']['item'][0]['instancesSet']['item'][0]['blockDeviceMapping']['item'].size == 0
    # volume unattached in the meantime
    return false
  end
  attached = res['reservationSet']['item'][0]['instancesSet']['item'][0]['blockDeviceMapping']['item']
  attached.each() {|ebs|
    volume = ebs['ebs']['volumeId']
    device_name = ebs['deviceName']
    if volume == volume_id && rdn == device_name
      return true
    end
  }
  return false
end

#lookup_open_ports(group_name, group_infos) ⇒ Object

From the information retrieved via EC2::describe_security_groups, look up all open ports for the group specified



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/help/ec2_helper.rb', line 229

def lookup_open_ports(group_name, group_infos)
  puts "group_infos = #{group_infos.inspect}"
  group_info = get_security_group_info(group_name, group_infos)
  puts "group_info for #{group_name} = #{group_info.inspect}"
  open_ports = []
  group_info['ipPermissions']['item'].each() {|permission|
    if permission['ipRanges'] == nil
      #no IP-Ranges defined (group based mode): ignore
      next
    end
    prot = permission['ipProtocol']
    from_port = permission['fromPort'].to_i
    to_port = permission['toPort'].to_i
    next if from_port != to_port #ignore port ranges
    permission['ipRanges']['item'].each() {|ipRange|
      if ipRange['cidrIp'] == "0.0.0.0/0"
        #found one
        open_ports << {:protocol => prot, :port => from_port}
      end
    }
  }
  open_ports
end

#lookup_security_group_names(instance_info) ⇒ Object

From the information retrieved via EC2::describe_instances for a specific instance, retrieve the names of the security groups belonging to that instance.



217
218
219
220
221
222
223
224
225
 
# File 'lib/help/ec2_helper.rb', line 217

def lookup_security_group_names(instance_info)
  group_names = []
  puts "lookup_security_group_names(#{instance_info.inspect})"
  instance_info['groupSet']['item'].each() {|group_info|
    group_name = group_info['groupName'] || group_info['groupId']
    group_names << group_name
  }
  group_names
end

#snapshot_prop(snapshot_id, prop) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/help/ec2_helper.rb', line 113

def snapshot_prop(snapshot_id, prop)
  snaps = @ec2_api.describe_snapshots(:snapshot_id => snapshot_id)
  begin
    if snaps['snapshotSet']['item'].size == 0
      raise Exception.new("snapshot #{snapshot_id} not found")
    end
    return snaps['snapshotSet']['item'][0][prop.to_s]
  rescue
    raise Exception.new("snapshot #{snapshot_id} not found")
  end
end

#volume_prop(volume_id, prop) ⇒ Object 



105
106
107
108
109
110
111
 
# File 'lib/help/ec2_helper.rb', line 105

def volume_prop(volume_id, prop)
  vols = @ec2_api.describe_volumes(:volume_id => volume_id)
  if vols['volumeSet']['item'].size == 0
    raise Exception.new("volume #{volume_id} not found")
  end
  return vols['volumeSet']['item'][0][prop.to_s]
end