Class: Beaker::AwsSdk

Inherits:
Hypervisor show all
Defined in:
lib/beaker/hypervisor/aws_sdk.rb

Overview

This is an alternate EC2 driver that implements direct API access using Amazon’s AWS-SDK library: / SDK For Ruby

It is built for full control, to reduce any other layers beyond the pure vendor API.

Constant Summary collapse

ZOMBIE =

anything older than 3 hours is considered a zombie

3

Constants inherited from Hypervisor

Hypervisor::CHARMAP

Constants included from HostPrebuiltSteps

HostPrebuiltSteps::APT_CFG, HostPrebuiltSteps::CUMULUS_PACKAGES, HostPrebuiltSteps::DEBIAN_PACKAGES, HostPrebuiltSteps::ETC_HOSTS_PATH, HostPrebuiltSteps::ETC_HOSTS_PATH_SOLARIS, HostPrebuiltSteps::IPS_PKG_REPO, HostPrebuiltSteps::NTPSERVER, HostPrebuiltSteps::ROOT_KEYS_SCRIPT, HostPrebuiltSteps::ROOT_KEYS_SYNC_CMD, HostPrebuiltSteps::SLEEPWAIT, HostPrebuiltSteps::SLES_PACKAGES, HostPrebuiltSteps::TRIES, HostPrebuiltSteps::UNIX_PACKAGES, HostPrebuiltSteps::WINDOWS_PACKAGES

Instance Method Summary collapse

Methods inherited from Hypervisor

#configure, create, #generate_host_name, #proxy_package_manager, #validate

Methods included from HostPrebuiltSteps

#add_el_extras, #additive_hash_merge, #apt_get_update, #check_and_install_packages_if_needed, #construct_env, #copy_file_to_remote, #copy_ssh_to_root, #disable_iptables, #disable_se_linux, #echo_on_host, #enable_root_login, #epel_info_for, #get_domain_name, #get_ip, #hack_etc_hosts, #package_proxy, #proxy_config, #set_env, #set_etc_hosts, #sync_root_keys, #timesync, #validate_host

Methods included from DSL::Patterns

#block_on

Constructor Details

#initialize(hosts, options) ⇒ AwsSdk

Initialize AwsSdk hypervisor driver

Parameters:

  • hosts (Array<Beaker::Host>) —

    Array of Beaker::Host objects

  • options (Hash<String, String>) —

    Options hash



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 19

def initialize(hosts, options)
  @hosts = hosts
  @options = options
  @logger = options[:logger]

  # Get fog credentials from the local .fog file
  creds = load_fog_credentials(@options[:dot_fog])

  config = {
    :access_key_id => creds[:access_key],
    :secret_access_key => creds[:secret_key],
    :logger => Logger.new($stdout),
    :log_level => :debug,
    :log_formatter => AWS::Core::LogFormatter.colored,
    :max_retries => 12,
  }
  AWS.config(config)

  @ec2 = AWS::EC2.new()
end

Instance Method Details

#add_tags ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Add metadata tags to all instances



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 367

def add_tags
  @hosts.each do |host|
    instance = host['instance']

    # Define tags for the instance
    @logger.notify("aws-sdk: Add tags for #{host.name}")
    instance.add_tag("jenkins_build_url", :value => @options[:jenkins_build_url])
    instance.add_tag("Name", :value => host.name)
    instance.add_tag("department", :value => @options[:department])
    instance.add_tag("project", :value => @options[:project])
    instance.add_tag("created_by", :value => @options[:created_by])
  end

  nil
end

#backoff_sleep(tries) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Calculates and waits a back-off period based on the number of tries

Logs each backupoff time and retry value to the console.

Parameters:

  • tries (Number) —

    number of tries to calculate back-off period



466
467
468
469
470
471
472
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 466

def backoff_sleep(tries)
  # Exponential with some randomization
  sleep_time = 2 ** tries
  @logger.notify("aws-sdk: Sleeping #{sleep_time} seconds for attempt #{tries}.")
  sleep sleep_time
  nil
end

#cleanup ⇒ void

This method returns an undefined value.

Cleanup all earlier provisioned hosts on EC2 using the AWS::EC2 library

It goes without saying, but a #cleanup does nothing without a #provision method call first.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 78

def cleanup
  @logger.notify("aws-sdk: Cleanup, iterating across all hosts and terminating them")
  @hosts.each do |host|
    # This was set previously during provisioning
    instance = host['instance']

    # Only attempt a terminate if the instance actually is set by provision
    # and the instance actually 'exists'.
    if !instance.nil? and instance.exists?
      instance.terminate
    end
  end

  nil #void
end

#configure_hosts ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Configure /etc/hosts for each node



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 405

def configure_hosts
  @hosts.each do |host|
    etc_hosts = "127.0.0.1\tlocalhost localhost.localdomain\n"
    name = host.name
    domain = get_domain_name(host)
    ip = host['private_ip']
    etc_hosts += "#{ip}\t#{name} #{name}.#{domain} #{host['dns_name']}\n"
    @hosts.each do |neighbor|
      if neighbor == host
        next
      end
      name = neighbor.name
      domain = get_domain_name(neighbor)
      ip = neighbor['ip']
      etc_hosts += "#{ip}\t#{name} #{name}.#{domain} #{neighbor['dns_name']}\n"
    end
    set_etc_hosts(host, etc_hosts)
  end
end

#create_group(rv, ports) ⇒ AWS::EC2::SecurityGroup

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a new security group

Accepts a region or VPC for group creation.

Parameters:

  • rv (AWS::EC2::Region, AWS::EC2::VPC) —

    the AWS region or vpc control object

  • ports (Array<Number>) —

    an array of port numbers

Returns:

  • (AWS::EC2::SecurityGroup) —

    created security group



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 572

def create_group(rv, ports)
  name = group_id(ports)
  @logger.notify("aws-sdk: Creating group #{name} for ports #{ports.to_s}")
  group = rv.security_groups.create(name,
                                    :description => "Custom Beaker security group for #{ports.to_a}")

  unless ports.is_a? Set
    ports = Set.new(ports)
  end

  ports.each do |port|
    group.authorize_ingress(:tcp, port)
  end

  group
end

#enable_root(host) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Enables root access for a host when username is not root



439
440
441
442
443
444
445
446
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 439

def enable_root(host)
  if host['user'] != 'root'
    copy_ssh_to_root(host, @options)
    (host, @options)
    host['user'] = 'root'
    host.close
  end
end

#enable_root_on_hosts ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Enables root for instances with custom username like ubuntu-amis



429
430
431
432
433
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 429

def enable_root_on_hosts
  @hosts.each do |host|
    enable_root(host)
  end
end

#ensure_group(vpc, ports) ⇒ AWS::EC2::SecurityGroup

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return an existing group, or create new one

Accepts a VPC as input for checking & creation.

Parameters:

  • vpc (AWS::EC2::VPC) —

    the AWS vpc control object

  • ports (Array<Number>) —

    an array of port numbers

Returns:

  • (AWS::EC2::SecurityGroup) —

    created security group



551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 551

def ensure_group(vpc, ports)
  @logger.notify("aws-sdk: Ensure security group exists for ports #{ports.to_s}, create if not")
  name = group_id(ports)

  group = vpc.security_groups.filter('group-name', name).first

  if group.nil?
    group = create_group(vpc, ports)
  end

  group
end

#ensure_key_pair(region) ⇒ AWS::EC2::KeyPair

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the KeyPair for this host, creating it if needed

Parameters:

  • region (AWS::EC2::Region) —

    region to create the key pair in

Returns:

  • (AWS::EC2::KeyPair) —

    created key_pair



512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 512

def ensure_key_pair(region)
  @logger.notify("aws-sdk: Ensure key pair exists, create if not")
  key_pairs = region.key_pairs
  pair_name = key_name()
  kp = key_pairs[pair_name]
  unless kp.exists?
    ssh_string = public_key()
    kp = key_pairs.import(pair_name, ssh_string)
  end

  kp
end

#group_id(ports) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return a reproducable security group identifier based on input ports

Parameters:

  • ports (Array<Number>) —

    array of port numbers

Returns:

  • (String) —

    group identifier



530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 530

def group_id(ports)
  if ports.nil? or ports.empty?
    raise ArgumentError, "Ports list cannot be nil or empty"
  end

  unless ports.is_a? Set
    ports = Set.new(ports)
  end

  # Lolwut, #hash is inconsistent between ruby processes
  "Beaker-#{Zlib.crc32(ports.inspect)}"
end

#instance_by_id(id) ⇒ AWS::EC2::Instance

Provided an id return an instance object. Instance object will respond to methods described here: AWS Instance Object.

Parameters:

  • id (String) —

    The id of the instance to return

Returns:

  • (AWS::EC2::Instance) —

    An AWS::EC2 instance object



122
123
124
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 122

def instance_by_id(id)
  @ec2.instances[id]
end

#instances ⇒ Array<AWS::EC2::Instance>

Return all instances currently on ec2.

Returns:

  • (Array<AWS::EC2::Instance>) —

    An array of AWS::EC2 instance objects

See Also:



129
130
131
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 129

def instances
  @ec2.instances
end

#key_name ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Generate a reusable key name from the local hosts hostname

Returns:

  • (String) —

    safe key name for current host



494
495
496
497
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 494

def key_name
  safe_hostname = Socket.gethostname.gsub('.', '-')
  "Beaker-#{local_user}-#{safe_hostname}"
end

#kill_zombie_volumes ⇒ Object

Destroy any volumes marked ‘available’, INCLUDING THOSE YOU DON’T OWN! Use with care.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 197

def kill_zombie_volumes
  # Occasionaly, tearing down ec2 instances leaves orphaned EBS volumes behind -- these stack up quickly.
  # This simply looks for EBS volumes that are not in use
  # Note: don't use volumes.each here as that funtion doesn't allow proper rescue from error states
  @logger.notify("aws-sdk: Kill Zombie Volumes!")
  volume_count = 0
  @ec2.regions.each do |region|
    @logger.debug "Reviewing: #{region.name}"
    volumes = @ec2.regions[region.name].volumes.map { |vol| vol.id }
    volumes.each do |vol|
      begin
        vol = @ec2.regions[region.name].volumes[vol]
        if ( vol.status.to_s =~ /available/ )
          @logger.debug "Tear down available volume: #{vol.id}"
          vol.delete()
          volume_count += 1
        end
      rescue AWS::EC2::Errors::InvalidVolume::NotFound => e
        @logger.debug "Failed to remove volume: #{vol.id}, #{e}"
      end
    end
  end
  @logger.notify "Freed #{volume_count} volume(s)"

end

#kill_zombies(max_age = ZOMBIE, key = key_name) ⇒ Object

Shutdown and destroy ec2 instances idenfitied by key that have been alive longer than ZOMBIE hours.

Parameters:

  • max_age (Integer) (defaults to: ZOMBIE) —

    The age in hours that a machine needs to be older than to be considered a zombie

  • key (String) (defaults to: key_name) —

    The key_name to match for



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 168

def kill_zombies(max_age = ZOMBIE, key = key_name)
  @logger.notify("aws-sdk: Kill Zombies! (keyname: #{key}, age: #{max_age} hrs)")
  #examine all available regions
  kill_count = 0
  time_now = Time.now.getgm #ec2 uses GM time
  @ec2.regions.each do |region|
    @logger.debug "Reviewing: #{region.name}"
    # Note: don't use instances.each here as that funtion doesn't allow proper rescue from error states
    instances = @ec2.regions[region.name].instances
    instances.each do |instance|
      begin
        if (instance.key_name =~ /#{key}/)
          @logger.debug "Examining #{instance.id} (keyname: #{instance.key_name}, launch time: #{instance.launch_time}, status: #{instance.status})"
          if ((time_now - instance.launch_time) >  max_age*60*60) and instance.status.to_s !~ /terminated/
            @logger.debug "Kill! #{instance.id}: #{instance.key_name} (Current status: #{instance.status})"
            instance.terminate()
            kill_count += 1
          end
        end
      rescue AWS::Core::Resource::NotFound, AWS::EC2::Errors => e
        @logger.debug "Failed to remove instance: #{instance.id}, #{e}"
      end
    end
  end

  @logger.notify "#{key}: Killed #{kill_count} instance(s)"
end

#launch_all_nodes ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Launch all nodes

This is where the main launching work occurs for each node. Here we take care of feeding the information from the image required into the config for the new host, we perform the launch operation and ensure that the instance is properly tagged for identification.



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 232

def launch_all_nodes
  # Load the ec2_yaml spec file
  ami_spec = YAML.load_file(@options[:ec2_yaml])["AMI"]

  # Iterate across all hosts and launch them, adding tags along the way
  @logger.notify("aws-sdk: Iterate across all hosts in configuration and launch them")
  @hosts.each do |host|
    amitype = host['vmname'] || host['platform']
    amisize = host['amisize'] || 'm1.small'
    subnet_id = host['subnet_id'] || @options['subnet_id'] || nil
    vpc_id = host['vpc_id'] || @options['vpc_id'] || nil

    if vpc_id and !subnet_id
      raise RuntimeError, "A subnet_id must be provided with a vpc_id"
    end

    # Use snapshot provided for this host
    image_type = host['snapshot']
    if not image_type
      raise RuntimeError, "No snapshot/image_type provided for EC2 provisioning"
    end
    ami = ami_spec[amitype]
    ami_region = ami[:region]

    # Main region object for ec2 operations
    region = @ec2.regions[ami_region]

    # If we haven't defined a vpc_id then we use the default vpc for the provided region
    if !vpc_id
      @logger.notify("aws-sdk: filtering available vpcs in region by 'isDefault")
      filtered_vpcs = region.client.describe_vpcs(:filters => [{:name => 'isDefault', :values => ['true']}])
      if !filtered_vpcs[:vpc_set].empty?
        vpc_id = filtered_vpcs[:vpc_set].first[:vpc_id]
      else #there's no default vpc, use nil
        vpc_id = nil
      end
    end

    # Grab the vpc object based upon provided id
    vpc = vpc_id ? region.vpcs[vpc_id] : nil

    # Grab image object
    image_id = ami[:image][image_type.to_sym]
    @logger.notify("aws-sdk: Checking image #{image_id} exists and getting its root device")
    image = region.images[image_id]
    if image.nil? and not image.exists?
      raise RuntimeError, "Image not found: #{image_id}"
    end

    # Transform the images block_device_mappings output into a format
    # ready for a create.
    orig_bdm = image.block_device_mappings()
    @logger.notify("aws-sdk: Image block_device_mappings: #{orig_bdm.to_hash}")
    block_device_mappings = []
    orig_bdm.each do |device_name, rest|
      block_device_mappings << {
        :device_name => device_name,
        :ebs => {
          # Change the default size of the root volume.
          :volume_size => host['volume_size'] || rest[:volume_size],
          # This is required to override the images default for
          # delete_on_termination, forcing all volumes to be deleted once the
          # instance is terminated.
          :delete_on_termination => true,
        }
      }
    end

    security_group = ensure_group(vpc || region, Beaker::EC2Helper.amiports(host))

    # Launch the node, filling in the blanks from previous work.
    @logger.notify("aws-sdk: Launch instance")
    config = {
      :count => 1,
      :image_id => image_id,
      :monitoring_enabled => true,
      :key_pair => ensure_key_pair(region),
      :security_groups => [security_group],
      :instance_type => amisize,
      :disable_api_termination => false,
      :instance_initiated_shutdown_behavior => "terminate",
      :block_device_mappings => block_device_mappings,
      :subnet => subnet_id,
    }
    instance = region.instances.create(config)

    # Persist the instance object for this host, so later it can be
    # manipulated by 'cleanup' for example.
    host['instance'] = instance

    @logger.notify("aws-sdk: Launched #{host.name} (#{amitype}:#{amisize}) using snapshot/image_type #{image_type}")
  end

  nil
end

#load_fog_credentials(dot_fog = '.fog') ⇒ Hash<Symbol, String>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return a hash containing the fog credentials for EC2

Parameters:

  • dot_fog (String) (defaults to: '.fog') —

    dot fog path

Returns:

  • (Hash<Symbol, String>) —

    ec2 credentials



594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 594

def load_fog_credentials(dot_fog = '.fog')
  fog = YAML.load_file( dot_fog )

  default = fog[:default]

  creds = {}
  creds[:access_key] = default[:aws_access_key_id]
  creds[:secret_key] = default[:aws_secret_access_key]
  raise "You must specify an aws_access_key_id in your .fog file (#{dot_fog}) for ec2 instances!" unless creds[:access_key]
  raise "You must specify an aws_secret_access_key in your .fog file (#{dot_fog}) for ec2 instances!" unless creds[:secret_key]

  creds
end

#local_user ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the local user running this tool

Returns:

  • (String) —

    username of local user



503
504
505
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 503

def local_user
  ENV['USER']
end

#log_instances(key = key_name, status = /running/) ⇒ Object

Print instances to the logger. Instances will be from all regions associated with provided key name and limited by regex compared to instance status. Defaults to running instances.

Parameters:

  • key (String) (defaults to: key_name) —

    The key_name to match for

  • status (Regex) (defaults to: /running/) —

    The regular expression to match against the instance’s status



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 100

def log_instances(key = key_name, status = /running/)
  instances = []
  @ec2.regions.each do |region|
    @logger.debug "Reviewing: #{region.name}"
    @ec2.regions[region.name].instances.each do |instance|
      if (instance.key_name =~ /#{key}/) and (instance.status.to_s =~ status)
        instances << instance
      end
    end
  end
  output = ""
  instances.each do |instance|
    output << "#{instance.id} keyname: #{instance.key_name}, dns name: #{instance.dns_name}, private ip: #{instance.private_ip_address}, ip: #{instance.ip_address}, launch time #{instance.launch_time}, status: #{instance.status}\n"
  end
  @logger.notify("aws-sdk: List instances (keyname: #{key})")
  @logger.notify("#{output}")
end

#populate_dns ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Populate the hosts IP address from the EC2 dns_name



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 387

def populate_dns
  # Obtain the IP addresses and dns_name for each host
  @hosts.each do |host|
    @logger.notify("aws-sdk: Populate DNS for #{host.name}")
    instance = host['instance']
    host['ip'] = instance.ip_address
    host['private_ip'] = instance.private_ip_address
    host['dns_name'] = instance.dns_name
    @logger.notify("aws-sdk: name: #{host.name} ip: #{host['ip']} private_ip: #{host['private_ip']} dns_name: #{instance.dns_name}")
  end

  nil
end

#provision ⇒ void

This method returns an undefined value.

Provision all hosts on EC2 using the AWS::EC2 API



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 43

def provision
  start_time = Time.now

  # Perform the main launch work
  launch_all_nodes()

  # Wait for each node to reach status :running
  wait_for_status(:running)

  # Add metadata tags to each instance
  add_tags()

  # Grab the ip addresses and dns from EC2 for each instance to use for ssh
  populate_dns()

  #enable root if user is not root
  enable_root_on_hosts()

  # Set the hostname for each box
  set_hostnames()

  # Configure /etc/hosts on each host
  configure_hosts()

  @logger.notify("aws-sdk: Provisioning complete in #{Time.now - start_time} seconds")

  nil #void
end

#public_key ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Retrieve the public key locally from the executing users ~/.ssh directory

Returns:

  • (String) —

    contents of public key



478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 478

def public_key
  filename = File.expand_path('~/.ssh/id_rsa.pub')
  unless File.exists? filename
    filename = File.expand_path('~/.ssh/id_dsa.pub')
    unless File.exists? filename
      raise RuntimeError, 'Expected either ~/.ssh/id_rsa.pub or ~/.ssh/id_dsa.pub but found neither'
    end
  end

  File.read(filename)
end

#security_group_by_id(id) ⇒ AWS::EC2::SecurityGroup

Provided an id return a security group object Security object will respond to methods described here: AWS SecurityGroup Object.

Parameters:

  • id (String) —

    The id of the security group to return

Returns:

  • (AWS::EC2::SecurityGroup) —

    An AWS::EC2 security group object



152
153
154
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 152

def security_group_by_id(id)
  @ec2.security_groups[id]
end

#security_groups ⇒ Array<AWS::EC2::SecurityGroup>

Return all security groups currently on ec2.

Returns:

  • (Array<AWS::EC2::SecurityGroup>) —

    An array of AWS::EC2 security group objects

See Also:

  • AwsSdk#security_goup_by_id


159
160
161
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 159

def security_groups
  @ec2.security_groups
end

#set_hostnames ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Set the hostname of all instances to be the hostname defined in the beaker configuration.



453
454
455
456
457
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 453

def set_hostnames
  @hosts.each do |host|
    host.exec(Command.new("hostname #{host.name}"))
  end
end

#vpc_by_id(id) ⇒ AWS::EC2::VPC

Provided an id return a VPC object. VPC object will respond to methods described here: AWS VPC Object.

Parameters:

  • id (String) —

    The id of the VPC to return

Returns:

  • (AWS::EC2::VPC) —

    An AWS::EC2 vpc object



137
138
139
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 137

def vpc_by_id(id)
  @ec2.vpcs[id]
end

#vpcs ⇒ Array<AWS::EC2::VPC>

Return all VPCs currently on ec2.

Returns:

  • (Array<AWS::EC2::VPC>) —

    An array of AWS::EC2 vpc objects

See Also:



144
145
146
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 144

def vpcs
  @ec2.vpcs
end

#wait_for_status(status) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Waits until all boxes reach the desired status

Parameters:

  • status (Symbol) —

    EC2 state to wait for, :running :stopped etc.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/beaker/hypervisor/aws_sdk.rb', line 333

def wait_for_status(status)
  # Wait for each node to reach status :running
  @logger.notify("aws-sdk: Now wait for all hosts to reach state #{status}")
  @hosts.each do |host|
    instance = host['instance']
    name = host.name

    @logger.notify("aws-sdk: Wait for status #{status} for node #{name}")

    # Here we keep waiting for the machine state to reach ':running' with an
    # exponential backoff for each poll.
    # TODO: should probably be a in a shared method somewhere
    for tries in 1..10
      begin
        if instance.status == status
          # Always sleep, so the next command won't cause a throttle
          backoff_sleep(tries)
          break
        elsif tries == 10
          raise "Instance never reached state #{status}"
        end
      rescue AWS::EC2::Errors::InvalidInstanceID::NotFound => e
        @logger.debug("Instance #{name} not yet available (#{e})")
      end
      backoff_sleep(tries)
    end

  end
end