Class: Chef::Provisioning::AWSDriver::Driver

Inherits:
Driver
  • Object
show all
Includes:
Mixin::DeepMerge, Mixin::ShellOut
Defined in:
lib/chef/provisioning/aws_driver/driver.rb

Overview

Provisions machines using the AWS SDK

Constant Summary collapse

PORT_DEFAULTS = 
{
  :http => 80,
  :https => 443,
}
PROTOCOL_DEFAULTS = 
{
  25 => :tcp,
  80 => :http,
  443 => :https,
  465 => :ssl,
  587 => :tcp,
}
@@chef_default_lock =

For creating things like AWS keypairs exclusively

Mutex.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(driver_url, config) ⇒ Driver

Returns a new instance of Driver.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 103

def initialize(driver_url, config)
  super

  _, profile_name, region = driver_url.split(':')
  profile_name = nil if profile_name && profile_name.empty?
  region = nil if region && region.empty?

  credentials = profile_name ? aws_credentials[profile_name] : aws_credentials.default
  @aws_config = AWS.config(
    access_key_id:     credentials[:aws_access_key_id],
    secret_access_key: credentials[:aws_secret_access_key],
    region: region || credentials[:region],
    proxy_uri: credentials[:proxy_uri] || nil,
    session_token: credentials[:aws_session_token] || nil,
    logger: Chef::Log.logger
  )

  # TODO document how users could add something to the Aws.config themselves if they want to
  # Right now we are supporting both V1 and V2, so we create 2 config sets
  credentials2 = Credentials2.new(:profile_name => profile_name)
  Chef::Config.chef_provisioning ||= {}
  @aws_config_2 = {
    credentials: credentials2.get_credentials,
    region: region || ENV["AWS_DEFAULT_REGION"] || credentials[:region],
    # TODO when we get rid of V1 replace the credentials class with something that knows how
    # to read ~/.aws/config
    :http_proxy => credentials[:proxy_uri] || nil,
    logger: Chef::Log.logger,
    retry_limit: Chef::Config.chef_provisioning[:aws_retry_limit] || 5
  }

  driver = self
  Chef::Resource::Machine.send(:define_method, :aws_object) do
    resource = Chef::Resource::AwsInstance.new(name, nil)
    resource.driver driver
    resource.managed_entry_store Chef::Provisioning.chef_managed_entry_store
    resource.aws_object
  end
  Chef::Resource::MachineImage.send(:define_method, :aws_object) do
    resource = Chef::Resource::AwsImage.new(name, nil)
    resource.driver driver
    resource.managed_entry_store Chef::Provisioning.chef_managed_entry_store
    resource.aws_object
  end
  Chef::Resource::LoadBalancer.send(:define_method, :aws_object) do
    resource = Chef::Resource::AwsLoadBalancer.new(name, nil)
    resource.driver driver
    resource.managed_entry_store Chef::Provisioning.chef_managed_entry_store
    resource.aws_object
  end
end

Instance Attribute Details

#aws_config ⇒ Object (readonly)

Returns the value of attribute aws_config.



93
94
95
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 93

def aws_config
  @aws_config
end

#aws_config_2 ⇒ Object (readonly)

Returns the value of attribute aws_config_2.



93
94
95
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 93

def aws_config_2
  @aws_config_2
end

Class Method Details

.canonicalize_url(driver_url, config) ⇒ Object 



155
156
157
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 155

def self.canonicalize_url(driver_url, config)
  [ driver_url, config ]
end

.from_url(driver_url, config) ⇒ Object

URL scheme: aws:profilename:region TODO: migration path from fog:AWS - parse that URL canonical URL calls realpath on <path>



99
100
101
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 99

def self.from_url(driver_url, config)
  Driver.new(driver_url, config)
end

Instance Method Details

#account_id ⇒ Object 



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 712

def 
  begin
    # We've got an AWS account root credential or an IAM admin with access rights
    current_user = iam.client.get_user
    arn = current_user[:user][:arn]
  rescue AWS::IAM::Errors::AccessDenied => e
    # If we don't have access, the error message still tells us our account ID and user ...
    # https://forums.aws.amazon.com/thread.jspa?messageID=394344
    if e.to_s !~ /\b(arn:aws:iam::[0-9]{12}:\S*)/
      raise "IAM error response for GetUser did not include user ARN.  Can't retrieve account ID."
    end
    arn = $1
  end
  parse_arn(arn)[:account_id]
end

#allocate_image(action_handler, image_spec, image_options, machine_spec, machine_options) ⇒ Object

Image methods



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 476

def allocate_image(action_handler, image_spec, image_options, machine_spec, machine_options)
  actual_image = image_for(image_spec)
  image_options = (image_options || {}).to_h.dup
  machine_options = (machine_options || {}).to_h.dup
  aws_tags = image_options.delete(:aws_tags) || {}
  if actual_image.nil? || !actual_image.exists? || actual_image.state == :failed
    action_handler.perform_action "Create image #{image_spec.name} from machine #{machine_spec.name} with options #{image_options.inspect}" do
      image_options[:name] ||= image_spec.name
      image_options[:instance_id] ||= machine_spec.reference['instance_id']
      image_options[:description] ||= "Image #{image_spec.name} created from machine #{machine_spec.name}"
      Chef::Log.debug "AWS Image options: #{image_options.inspect}"
      actual_image = ec2.images.create(image_options.to_hash)
      image_spec.reference = {
        'driver_version' => Chef::Provisioning::AWSDriver::VERSION,
        'image_id' => actual_image.id,
        'allocated_at' => Time.now.to_i,
        'from-instance' => image_options[:instance_id]
      }
      image_spec.driver_url = driver_url
    end
  end
  aws_tags['from-instance'] = image_options[:instance_id] if image_options[:instance_id]
  converge_ec2_tags(actual_image, aws_tags, action_handler)
end

#allocate_load_balancer(action_handler, lb_spec, lb_options, machine_specs) ⇒ Object

Load balancer methods



160
161
162
163
164
165
166
167
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
195
196
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
222
223
224
225
226
227
228
229
230
231
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
327
328
329
330
331
332
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 160

def allocate_load_balancer(action_handler, lb_spec, lb_options, machine_specs)
  lb_options = (lb_options || {}).to_h
  lb_options = AWSResource.lookup_options(lb_options, managed_entry_store: lb_spec.managed_entry_store, driver: self)
  # We delete the attributes and a health check here because they are not valid in the create call
  # and must be applied afterward
  lb_attributes = lb_options.delete(:attributes)
  lb_aws_tags = lb_options.delete(:aws_tags)
  health_check  = lb_options.delete(:health_check)

  old_elb = nil
  actual_elb = load_balancer_for(lb_spec)
  if !actual_elb || !actual_elb.exists?
    lb_options[:listeners] ||= get_listeners(:http)
    if !lb_options[:subnets] && !lb_options[:availability_zones] && machine_specs
      lb_options[:subnets] = machine_specs.map { |s| ec2.instances[s.reference['instance_id']].subnet }.uniq
    end

    perform_action = proc { |desc, &block| action_handler.perform_action(desc, &block) }
    Chef::Log.debug "AWS Load Balancer options: #{lb_options.inspect}"

    updates = [ "create load balancer #{lb_spec.name} in #{aws_config.region}" ]
    updates << "  enable availability zones #{lb_options[:availability_zones]}" if lb_options[:availability_zones]
    updates << "  attach subnets #{lb_options[:subnets].join(', ')}" if lb_options[:subnets]
    updates << "  with listeners #{lb_options[:listeners]}" if lb_options[:listeners]
    updates << "  with security groups #{lb_options[:security_groups]}" if lb_options[:security_groups]
    updates << "  with tags #{lb_options[:aws_tags]}" if lb_options[:aws_tags]

    action_handler.perform_action updates do
      # IAM says the server certificate exists, but ELB throws this error
      Chef::Provisioning::AWSDriver::AWSProvider.retry_with_backoff(AWS::ELB::Errors::CertificateNotFound) do
        actual_elb = elb.load_balancers.create(lb_spec.name, lb_options)
      end

      lb_spec.reference = {
        'driver_version' => Chef::Provisioning::AWSDriver::VERSION,
        'allocated_at' => Time.now.utc.to_s,
      }
      lb_spec.driver_url = driver_url
    end
  else
    # Header gets printed the first time we make an update
    perform_action = proc do |desc, &block|
      perform_action = proc { |desc, &block| action_handler.perform_action(desc, &block) }
      action_handler.perform_action [ "Update load balancer #{lb_spec.name} in #{aws_config.region}", desc ].flatten, &block
    end

    # TODO: refactor this whole giant method into many smaller method calls
    if lb_options[:scheme] && lb_options[:scheme].downcase != actual_elb.scheme
      # TODO CloudFormation automatically recreates the load_balancer, we should too
      raise "Scheme is immutable - you need to :destroy and :create the load_balancer to recreated it with the new scheme"
    end

    # Update security groups
    if lb_options[:security_groups]
      current = actual_elb.security_group_ids
      desired = lb_options[:security_groups]
      if current != desired
        perform_action.call("  updating security groups to #{desired.to_a}") do
          elb.client.apply_security_groups_to_load_balancer(
            load_balancer_name: actual_elb.name,
            security_groups: desired.to_a
          )
        end
      end
    end

    if lb_options[:availability_zones] || lb_options[:subnets]
      # A subnet always belongs to an availability zone.  When specifying a ELB spec, you can either
      # specify subnets OR AZs but not both.  You cannot specify multiple subnets in the same AZ.
      # You must specify at least 1 subnet or AZ.  On an update you cannot remove all subnets
      # or AZs - it must belong to one.
      if lb_options[:availability_zones] && lb_options[:subnets]
        # We do this check here because there is no atomic call we can make to specify both
        # subnets and AZs at the same time
        raise "You cannot specify both `availability_zones` and `subnets`"
      end

      # Users can switch from availability zones to subnets or vice versa.  To ensure we do not
      # unassign all (which causes an AWS error) we first add all available ones, then remove
      # an unecessary ones
      actual_zones_subnets = {}
      actual_elb.subnets.each do |subnet|
        actual_zones_subnets[subnet.id] = subnet.availability_zone.name
      end

      # Only 1 of subnet or AZ will be populated b/c of our check earlier
      desired_subnets_zones = {}
      if lb_options[:availability_zones]
        lb_options[:availability_zones].each do |zone|
          # If the user specifies availability zone, we find the default subnet for that
          # AZ because this duplicates the create logic
          zone = zone.downcase
          filters = [
            {:name => 'availabilityZone', :values => [zone]},
            {:name => 'defaultForAz', :values => ['true']}
          ]
          default_subnet = ec2.client.describe_subnets(:filters => filters)[:subnet_set]
          if default_subnet.size != 1
            raise "Could not find default subnet in availability zone #{zone}"
          end
          default_subnet = default_subnet[0]
          desired_subnets_zones[default_subnet[:subnet_id]] = zone
        end
      end
      unless lb_options[:subnets].nil? || lb_options[:subnets].empty?
        subnet_query = ec2.client.describe_subnets(:subnet_ids => lb_options[:subnets])[:subnet_set]
        # AWS raises an error on an unknown subnet, but not an unknown AZ
        subnet_query.each do |subnet|
          zone = subnet[:availability_zone].downcase
          desired_subnets_zones[subnet[:subnet_id]] = zone
        end
      end

      # We only bother attaching subnets, because doing this automatically attaches the AZ
      attach_subnets = desired_subnets_zones.keys - actual_zones_subnets.keys
      unless attach_subnets.empty?
        action = "  attach subnets #{attach_subnets.join(', ')}"
        enable_zones = (desired_subnets_zones.map {|s,z| z if attach_subnets.include?(s)}).compact
        action += " (availability zones #{enable_zones.join(', ')})"
        perform_action.call(action) do
          begin
            elb.client.attach_load_balancer_to_subnets(
              load_balancer_name: actual_elb.name,
              subnets: attach_subnets
            )
          rescue AWS::ELB::Errors::InvalidConfigurationRequest => e
            Chef::Log.error "You cannot currently move from 1 subnet to another in the same availability zone. " +
                "Amazon does not have an atomic operation which allows this.  You must create a new " +
                "ELB with the correct subnets and move instances into it.  Tried to attach subets " +
                "#{attach_subnets.join(', ')} (availability zones #{enable_zones.join(', ')}) to " +
                "existing ELB named #{actual_elb.name}"
            raise e
          end
        end
      end

      detach_subnets = actual_zones_subnets.keys - desired_subnets_zones.keys
      unless detach_subnets.empty?
        action = "  detach subnets #{detach_subnets.join(', ')}"
        disable_zones = (actual_zones_subnets.map {|s,z| z if detach_subnets.include?(s)}).compact
        action += " (availability zones #{disable_zones.join(', ')})"
        perform_action.call(action) do
          elb.client.detach_load_balancer_from_subnets(
            load_balancer_name: actual_elb.name,
            subnets: detach_subnets
          )
        end
      end
    end

    # Update listeners - THIS IS NOT ATOMIC
    if lb_options[:listeners]
      add_listeners = {}
      lb_options[:listeners].each { |l| add_listeners[l[:port]] = l }
      actual_elb.listeners.each do |listener|
        desired_listener = add_listeners.delete(listener.port)
        if desired_listener

          # listener.(port|protocol|instance_port|instance_protocol) are immutable for the life
          # of the listener - must create a new one and delete old one
          immutable_updates = []
          if listener.protocol != desired_listener[:protocol].to_sym.downcase
            immutable_updates << "    update protocol from #{listener.protocol.inspect} to #{desired_listener[:protocol].inspect}"
          end
          if listener.instance_port != desired_listener[:instance_port]
            immutable_updates << "    update instance port from #{listener.instance_port.inspect} to #{desired_listener[:instance_port].inspect}"
          end
          if listener.instance_protocol != desired_listener[:instance_protocol].to_sym.downcase
            immutable_updates << "    update instance protocol from #{listener.instance_protocol.inspect} to #{desired_listener[:instance_protocol].inspect}"
          end
          if !immutable_updates.empty?
            perform_action.call(immutable_updates) do
              listener.delete
              actual_elb.listeners.create(desired_listener)
            end
          elsif ! server_certificate_eql?(listener.server_certificate,
                                          server_cert_from_spec(desired_listener))
            # Server certificate is mutable - if no immutable changes required a full recreate, update cert
            perform_action.call("    update server certificate from #{listener.server_certificate} to #{desired_listener[:server_certificate]}") do
              listener.server_certificate = desired_listener[:server_certificate]
            end
          end

        else
          perform_action.call("  remove listener #{listener.port}") do
            listener.delete
          end
        end
      end
      add_listeners.values.each do |listener|
        updates = [ "  add listener #{listener[:port]}" ]
        updates << "    set protocol to #{listener[:protocol].inspect}"
        updates << "    set instance port to #{listener[:instance_port].inspect}"
        updates << "    set instance protocol to #{listener[:instance_protocol].inspect}"
        updates << "    set server certificate to #{listener[:server_certificate]}" if listener[:server_certificate]
        perform_action.call(updates) do
          actual_elb.listeners.create(listener)
        end
      end
    end
  end

  converge_elb_tags(actual_elb, lb_aws_tags, action_handler)

  # Update load balancer attributes
  if lb_attributes
    current = elb.client.describe_load_balancer_attributes(load_balancer_name: actual_elb.name)[:load_balancer_attributes]
    # Need to do a deep copy w/ Marshal load/dump to avoid overwriting current
    desired = deep_merge!(lb_attributes, Marshal.load(Marshal.dump(current)))
    if current != desired
      perform_action.call("  updating attributes to #{desired.inspect}") do
        elb.client.modify_load_balancer_attributes(
          load_balancer_name: actual_elb.name,
          load_balancer_attributes: desired.to_hash
        )
      end
    end
  end

  # Update the load balancer health check, as above
  if health_check
    current = elb.client.describe_load_balancers(load_balancer_names: [actual_elb.name])[:load_balancer_descriptions][0][:health_check]
    desired = deep_merge!(health_check, Marshal.load(Marshal.dump(current)))
    if current != desired
      perform_action.call("  updating health check to #{desired.inspect}") do
        elb.client.configure_health_check(
          load_balancer_name: actual_elb.name,
          health_check: desired.to_hash
        )
      end
    end
  end

  # Update instance list, but only if there are machines specified
  if machine_specs
    assigned_instance_ids = actual_elb.instances.map { |i| i.instance_id }

    instances_to_add = machine_specs.select { |s| !assigned_instance_ids.include?(s.reference['instance_id']) }
    instance_ids_to_remove = assigned_instance_ids - machine_specs.map { |s| s.reference['instance_id'] }

    if instances_to_add.size > 0
      perform_action.call("  add machines #{instances_to_add.map { |s| s.name }.join(', ')}") do
        instance_ids_to_add = instances_to_add.map { |s| s.reference['instance_id'] }
        Chef::Log.debug("Adding instances #{instance_ids_to_add.join(', ')} to load balancer #{actual_elb.name} in region #{aws_config.region}")
        actual_elb.instances.add(instance_ids_to_add)
      end
    end

    if instance_ids_to_remove.size > 0
      perform_action.call("  remove instances #{instance_ids_to_remove}") do
        actual_elb.instances.remove(instance_ids_to_remove)
      end
    end
  end

  # We have successfully switched all our instances to the (possibly) new LB
  # so it is safe to delete the old one.
  unless old_elb.nil?
    old_elb.delete
  end
ensure
  # Something went wrong before we could moved instances from the old ELB to the new one
  # Don't delete the old ELB, but warn users there could now be 2 ELBs with the same name
  unless old_elb.nil?
    Chef::Log.warn("It is possible there are now 2 ELB instances - #{old_elb.name} and #{actual_elb.name}. " +
    "Determine which is correct and manually clean up the other.")
  end
end

#allocate_machine(action_handler, machine_spec, machine_options) ⇒ Object

Machine methods



549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 549

def allocate_machine(action_handler, machine_spec, machine_options)
  instance = instance_for(machine_spec)
  bootstrap_options = bootstrap_options_for(action_handler, machine_spec, machine_options)

  if instance == nil || !instance.exists? || instance.state.name == "terminated"
    action_handler.perform_action "Create #{machine_spec.name} with AMI #{bootstrap_options[:image_id]} in #{aws_config.region}" do
      Chef::Log.debug "Creating instance with bootstrap options #{bootstrap_options}"
      instance = create_instance_and_reference(bootstrap_options, action_handler, machine_spec, machine_options)
    end
  end
  converge_ec2_tags(instance, machine_options[:aws_tags], action_handler)
end

#allocate_machines(action_handler, specs_and_options, parallelizer) ⇒ Object 



562
563
564
565
566
567
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 562

def allocate_machines(action_handler, specs_and_options, parallelizer)
  create_servers(action_handler, specs_and_options, parallelizer) do |machine_spec, server|
    yield machine_spec
  end
  specs_and_options.keys
end

#auto_scaling ⇒ Object 



693
694
695
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 693

def auto_scaling
  @auto_scaling ||= AWS::AutoScaling.new(config: aws_config)
end

#aws_credentials ⇒ Object 



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 861

def aws_credentials
  # Grab the list of possible credentials
  @aws_credentials ||= if driver_options[:aws_credentials]
                         driver_options[:aws_credentials]
                       else
                         credentials = Credentials.new
                         if driver_options[:aws_config_file]
                           credentials.load_ini(driver_options[:aws_config_file])
                         elsif driver_options[:aws_csv_file]
                           credentials.load_csv(driver_options[:aws_csv_file])
                         else
                           credentials.load_default
                         end
                         credentials
                       end
end

#bootstrap_options_for(action_handler, machine_spec, machine_options) ⇒ Object 



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 745

def bootstrap_options_for(action_handler, machine_spec, machine_options)
  bootstrap_options = (machine_options[:bootstrap_options] || {}).to_h.dup
  # These are hardcoded for now - only 1 machine at a time
  bootstrap_options[:min_count] = bootstrap_options[:max_count] = 1
  bootstrap_options[:instance_type] ||= default_instance_type
  image_id = machine_options[:from_image] || bootstrap_options[:image_id] || machine_options[:image_id] || default_ami_for_region(aws_config.region)
  bootstrap_options[:image_id] = image_id
  bootstrap_options.delete(:key_path)
  if !bootstrap_options[:key_name]
    Chef::Log.debug('No key specified, generating a default one...')
    bootstrap_options[:key_name] = default_aws_keypair(action_handler, machine_spec)
  end
  if bootstrap_options[:user_data]
    bootstrap_options[:user_data] = Base64.encode64(bootstrap_options[:user_data])
  end

  # V1 -> V2 backwards compatability support
  unless bootstrap_options.fetch(:monitoring_enabled, nil).nil?
    bootstrap_options[:monitoring] = {enabled: bootstrap_options.delete(:monitoring_enabled)}
  end
  placement = {}
  if bootstrap_options[:availability_zone]
    placement[:availability_zone] = bootstrap_options.delete(:availability_zone)
  end
  if bootstrap_options[:placement_group]
    placement[:group_name] = bootstrap_options.delete(:placement_group)
  end
  unless bootstrap_options.fetch(:dedicated_tenancy, nil).nil?
    placement[:tenancy] = bootstrap_options.delete(:dedicated_tenancy) ? "dedicated" : "default"
  end
  unless placement.empty?
    bootstrap_options[:placement] = placement
  end
  if bootstrap_options[:subnet]
    bootstrap_options[:subnet_id] = bootstrap_options.delete(:subnet)
  end
  if bootstrap_options[:iam_instance_profile] && bootstrap_options[:iam_instance_profile].is_a?(String)
    bootstrap_options[:iam_instance_profile] = {name: bootstrap_options[:iam_instance_profile]}
  end

  bootstrap_options = AWSResource.lookup_options(bootstrap_options, managed_entry_store: machine_spec.managed_entry_store, driver: self)

  # In the migration from V1 to V2 we still support associate_public_ip_address at the top level
  # we do this after the lookup because we have to copy any present subnets, etc. into the
  # network interfaces block
  unless bootstrap_options.fetch(:associate_public_ip_address, nil).nil?
    if bootstrap_options[:network_interfaces]
      raise "If you specify network_interfaces you must specify associate_public_ip_address in that list"
    end
    network_interface = {
      :device_index => 0,
      :associate_public_ip_address => bootstrap_options.delete(:associate_public_ip_address),
      :delete_on_termination => true
    }
    if bootstrap_options[:subnet_id]
      network_interface[:subnet_id] = bootstrap_options.delete(:subnet_id)
    end
    if bootstrap_options[:private_ip_address]
      network_interface[:private_ip_address] = bootstrap_options.delete(:private_ip_address)
    end
    if bootstrap_options[:security_group_ids]
      network_interface[:groups] = bootstrap_options.delete(:security_group_ids)
    end
    bootstrap_options[:network_interfaces] = [network_interface]
  end

  Chef::Log.debug "AWS Bootstrap options: #{bootstrap_options.inspect}"
  bootstrap_options
end

#build_arn(partition: 'aws', service: nil, region: aws_config.region, account_id: self.account_id, resource: nil) ⇒ Object 



697
698
699
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 697

def build_arn(partition: 'aws', service: nil, region: aws_config.region, account_id: self., resource: nil)
  "arn:#{partition}:#{service}:#{region}:#{}:#{resource}"
end

#cloudsearch(api_version = "20130101") ⇒ Object 



641
642
643
644
645
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 641

def cloudsearch(api_version="20130101")
  @cloudsearch ||= {}
  @cloudsearch[api_version] ||= AWS::CloudSearch::Client.const_get("V#{api_version}").new
  @cloudsearch[api_version]
end

#connect_to_machine(name, chef_server = nil) ⇒ Object 



604
605
606
607
608
609
610
611
612
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 604

def connect_to_machine(name, chef_server = nil)
  if name.is_a?(MachineSpec)
    machine_spec = name
  else
    machine_spec = Chef::Provisioning::ChefMachineSpec.get(name, chef_server)
  end

  machine_for(machine_spec, machine_spec.reference)
end

#converge_ec2_tags(aws_object, tags, action_handler) ⇒ Object 



1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1199

def converge_ec2_tags(aws_object, tags, action_handler)
  ec2_strategy = Chef::Provisioning::AWSDriver::TaggingStrategy::EC2.new(
    ec2_client,
    aws_object.id,
    tags
  )
  aws_tagger = Chef::Provisioning::AWSDriver::AWSTagger.new(ec2_strategy, action_handler)
  aws_tagger.converge_tags
end

#converge_elb_tags(aws_object, tags, action_handler) ⇒ Object 



1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1209

def converge_elb_tags(aws_object, tags, action_handler)
  elb_strategy = Chef::Provisioning::AWSDriver::TaggingStrategy::ELB.new(
    elb_client,
    aws_object.name,
    tags
  )
  aws_tagger = Chef::Provisioning::AWSDriver::AWSTagger.new(elb_strategy, action_handler)
  aws_tagger.converge_tags
end

#convergence_strategy_for(machine_spec, machine_options) ⇒ Object 



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1022

def convergence_strategy_for(machine_spec, machine_options)
  # Tell Ohai that this is an EC2 instance so that it runs the EC2 plugin
  convergence_options = Cheffish::MergedConfig.new(
    machine_options[:convergence_options] || {},
    ohai_hints: { 'ec2' => '' })

  # Defaults
  if !machine_spec.reference
    return Chef::Provisioning::ConvergenceStrategy::NoConverge.new(convergence_options, config)
  end

  if machine_spec.reference['is_windows']
    Chef::Provisioning::ConvergenceStrategy::InstallMsi.new(convergence_options, config)
  elsif machine_options[:cached_installer] == true
    Chef::Provisioning::ConvergenceStrategy::InstallCached.new(convergence_options, config)
  else
    Chef::Provisioning::ConvergenceStrategy::InstallSh.new(convergence_options, config)
  end
end

#create_instance_and_reference(bootstrap_options, action_handler, machine_spec, machine_options) ⇒ Object 



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1219

def create_instance_and_reference(bootstrap_options, action_handler, machine_spec, machine_options)
  instance = nil
  # IAM says the instance profile is ready, but EC2 doesn't think it is
  # Not using retry_with_backoff here because we need to match on a string
  Retryable.retryable(
    :tries => 10,
    :sleep => lambda { |n| [2**n, 16].min },
    :on => ::Aws::EC2::Errors::InvalidParameterValue,
    :matching => /Invalid IAM Instance Profile name/
  ) do |retries, exception|
    Chef::Log.debug("Instance creation InvalidParameterValue exception is #{exception.inspect}")
    instance = ec2_resource.create_instances(bootstrap_options.to_hash)[0]
  end

  # Make sure the instance is ready to be tagged
  instance.wait_until_exists

  # Sometimes tagging fails even though the instance 'exists'
  Chef::Provisioning::AWSDriver::AWSProvider.retry_with_backoff(::Aws::EC2::Errors::InvalidInstanceIDNotFound) do
    instance.create_tags({tags: [{key: "Name", value: machine_spec.name}]})
  end
  if machine_options.has_key?(:source_dest_check)
    instance.modify_attribute({
      source_dest_check: {
        value: machine_options[:source_dest_check]
      }
    })
  end
  machine_spec.reference = {
      'driver_version' => Chef::Provisioning::AWSDriver::VERSION,
      'allocated_at' => Time.now.utc.to_s,
      'host_node' => action_handler.host_node,
      'image_id' => bootstrap_options[:image_id],
      'instance_id' => instance.id
  }
  machine_spec.driver_url = driver_url
  machine_spec.reference['key_name'] = bootstrap_options[:key_name] if bootstrap_options[:key_name]
  # TODO 2.0 We no longer support `use_private_ip_for_ssh`, only `transport_address_location`
  if machine_options[:use_private_ip_for_ssh]
    unless @transport_address_location_warned
      Chef::Log.warn("The machine_option ':use_private_ip_for_ssh' has been deprecated, use ':transport_address_location'")
      @transport_address_location_warned = true
    end
    machine_options = Cheffish::MergedConfig.new(machine_options, {:transport_address_location => :private_ip})
  end
  %w(is_windows winrm_username winrm_port winrm_password ssh_username sudo transport_address_location ssh_gateway).each do |key|
    machine_spec.reference[key] = machine_options[key.to_sym] if machine_options[key.to_sym]
  end
  instance
end

#create_servers(action_handler, specs_and_options, parallelizer) ⇒ Object 



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1140

def create_servers(action_handler, specs_and_options, parallelizer)
  specs_and_servers = instances_for(specs_and_options.keys)

  by_bootstrap_options = {}
  specs_and_options.each do |machine_spec, machine_options|
    instance = specs_and_servers[machine_spec]
    if instance
      if instance.state.name == "terminated"
        Chef::Log.warn "Machine #{machine_spec.name} (#{instance.id}) is terminated.  Recreating ..."
      else
        # Even though the instance has been created the tags could be incorrect if it
        # was created before tags were introduced
        converge_ec2_tags(instance, machine_options[:aws_tags], action_handler)
        yield machine_spec, instance if block_given?
        next
      end
    elsif machine_spec.reference
      Chef::Log.warn "Machine #{machine_spec.name} (#{machine_spec.reference['instance_id']} on #{driver_url}) no longer exists.  Recreating ..."
    end

    bootstrap_options = bootstrap_options_for(action_handler, machine_spec, machine_options)
    by_bootstrap_options[bootstrap_options] ||= []
    by_bootstrap_options[bootstrap_options] << machine_spec
  end

  # Create the servers in parallel
  parallelizer.parallelize(by_bootstrap_options) do |bootstrap_options, machine_specs|
    machine_description = if machine_specs.size == 1
      "machine #{machine_specs.first.name}"
    else
      "machines #{machine_specs.map { |s| s.name }.join(", ")}"
    end
    description = [ "creating #{machine_description} on #{driver_url}" ]
    bootstrap_options.each_pair { |key,value| description << "  #{key}: #{value.inspect}" }
    action_handler.report_progress description
    if action_handler.should_perform_actions
      # Actually create the servers
      parallelizer.parallelize(1.upto(machine_specs.size)) do |i|

        # Assign each one to a machine spec
        machine_spec = machine_specs.pop
        machine_options = specs_and_options[machine_spec]

        clean_bootstrap_options = Marshal.load(Marshal.dump(bootstrap_options))
        instance = create_instance_and_reference(clean_bootstrap_options, action_handler, machine_spec, machine_options)
        converge_ec2_tags(instance, machine_options[:aws_tags], action_handler)

        action_handler.performed_action "machine #{machine_spec.name} created as #{instance.id} on #{driver_url}"

        yield machine_spec, instance if block_given?
      end.to_a

      if machine_specs.size > 0
        raise "Not all machines were created by create_servers"
      end
    end
  end.to_a
end

#create_ssh_transport(machine_spec, machine_options, instance) ⇒ Object 



946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 946

def create_ssh_transport(machine_spec, machine_options, instance)
  ssh_options = ssh_options_for(machine_spec, machine_options, instance)
  username = machine_spec.reference['ssh_username'] || machine_options[:ssh_username] || default_ssh_username
  if machine_options.has_key?(:ssh_username) && machine_options[:ssh_username] != machine_spec.reference['ssh_username']
    Chef::Log.warn("Server #{machine_spec.name} was created with SSH username #{machine_spec.reference['ssh_username']} and machine_options specifies username #{machine_options[:ssh_username]}.  Using #{machine_spec.reference['ssh_username']}.  Please edit the node and change the chef_provisioning.reference.ssh_username attribute if you want to change it.")
  end
  options = {}
  if machine_spec.reference[:sudo] || (!machine_spec.reference.has_key?(:sudo) && username != 'root')
    options[:prefix] = 'sudo '
  end

  remote_host = determine_remote_host(machine_spec, instance)

  #Enable pty by default
  options[:ssh_pty_enable] = true
  options[:ssh_gateway] = machine_spec.reference['ssh_gateway'] if machine_spec.reference.has_key?('ssh_gateway')

  Chef::Provisioning::Transport::SSH.new(remote_host, username, ssh_options, options, config)
end

#create_winrm_transport(machine_spec, machine_options, instance) ⇒ Object 



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 916

def create_winrm_transport(machine_spec, machine_options, instance)
  remote_host = determine_remote_host(machine_spec, instance)

  port = machine_spec.reference['winrm_port'] || 5985
  endpoint = "http://#{remote_host}:#{port}/wsman"
  type = :plaintext
  pem_bytes = get_private_key(instance.key_name)

  # TODO plaintext password = bad
  password = machine_spec.reference['winrm_password']
  if password.nil? || password.empty?
    encrypted_admin_password = instance.password_data.password_data
    if encrypted_admin_password.nil? || encrypted_admin_password.empty?
      raise "You did not specify winrm_password in the machine options and no encrytpted password could be fetched from the instance"
    end
    decoded = Base64.decode64(encrypted_admin_password)
    private_key = OpenSSL::PKey::RSA.new(pem_bytes)
    password = private_key.private_decrypt decoded
  end

  winrm_options = {
    :user => machine_spec.reference['winrm_username'] || 'Administrator',
    :pass => password,
    :disable_sspi => true,
    :basic_auth_only => true
  }

  Chef::Provisioning::Transport::WinRM.new("#{endpoint}", type, winrm_options, {})
end

#default_ami_arch ⇒ Object 



878
879
880
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 878

def default_ami_arch
  'amd64'
end

#default_ami_for_criteria(region, arch, release, root_store, virtualization_type) ⇒ Object 



894
895
896
897
898
899
900
901
902
903
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 894

def default_ami_for_criteria(region, arch, release, root_store, virtualization_type)
  ami = Ubuntu.release(release).amis.find do |ami|
    ami.arch == arch &&
    ami.root_store == root_store &&
    ami.region == region &&
    ami.virtualization_type == virtualization_type
  end

  ami.name || fail("Default AMI not found")
end

#default_ami_for_region(region, criteria = {}) ⇒ Object 



905
906
907
908
909
910
911
912
913
914
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 905

def default_ami_for_region(region, criteria = {})
  Chef::Log.debug("Choosing default AMI for region '#{region}'")

  arch = criteria['arch'] || default_ami_arch
  release = criteria['release'] || default_ami_release
  root_store = criteria['root_store'] || default_ami_root_store
  virtualization_type = criteria['virtualization_type'] || default_ami_virtualization_type

  default_ami_for_criteria(region, arch, release, root_store, virtualization_type)
end

#default_ami_release ⇒ Object 



882
883
884
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 882

def default_ami_release
  'vivid'
end

#default_ami_root_store ⇒ Object 



886
887
888
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 886

def default_ami_root_store
  'ebs'
end

#default_ami_virtualization_type ⇒ Object 



890
891
892
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 890

def default_ami_virtualization_type
  'hvm'
end

#default_aws_keypair(action_handler, machine_spec) ⇒ Object 



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1121

def default_aws_keypair(action_handler, machine_spec)
  driver = self
  default_key_name = default_aws_keypair_name(machine_spec)
  updated = @@chef_default_lock.synchronize do
    Provisioning.inline_resource(action_handler) do
      aws_key_pair default_key_name do
        driver driver
        allow_overwrite true
      end
    end
  end

  # Only warn the first time
  default_warning = 'Using default key, which is not shared between machines!  It is recommended to create an AWS key pair with the aws_key_pair resource, and set :bootstrap_options => { :key_name => <key name> }'
  Chef::Log.warn(default_warning) if updated

  default_key_name
end

#default_aws_keypair_name(machine_spec) ⇒ Object 



1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1112

def default_aws_keypair_name(machine_spec)
  if machine_spec.reference &&
      Gem::Version.new(machine_spec.reference['driver_version']) < Gem::Version.new('0.10')
    'metal_default'
  else
    'chef_default'
  end
end

#default_instance_type ⇒ Object 



1327
1328
1329
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1327

def default_instance_type
  't2.micro'
end

#default_ssh_username ⇒ Object 



815
816
817
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 815

def default_ssh_username
  'ubuntu'
end

#destroy_image(action_handler, image_spec, image_options) ⇒ Object 



517
518
519
520
521
522
523
524
525
526
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 517

def destroy_image(action_handler, image_spec, image_options)
  # TODO the driver should automatically be set by `inline_resource`
  d = self
  Provisioning.inline_resource(action_handler) do
    aws_image image_spec.name do
      action :destroy
      driver d
    end
  end
end

#destroy_load_balancer(action_handler, lb_spec, lb_options) ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 460

def destroy_load_balancer(action_handler, lb_spec, lb_options)
  return if lb_spec == nil

  actual_elb = load_balancer_for(lb_spec)
  if actual_elb && actual_elb.exists?
    # Remove ELB from AWS
    action_handler.perform_action "Deleting EC2 ELB #{lb_spec.id}" do
      actual_elb.delete
    end
  end

  # Remove LB spec from databag
  lb_spec.delete(action_handler)
end

#destroy_machine(action_handler, machine_spec, machine_options) ⇒ Object 



627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 627

def destroy_machine(action_handler, machine_spec, machine_options)
  d = self
  Provisioning.inline_resource(action_handler) do
    aws_instance machine_spec.name do
      action :destroy
      driver d
    end
  end

  # TODO move this into the aws_instance provider somehow
  strategy = convergence_strategy_for(machine_spec, machine_options)
  strategy.cleanup_convergence(action_handler, machine_spec)
end

#determine_remote_host(machine_spec, instance) ⇒ Object 



966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 966

def determine_remote_host(machine_spec, instance)
  transport_address_location = (machine_spec.reference['transport_address_location'] || :none).to_sym
  if machine_spec.reference['use_private_ip_for_ssh']
    # The machine_spec has the old config key, lets update it - a successful chef converge will save the machine_spec
    # TODO in 2.0 get rid of this update
    machine_spec.reference.delete('use_private_ip_for_ssh')
    machine_spec.reference['transport_address_location'] = :private_ip
    instance.private_ip_address
  elsif transport_address_location == :private_ip
    instance.private_ip_address
  elsif transport_address_location == :dns
    instance.dns_name
  elsif !instance.public_ip_address && instance.private_ip_address
    Chef::Log.warn("Server #{machine_spec.name} has no public ip address.  Using private ip '#{instance.private_ip_address}'.  Set machine_options ':transport_address_location => :private_ip' if this will always be the case ...")
    instance.private_ip_address
  elsif instance.public_ip_address
    instance.public_ip_address
  else
    raise "Server #{instance.id} has no private or public IP address!"
  end
end

#ec2 ⇒ Object 



647
648
649
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 647

def ec2
  @ec2 ||= AWS::EC2.new(config: aws_config)
end

#elasticache ⇒ Object 



669
670
671
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 669

def elasticache
  @elasticache ||= AWS::ElastiCache::Client.new(config: aws_config)
end

#elb ⇒ Object 



665
666
667
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 665

def elb
  @elb ||= AWS::ELB.new(config: aws_config)
end

#get_listener(listener) ⇒ Object 



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1291

def get_listener(listener)
  result = {}

  case listener
  when Hash
    result.merge!(listener)
  when Array
    result[:port] = listener[0] if listener.size >= 1
    result[:protocol] = listener[1] if listener.size >= 2
  when Symbol,String
    result[:protocol] = listener
  when Integer
    result[:port] = listener
  else
    raise "Invalid listener #{listener}"
  end

  # If either port or protocol are set, set the other
  if result[:port] && !result[:protocol]
    result[:protocol] = PROTOCOL_DEFAULTS[result[:port]]
  elsif result[:protocol] && !result[:port]
    result[:port] = PORT_DEFAULTS[result[:protocol]]
  end
  if result[:instance_port] && !result[:instance_protocol]
    result[:instance_protocol] = PROTOCOL_DEFAULTS[result[:instance_port]]
  elsif result[:instance_protocol] && !result[:instance_port]
    result[:instance_port] = PORT_DEFAULTS[result[:instance_protocol]]
  end

  # If instance_port is still unset, copy port/protocol over
  result[:instance_port] ||= result[:port]
  result[:instance_protocol] ||= result[:protocol]

  result
end

#get_listeners(listeners) ⇒ Object 



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1270

def get_listeners(listeners)
  case listeners
  when Hash
    listeners.map do |from, to|
      from = get_listener(from)
      from.delete(:instance_port)
      from.delete(:instance_protocol)
      to = get_listener(to)
      to.delete(:port)
      to.delete(:protocol)
      to.merge(from)
    end
  when Array
    listeners.map { |listener| get_listener(listener) }
  when nil
    nil
  else
    [ get_listener(listeners) ]
  end
end

#iam ⇒ Object 



673
674
675
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 673

def iam
  @iam ||= AWS::IAM.new(config: aws_config)
end

#image_for(image_spec) ⇒ Object 



849
850
851
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 849

def image_for(image_spec)
  Chef::Resource::AwsImage.get_aws_object(image_spec.name, driver: self, managed_entry_store: image_spec.managed_entry_store, required: false)
end

#instance_for(machine_spec) ⇒ Object 



834
835
836
837
838
839
840
841
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 834

def instance_for(machine_spec)
  if machine_spec.reference
    if machine_spec.driver_url != driver_url
      raise "Switching a machine's driver from #{machine_spec.driver_url} to #{driver_url} is not currently supported!  Use machine :destroy and then re-create the machine on the new driver."
    end
    Chef::Resource::AwsInstance.get_aws_object(machine_spec.reference['instance_id'], driver: self, managed_entry_store: machine_spec.managed_entry_store, required: false)
  end
end

#instances_for(machine_specs) ⇒ Object 



843
844
845
846
847
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 843

def instances_for(machine_specs)
  result = {}
  machine_specs.each { |machine_spec| result[machine_spec] = instance_for(machine_spec) }
  result
end

#keypair_for(bootstrap_options) ⇒ Object 



819
820
821
822
823
824
825
826
827
828
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 819

def keypair_for(bootstrap_options)
  if bootstrap_options[:key_name]
    keypair_name = bootstrap_options[:key_name]
    actual_key_pair = ec2.key_pairs[keypair_name]
    if !actual_key_pair.exists?
      ec2.key_pairs.create(keypair_name)
    end
    actual_key_pair
  end
end

#load_balancer_for(lb_spec) ⇒ Object 



830
831
832
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 830

def load_balancer_for(lb_spec)
  Chef::Resource::AwsLoadBalancer.get_aws_object(lb_spec.name, driver: self, managed_entry_store: lb_spec.managed_entry_store, required: false)
end

#machine_for(machine_spec, machine_options, instance = nil) ⇒ Object 



731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 731

def machine_for(machine_spec, machine_options, instance = nil)
  instance ||= instance_for(machine_spec)

  if !instance
    raise "Instance for node #{machine_spec.name} has not been created!"
  end

  if machine_spec.reference['is_windows']
    Chef::Provisioning::Machine::WindowsMachine.new(machine_spec, transport_for(machine_spec, machine_options, instance), convergence_strategy_for(machine_spec, machine_options))
  else
    Chef::Provisioning::Machine::UnixMachine.new(machine_spec, transport_for(machine_spec, machine_options, instance), convergence_strategy_for(machine_spec, machine_options))
  end
end

#parse_arn(arn) ⇒ Object 



701
702
703
704
705
706
707
708
709
710
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 701

def parse_arn(arn)
  parts = arn.split(':', 6)
  {
    partition: parts[1],
    service: parts[2],
    region: parts[3],
    account_id: parts[4],
    resource: parts[5]
  }
end

#rds ⇒ Object 



677
678
679
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 677

def rds
  @rds ||= AWS::RDS.new(config: aws_config)
end

#ready_image(action_handler, image_spec, image_options) ⇒ Object 



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 501

def ready_image(action_handler, image_spec, image_options)
  actual_image = image_for(image_spec)
  if actual_image.nil? || !actual_image.exists?
    raise 'Cannot ready an image that does not exist'
  else
    image_options = (image_options || {}).to_h.dup
    aws_tags = image_options.delete(:aws_tags) || {}
    aws_tags['from-instance'] = image_spec.reference['from-instance'] if image_spec.reference['from-instance']
    converge_ec2_tags(actual_image, aws_tags, action_handler)
    if actual_image.state != :available
      action_handler.report_progress 'Waiting for image to be ready ...'
      wait_until_ready_image(action_handler, image_spec, actual_image)
    end
  end
end

#ready_load_balancer(action_handler, lb_spec, lb_options, machine_spec) ⇒ Object 



457
458
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 457

def ready_load_balancer(action_handler, lb_spec, lb_options, machine_spec)
end

#ready_machine(action_handler, machine_spec, machine_options) ⇒ Object 



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 569

def ready_machine(action_handler, machine_spec, machine_options)
  instance = instance_for(machine_spec)
  converge_ec2_tags(instance, machine_options[:aws_tags], action_handler)

  if instance.nil?
    raise "Machine #{machine_spec.name} does not have an instance associated with it, or instance does not exist."
  end

  if instance.state.name != "running"
    wait_until_machine(action_handler, machine_spec, "finish stopping", instance) { |instance| instance.state.name != "stopping" }
    if instance.state.name == "stopped"
      action_handler.perform_action "Start #{machine_spec.name} (#{machine_spec.reference['instance_id']}) in #{aws_config.region} ..." do
        instance.start
      end
    end
    wait_until_instance_running(action_handler, machine_spec, instance)
  end

  # Windows machines potentially do a bunch of extra stuff - setting hostname,
  # sending out encrypted password, restarting instance, etc.
  if machine_spec.reference['is_windows']
    wait_until_machine(action_handler, machine_spec, "receive 'Windows is ready' message from the AWS console", instance) { |instance|
      output = instance.console_output.output
      if output.nil? || output.empty?
        false
      else
        output = Base64.decode64(output)
        output =~ /Message: Windows is Ready to use/
      end
    }
  end
  wait_for_transport(action_handler, machine_spec, machine_options)
  machine_for(machine_spec, machine_options, instance)
end

#s3 ⇒ Object 



681
682
683
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 681

def s3
  @s3 ||= AWS::S3.new(config: aws_config)
end

#server_cert_from_spec(spec) ⇒ Object

Retreive the server certificate from a listener spec, prefering the server_certificate key.



447
448
449
450
451
452
453
454
455
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 447

def server_cert_from_spec(spec)
  if spec[:server_certificate]
    spec[:server_certificate]
  elsif spec[:ssl_certificate_id]
    spec[:ssl_certificate_id]
  else
    nil
  end
end

#server_cert_to_string(cert) ⇒ Object 



437
438
439
440
441
442
443
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 437

def server_cert_to_string(cert)
  if cert.respond_to?(:arn)
    cert.arn
  else
    cert
  end
end

#server_certificate_eql?(cert1, cert2) ⇒ Boolean

Compare two server certificates by casting them both to strings.

The parameters should either be a String containing the certificate ARN, or a IAM::ServerCertificate object.

Returns:

  • (Boolean) 


433
434
435
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 433

def server_certificate_eql?(cert1, cert2)
  server_cert_to_string(cert1) == server_cert_to_string(cert2)
end

#sns ⇒ Object 



685
686
687
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 685

def sns
  @sns ||= AWS::SNS.new(config: aws_config)
end

#sqs ⇒ Object 



689
690
691
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 689

def sqs
  @sqs ||= AWS::SQS.new(config: aws_config)
end

#ssh_options_for(machine_spec, machine_options, instance) ⇒ Object 



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 988

def ssh_options_for(machine_spec, machine_options, instance)
  result = {
    # TODO create a user known hosts file
    #          :user_known_hosts_file => vagrant_ssh_config['UserKnownHostsFile'],
    #          :paranoid => true,
    :auth_methods => [ 'publickey' ],
    :keys_only => true,
    :host_key_alias => "#{instance.id}.AWS"
  }.merge(machine_options[:ssh_options] || {})
  if instance.respond_to?(:private_key) && instance.private_key
    result[:key_data] = [ instance.private_key ]
  elsif instance.respond_to?(:key_name) && instance.key_name
    key = get_private_key(instance.key_name)
    unless key
      raise "Server has key name '#{instance.key_name}', but the corresponding private key was not found locally.  Check if the key is in Chef::Config.private_key_paths: #{Chef::Config.private_key_paths.join(', ')}"
    end
    result[:key_data] = [ key ]
  elsif machine_spec.reference['key_name']
    key = get_private_key(machine_spec.reference['key_name'])
    unless key
      raise "Server was created with key name '#{machine_spec.reference['key_name']}', but the corresponding private key was not found locally.  Check if the key is in Chef::Config.private_key_paths: #{Chef::Config.private_key_paths.join(', ')}"
    end
    result[:key_data] = [ key ]
  elsif machine_options[:bootstrap_options] && machine_options[:bootstrap_options][:key_path]
    result[:key_data] = [ IO.read(machine_options[:bootstrap_options][:key_path]) ]
  elsif machine_options[:bootstrap_options] && machine_options[:bootstrap_options][:key_name]
    result[:key_data] = [ get_private_key(machine_options[:bootstrap_options][:key_name]) ]
  else
    # TODO make a way to suggest other keys to try ...
    raise "No key found to connect to #{machine_spec.name} (#{machine_spec.reference.inspect})!"
  end
  result
end

#stop_machine(action_handler, machine_spec, machine_options) ⇒ Object 



614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 614

def stop_machine(action_handler, machine_spec, machine_options)
  instance = instance_for(machine_spec)
  if instance && instance.exists?
    wait_until_machine(action_handler, machine_spec, "finish coming up so we can stop it", instance) { |instance| instance.state.name != "pending" }
    if instance.state.name == "running"
      action_handler.perform_action "Stop #{machine_spec.name} (#{instance.id}) in #{aws_config.region} ..." do
        instance.stop
      end
    end
    wait_until_machine(action_handler, machine_spec, "stop", instance) { |instance| %w[stopped terminated].include?(instance.state.name) }
  end
end

#transport_for(machine_spec, machine_options, instance) ⇒ Object 



853
854
855
856
857
858
859
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 853

def transport_for(machine_spec, machine_options, instance)
  if machine_spec.reference['is_windows']
    create_winrm_transport(machine_spec, machine_options, instance)
  else
    create_ssh_transport(machine_spec, machine_options, instance)
  end
end

#user_data ⇒ Object 



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 528

def user_data
  # TODO: Make this use HTTPS at some point.
  <<EOD
<powershell>
winrm quickconfig -q
winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="300"}'
winrm set winrm/config '@{MaxTimeoutms="1800000"}'
winrm set winrm/config/service '@{AllowUnencrypted="true"}'
winrm set winrm/config/service/auth '@{Basic="true"}'

netsh advfirewall firewall add rule name="WinRM 5985" protocol=TCP dir=in localport=5985 action=allow
netsh advfirewall firewall add rule name="WinRM 5986" protocol=TCP dir=in localport=5986 action=allow

net stop winrm
sc config winrm start=auto
net start winrm
</powershell>
EOD
end

#wait_for_transport(action_handler, machine_spec, machine_options) ⇒ Object 



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1092

def wait_for_transport(action_handler, machine_spec, machine_options)
  instance = instance_for(machine_spec)
  time_elapsed = 0
  sleep_time = 10
  max_wait_time = Chef::Config.chef_provisioning[:machine_max_wait_time] || 120
  transport = transport_for(machine_spec, machine_options, instance)
  unless transport.available?
    if action_handler.should_perform_actions
      action_handler.report_progress "waiting for #{machine_spec.name} (#{instance.id} on #{driver_url}) to be connectable (transport up and running) ..."
      while time_elapsed < max_wait_time && !transport.available?
        action_handler.report_progress "been waiting #{time_elapsed}/#{max_wait_time} -- sleeping #{sleep_time} seconds for #{machine_spec.name} (#{instance.id} on #{driver_url}) to be connectable ..."
        sleep(sleep_time)
        time_elapsed += sleep_time
      end

      action_handler.report_progress "#{machine_spec.name} is now connectable"
    end
  end
end

#wait_until_image(action_handler, image_spec, image = nil, &block) ⇒ Object 



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1046

def wait_until_image(action_handler, image_spec, image=nil, &block)
  image ||= image_for(image_spec)
  time_elapsed = 0
  sleep_time = 10
  max_wait_time = Chef::Config.chef_provisioning[:image_max_wait_time] || 300
  if !yield(image)
    action_handler.report_progress "waiting for #{image_spec.name} (#{image.id} on #{driver_url}) to be ready ..."
    while time_elapsed < max_wait_time && !yield(image)
      action_handler.report_progress "been waiting #{time_elapsed}/#{max_wait_time} -- sleeping #{sleep_time} seconds for #{image_spec.name} (#{image.id} on #{driver_url}) to be ready ..."
      sleep(sleep_time)
      time_elapsed += sleep_time
    end
    unless yield(image)
      raise "Image #{image.id} did not become ready within #{max_wait_time} seconds"
    end
    action_handler.report_progress "Image #{image_spec.name} is now ready"
  end
end

#wait_until_instance_running(action_handler, machine_spec, instance = nil) ⇒ Object 



1065
1066
1067
1068
1069
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1065

def wait_until_instance_running(action_handler, machine_spec, instance=nil)
  wait_until_machine(action_handler, machine_spec, "be ready", instance) { |instance|
    instance.state.name == "running"
  }
end

#wait_until_machine(action_handler, machine_spec, output_msg, instance = nil, &block) ⇒ Object 



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1071

def wait_until_machine(action_handler, machine_spec, output_msg, instance=nil, &block)
  instance ||= instance_for(machine_spec)
  max_attempts = ((Chef::Config.chef_provisioning[:machine_max_wait_time] || 120) / 10).floor
  delay = 10
  log_progress = Proc.new do |attempts, response|
    action_handler.report_progress "been waiting #{delay*attempts}/#{delay*max_attempts} -- sleeping #{delay} seconds for #{machine_spec.name} (#{instance.id} on #{driver_url}) to #{output_msg} ..."
  end
  if action_handler.should_perform_actions
    no_wait = yield(instance)
    unless no_wait
      action_handler.report_progress "waiting for #{machine_spec.name} (#{instance.id} on #{driver_url}) to #{output_msg} ..."
      instance.wait_until(:max_attempts => max_attempts, :delay => delay, before_wait: log_progress) do |instance|
        yield(instance)
      end
    end
  end
  # We need an instance.reload here because the `wait_until` does not reload the instance it is called on,
  # only the instance that is passed to the block
  instance.reload
end

#wait_until_ready_image(action_handler, image_spec, image = nil) ⇒ Object 



1042
1043
1044
 
# File 'lib/chef/provisioning/aws_driver/driver.rb', line 1042

def wait_until_ready_image(action_handler, image_spec, image=nil)
  wait_until_image(action_handler, image_spec, image) { image.state == :available }
end