forked from appoxy/aws
/
right_ec2.rb
1879 lines (1738 loc) · 79.5 KB
/
right_ec2.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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
154
155
156
157
158
159
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
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
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
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
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
#
# Copyright (c) 2007-2008 RightScale Inc
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
module Aws
# = Aws::EC2 -- RightScale Amazon EC2 interface
# The Aws::EC2 class provides a complete interface to Amazon's
# Elastic Compute Cloud service, as well as the associated EBS (Elastic Block
# Store).
# For explanations of the semantics
# of each call, please refer to Amazon's documentation at
# http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=87
#
# Examples:
#
# Create an EC2 interface handle:
#
# @ec2 = Aws::Ec2.new(aws_access_key_id,
# aws_secret_access_key)
# Create a new SSH key pair:
# @key = 'right_ec2_awesome_test_key'
# new_key = @ec2.create_key_pair(@key)
# keys = @ec2.describe_key_pairs
#
# Create a security group:
# @group = 'right_ec2_awesome_test_security_group'
# @ec2.create_security_group(@group,'My awesome test group')
# group = @ec2.describe_security_groups([@group])[0]
#
# Configure a security group:
# @ec2.authorize_security_group_named_ingress(@group, account_number, 'default')
# @ec2.authorize_security_group_IP_ingress(@group, 80,80,'udp','192.168.1.0/8')
#
# Describe the available images:
# images = @ec2.describe_images
#
# Launch an instance:
# ec2.run_instances('ami-9a9e7bf3', 1, 1, ['default'], @key, 'SomeImportantUserData', 'public')
#
#
# Describe running instances:
# @ec2.describe_instances
#
# Error handling: all operations raise an Aws::AwsError in case
# of problems. Note that transient errors are automatically retried.
class Ec2 < AwsBase
include AwsBaseInterface
# Amazon EC2 API version being used
API_VERSION = "2010-08-31"
DEFAULT_HOST = "ec2.amazonaws.com"
DEFAULT_PATH = '/'
DEFAULT_PROTOCOL = 'https'
DEFAULT_PORT = 443
# Default addressing type (public=NAT, direct=no-NAT) used when launching instances.
DEFAULT_ADDRESSING_TYPE = 'public'
DNS_ADDRESSING_SET = ['public','direct']
# Amazon EC2 Instance Types : http://www.amazon.com/b?ie=UTF8&node=370375011
# Default EC2 instance type (platform)
DEFAULT_INSTANCE_TYPE = 'm1.small'
INSTANCE_TYPES = ['t1.micro', 'm1.small','c1.medium','m1.large','m1.xlarge','c1.xlarge']
@@bench = AwsBenchmarkingBlock.new
def self.bench_xml
@@bench.xml
end
def self.bench_ec2
@@bench.service
end
# Current API version (sometimes we have to check it outside the GEM).
@@api = ENV['EC2_API_VERSION'] || API_VERSION
def self.api
@@api
end
# Create a new handle to an EC2 account. All handles share the same per process or per thread
# HTTP connection to Amazon EC2. Each handle is for a specific account. The params have the
# following options:
# * <tt>:endpoint_url</tt> a fully qualified url to Amazon API endpoint (this overwrites: :server, :port, :service, :protocol and :region). Example: 'https://eu-west-1.ec2.amazonaws.com/'
# * <tt>:server</tt>: EC2 service host, default: DEFAULT_HOST
# * <tt>:region</tt>: EC2 region (North America by default)
# * <tt>:port</tt>: EC2 service port, default: DEFAULT_PORT
# * <tt>:protocol</tt>: 'http' or 'https', default: DEFAULT_PROTOCOL
# * <tt>:multi_thread</tt>: true=HTTP connection per thread, false=per process
# * <tt>:logger</tt>: for log messages, default: Rails.logger else STDOUT
# * <tt>:signature_version</tt>: The signature version : '0' or '1'(default)
# * <tt>:cache</tt>: true/false: caching for: ec2_describe_images, describe_instances,
# describe_images_by_owner, describe_images_by_executable_by, describe_availability_zones,
# describe_security_groups, describe_key_pairs, describe_addresses,
# describe_volumes, describe_snapshots methods, default: false.
#
def initialize(aws_access_key_id=nil, aws_secret_access_key=nil, params={})
init({ :name => 'EC2',
:default_host => ENV['EC2_URL'] ? URI.parse(ENV['EC2_URL']).host : DEFAULT_HOST,
:default_port => ENV['EC2_URL'] ? URI.parse(ENV['EC2_URL']).port : DEFAULT_PORT,
:default_service => ENV['EC2_URL'] ? URI.parse(ENV['EC2_URL']).path : DEFAULT_PATH,
:default_protocol => ENV['EC2_URL'] ? URI.parse(ENV['EC2_URL']).scheme : DEFAULT_PROTOCOL,
:api_version => API_VERSION },
aws_access_key_id || ENV['AWS_ACCESS_KEY_ID'] ,
aws_secret_access_key|| ENV['AWS_SECRET_ACCESS_KEY'],
params)
# EC2 doesn't really define any transient errors to retry, and in fact,
# when they return a 503 it is usually for 'request limit exceeded' which
# we most certainly should not retry. So let's pare down the list of
# retryable errors to InternalError only (see AwsBase for the default
# list)
amazon_problems = ['InternalError']
end
def generate_request(action, params={}) #:nodoc:
service_hash = {"Action" => action,
"AWSAccessKeyId" => @aws_access_key_id,
"Version" => @@api }
service_hash.update(params)
service_params = signed_service_params(@aws_secret_access_key, service_hash, :get, @params[:server], @params[:service])
# use POST method if the length of the query string is too large
if service_params.size > 2000
if signature_version == '2'
# resign the request because HTTP verb is included into signature
service_params = signed_service_params(@aws_secret_access_key, service_hash, :post, @params[:server], @params[:service])
end
request = Net::HTTP::Post.new(@params[:service])
request.body = service_params
request['Content-Type'] = 'application/x-www-form-urlencoded'
else
request = Net::HTTP::Get.new("#{@params[:service]}?#{service_params}")
end
# prepare output hash
{ :request => request,
:server => @params[:server],
:port => @params[:port],
:protocol => @params[:protocol] }
end
# Sends request to Amazon and parses the response
# Raises AwsError if any banana happened
def request_info(request, parser, options={}) #:nodoc:
conn = get_conn(:ec2_connection, @params, @logger)
request_info_impl(conn, @@bench, request, parser, options)
end
def hash_params(prefix, list) #:nodoc:
groups = {}
list.each_index{|i| groups.update("#{prefix}.#{i+1}"=>list[i])} if list
return groups
end
#-----------------------------------------------------------------
# Images
#-----------------------------------------------------------------
# params:
# { 'ImageId' => ['id1', ..., 'idN'],
# 'Owner' => ['self', ..., 'userN'],
# 'ExecutableBy' => ['self', 'all', ..., 'userN']
# }
def ec2_describe_images(params={}, image_type=nil, cache_for=nil) #:nodoc:
request_hash = {}
params.each do |list_by, list|
request_hash.merge! hash_params(list_by, list.to_a)
end
if image_type
request_hash['Filter.1.Name'] = "image-type"
request_hash['Filter.1.Value.1'] = image_type
end
link = generate_request("DescribeImages", request_hash)
request_cache_or_info cache_for, link, QEc2DescribeImagesParser, @@bench, cache_for
rescue Exception
on_exception
end
# Retrieve a list of images. Returns array of hashes describing the images or an exception:
# +image_type+ = 'machine' || 'kernel' || 'ramdisk'
#
# ec2.describe_images #=>
# [{:aws_owner => "522821470517",
# :aws_id => "ami-e4b6538d",
# :aws_state => "available",
# :aws_location => "marcins_cool_public_images/ubuntu-6.10.manifest.xml",
# :aws_is_public => true,
# :aws_architecture => "i386",
# :aws_image_type => "machine"},
# {...},
# {...} ]
#
# If +list+ param is set, then retrieve information about the listed images only:
#
# ec2.describe_images(['ami-e4b6538d']) #=>
# [{:aws_owner => "522821470517",
# :aws_id => "ami-e4b6538d",
# :aws_state => "available",
# :aws_location => "marcins_cool_public_images/ubuntu-6.10.manifest.xml",
# :aws_is_public => true,
# :aws_architecture => "i386",
# :aws_image_type => "machine"}]
#
def describe_images(list=[], image_type=nil)
list = list.to_a
cache_for = list.empty? && !image_type ? :describe_images : nil
ec2_describe_images({ 'ImageId' => list }, image_type, cache_for)
end
#
# Example:
#
# ec2.describe_images_by_owner('522821470517')
# ec2.describe_images_by_owner('self')
#
def describe_images_by_owner(list=['self'], image_type=nil)
list = list.to_a
cache_for = list==['self'] && !image_type ? :describe_images_by_owner : nil
ec2_describe_images({ 'Owner' => list }, image_type, cache_for)
end
#
# Example:
#
# ec2.describe_images_by_executable_by('522821470517')
# ec2.describe_images_by_executable_by('self')
# ec2.describe_images_by_executable_by('all')
#
def describe_images_by_executable_by(list=['self'], image_type=nil)
list = list.to_a
cache_for = list==['self'] && !image_type ? :describe_images_by_executable_by : nil
ec2_describe_images({ 'ExecutableBy' => list }, image_type, cache_for)
end
# Register new image at Amazon.
# Returns new image id or an exception.
#
# ec2.register_image('bucket/key/manifest') #=> 'ami-e444444d'
#
def register_image(image_location)
link = generate_request("RegisterImage",
'ImageLocation' => image_location.to_s)
request_info(link, QEc2RegisterImageParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Deregister image at Amazon. Returns +true+ or an exception.
#
# ec2.deregister_image('ami-e444444d') #=> true
#
def deregister_image(image_id)
link = generate_request("DeregisterImage",
'ImageId' => image_id.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Describe image attributes. Currently 'launchPermission', 'productCodes', 'kernel', 'ramdisk' and 'blockDeviceMapping' are supported.
#
# ec2.describe_image_attribute('ami-e444444d') #=> {:groups=>["all"], :users=>["000000000777"]}
#
def describe_image_attribute(image_id, attribute='launchPermission')
link = generate_request("DescribeImageAttribute",
'ImageId' => image_id,
'Attribute' => attribute)
request_info(link, QEc2DescribeImageAttributeParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Reset image attribute. Currently, only 'launchPermission' is supported. Returns +true+ or an exception.
#
# ec2.reset_image_attribute('ami-e444444d') #=> true
#
def reset_image_attribute(image_id, attribute='launchPermission')
link = generate_request("ResetImageAttribute",
'ImageId' => image_id,
'Attribute' => attribute)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Modify an image's attributes. It is recommended that you use
# modify_image_launch_perm_add_users, modify_image_launch_perm_remove_users, etc.
# instead of modify_image_attribute because the signature of
# modify_image_attribute may change with EC2 service changes.
#
# attribute : currently, only 'launchPermission' is supported.
# operation_type : currently, only 'add' & 'remove' are supported.
# vars:
# :user_group : currently, only 'all' is supported.
# :user_id
# :product_code
def modify_image_attribute(image_id, attribute, operation_type = nil, vars = {})
params = {'ImageId' => image_id,
'Attribute' => attribute}
params['OperationType'] = operation_type if operation_type
params.update(hash_params('UserId', vars[:user_id].to_a)) if vars[:user_id]
params.update(hash_params('UserGroup', vars[:user_group].to_a)) if vars[:user_group]
params.update(hash_params('ProductCode', vars[:product_code])) if vars[:product_code]
link = generate_request("ModifyImageAttribute", params)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Grant image launch permissions to users.
# Parameter +userId+ is a list of user AWS account ids.
# Returns +true+ or an exception.
#
# ec2.modify_image_launch_perm_add_users('ami-e444444d',['000000000777','000000000778']) #=> true
def modify_image_launch_perm_add_users(image_id, user_id=[])
modify_image_attribute(image_id, 'launchPermission', 'add', :user_id => user_id.to_a)
end
# Revokes image launch permissions for users. +userId+ is a list of users AWS accounts ids. Returns +true+ or an exception.
#
# ec2.modify_image_launch_perm_remove_users('ami-e444444d',['000000000777','000000000778']) #=> true
#
def modify_image_launch_perm_remove_users(image_id, user_id=[])
modify_image_attribute(image_id, 'launchPermission', 'remove', :user_id => user_id.to_a)
end
# Add image launch permissions for users groups (currently only 'all' is supported, which gives public launch permissions).
# Returns +true+ or an exception.
#
# ec2.modify_image_launch_perm_add_groups('ami-e444444d') #=> true
#
def modify_image_launch_perm_add_groups(image_id, user_group=['all'])
modify_image_attribute(image_id, 'launchPermission', 'add', :user_group => user_group.to_a)
end
# Remove image launch permissions for users groups (currently only 'all' is supported, which gives public launch permissions).
#
# ec2.modify_image_launch_perm_remove_groups('ami-e444444d') #=> true
#
def modify_image_launch_perm_remove_groups(image_id, user_group=['all'])
modify_image_attribute(image_id, 'launchPermission', 'remove', :user_group => user_group.to_a)
end
# Add product code to image
#
# ec2.modify_image_product_code('ami-e444444d','0ABCDEF') #=> true
#
def modify_image_product_code(image_id, product_code=[])
modify_image_attribute(image_id, 'productCodes', nil, :product_code => product_code.to_a)
end
#-----------------------------------------------------------------
# Instances
#-----------------------------------------------------------------
def get_desc_instances(instances) # :nodoc:
result = []
instances.each do |reservation|
reservation[:instances_set].each do |instance|
# Parse and remove timestamp from the reason string. The timestamp is of
# the request, not when EC2 took action, thus confusing & useless...
instance[:aws_reason] = instance[:aws_reason].sub(/\(\d[^)]*GMT\) */, '')
instance[:aws_owner] = reservation[:aws_owner]
instance[:aws_reservation_id] = reservation[:aws_reservation_id]
instance[:aws_groups] = reservation[:aws_groups]
result << instance
end
end
result
rescue Exception
on_exception
end
def describe_availability_zones(options={})
link = generate_request("DescribeAvailabilityZones", options={})
request_info_xml_simple(:rds_connection, @params, link, @logger,
:group_tags=>{"DBInstances"=>"DBInstance",
"DBParameterGroups"=>"DBParameterGroup",
"DBSecurityGroups"=>"DBSecurityGroup",
"EC2SecurityGroups"=>"EC2SecurityGroup",
"IPRanges"=>"IPRange"},
:force_array=>["DBInstances",
"DBParameterGroups",
"DBSecurityGroups",
"EC2SecurityGroups",
"IPRanges"],
:pull_out_array=>options[:pull_out_array],
:pull_out_single=>options[:pull_out_single],
:wrapper=>options[:wrapper])
rescue Exception
on_exception
end
# Retrieve information about EC2 instances. If +list+ is omitted then returns the
# list of all instances.
#
# ec2.describe_instances #=>
# [{:aws_image_id => "ami-e444444d",
# :aws_reason => "",
# :aws_state_code => "16",
# :aws_owner => "000000000888",
# :aws_instance_id => "i-123f1234",
# :aws_reservation_id => "r-aabbccdd",
# :aws_state => "running",
# :dns_name => "domU-12-34-67-89-01-C9.usma2.compute.amazonaws.com",
# :ssh_key_name => "staging",
# :aws_groups => ["default"],
# :private_dns_name => "domU-12-34-67-89-01-C9.usma2.compute.amazonaws.com",
# :aws_instance_type => "m1.small",
# :aws_launch_time => "2008-1-1T00:00:00.000Z"},
# :aws_availability_zone => "us-east-1b",
# :aws_kernel_id => "aki-ba3adfd3",
# :aws_ramdisk_id => "ari-badbad00",
# :monitoring_state => ...,
# ..., {...}]
#
def describe_instances(list=[])
link = generate_request("DescribeInstances", hash_params('InstanceId',list.to_a))
request_cache_or_info(:describe_instances, link, QEc2DescribeInstancesParser, @@bench, list.blank?) do |parser|
get_desc_instances(parser.result)
end
rescue Exception
on_exception
end
# Return the product code attached to instance or +nil+ otherwise.
#
# ec2.confirm_product_instance('ami-e444444d','12345678') #=> nil
# ec2.confirm_product_instance('ami-e444444d','00001111') #=> "000000000888"
#
def confirm_product_instance(instance, product_code)
link = generate_request("ConfirmProductInstance", { 'ProductCode' => product_code,
'InstanceId' => instance })
request_info(link, QEc2ConfirmProductInstanceParser.new(:logger => @logger))
end
# DEPRECATED, USE launch_instances instead.
#
# Launch new EC2 instances. Returns a list of launched instances or an exception.
#
# ec2.run_instances('ami-e444444d',1,1,['my_awesome_group'],'my_awesome_key', 'Woohoo!!!', 'public') #=>
# [{:aws_image_id => "ami-e444444d",
# :aws_reason => "",
# :aws_state_code => "0",
# :aws_owner => "000000000888",
# :aws_instance_id => "i-123f1234",
# :aws_reservation_id => "r-aabbccdd",
# :aws_state => "pending",
# :dns_name => "",
# :ssh_key_name => "my_awesome_key",
# :aws_groups => ["my_awesome_group"],
# :private_dns_name => "",
# :aws_instance_type => "m1.small",
# :aws_launch_time => "2008-1-1T00:00:00.000Z"
# :aws_ramdisk_id => "ari-8605e0ef"
# :aws_kernel_id => "aki-9905e0f0",
# :ami_launch_index => "0",
# :aws_availability_zone => "us-east-1b"
# }]
#
def run_instances(image_id, min_count, max_count, group_ids, key_name, user_data='',
addressing_type = nil, instance_type = nil,
kernel_id = nil, ramdisk_id = nil, availability_zone = nil,
block_device_mappings = nil)
launch_instances(image_id, { :min_count => min_count,
:max_count => max_count,
:user_data => user_data,
:group_ids => group_ids,
:key_name => key_name,
:instance_type => instance_type,
:addressing_type => addressing_type,
:kernel_id => kernel_id,
:ramdisk_id => ramdisk_id,
:availability_zone => availability_zone,
:block_device_mappings => block_device_mappings
})
end
# Launch new EC2 instances. Returns a list of launched instances or an exception.
#
# +lparams+ keys (default values in parenthesis):
# :min_count fixnum, (1)
# :max_count fixnum, (1)
# :group_ids array or string ([] == 'default')
# :instance_type string (DEFAULT_INSTACE_TYPE)
# :addressing_type string (DEFAULT_ADDRESSING_TYPE
# :key_name string
# :kernel_id string
# :ramdisk_id string
# :availability_zone string
# :block_device_mappings string
# :user_data string
# :monitoring_enabled boolean (default=false)
#
# ec2.launch_instances('ami-e444444d', :group_ids => 'my_awesome_group',
# :user_data => "Woohoo!!!",
# :addressing_type => "public",
# :key_name => "my_awesome_key",
# :availability_zone => "us-east-1c") #=>
# [{:aws_image_id => "ami-e444444d",
# :aws_reason => "",
# :aws_state_code => "0",
# :aws_owner => "000000000888",
# :aws_instance_id => "i-123f1234",
# :aws_reservation_id => "r-aabbccdd",
# :aws_state => "pending",
# :dns_name => "",
# :ssh_key_name => "my_awesome_key",
# :aws_groups => ["my_awesome_group"],
# :private_dns_name => "",
# :aws_instance_type => "m1.small",
# :aws_launch_time => "2008-1-1T00:00:00.000Z",
# :aws_ramdisk_id => "ari-8605e0ef"
# :aws_kernel_id => "aki-9905e0f0",
# :ami_launch_index => "0",
# :aws_availability_zone => "us-east-1c"
# }]
#
def launch_instances(image_id, options={})
@logger.info("Launching instance of image #{image_id} for #{@aws_access_key_id}, " +
"key: #{options[:key_name]}, groups: #{(options[:group_ids]).to_a.join(',')}")
# careful: keyName and securityGroups may be nil
params = hash_params('SecurityGroup', options[:group_ids].to_a)
params.update( {'ImageId' => image_id,
'MinCount' => (options[:min_count] || 1).to_s,
'MaxCount' => (options[:max_count] || 1).to_s,
'AddressingType' => options[:addressing_type] || DEFAULT_ADDRESSING_TYPE,
'InstanceType' => options[:instance_type] || DEFAULT_INSTANCE_TYPE })
# optional params
params['KeyName'] = options[:key_name] unless options[:key_name].blank?
params['KernelId'] = options[:kernel_id] unless options[:kernel_id].blank?
params['RamdiskId'] = options[:ramdisk_id] unless options[:ramdisk_id].blank?
params['Placement.AvailabilityZone'] = options[:availability_zone] unless options[:availability_zone].blank?
params['BlockDeviceMappings'] = options[:block_device_mappings] unless options[:block_device_mappings].blank?
params['Monitoring.Enabled'] = options[:monitoring_enabled] unless options[:monitoring_enabled].blank?
params['SubnetId'] = options[:subnet_id] unless options[:subnet_id].blank?
params['AdditionalInfo'] = options[:additional_info] unless options[:additional_info].blank?
params['DisableApiTermination'] = options[:disable_api_termination].to_s unless options[:disable_api_termination].nil?
params['InstanceInitiatedShutdownBehavior'] = options[:instance_initiated_shutdown_behavior] unless options[:instance_initiated_shutdown_behavior].blank?
unless options[:user_data].blank?
options[:user_data].strip!
# Do not use CGI::escape(encode64(...)) as it is done in Amazons EC2 library.
# Amazon 169.254.169.254 does not like escaped symbols!
# And it doesn't like "\n" inside of encoded string! Grrr....
# Otherwise, some of UserData symbols will be lost...
params['UserData'] = Base64.encode64(options[:user_data]).delete("\n").strip unless options[:user_data].blank?
end
link = generate_request("RunInstances", params)
#debugger
instances = request_info(link, QEc2DescribeInstancesParser.new(:logger => @logger))
get_desc_instances(instances)
rescue Exception
on_exception
end
def monitor_instances(list=[])
link = generate_request("MonitorInstances", hash_params('InstanceId',list.to_a))
request_info(link, QEc2TerminateInstancesParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Terminates EC2 instances. Returns a list of termination params or an exception.
#
# ec2.terminate_instances(['i-f222222d','i-f222222e']) #=>
# [{:aws_shutdown_state => "shutting-down",
# :aws_instance_id => "i-f222222d",
# :aws_shutdown_state_code => 32,
# :aws_prev_state => "running",
# :aws_prev_state_code => 16},
# {:aws_shutdown_state => "shutting-down",
# :aws_instance_id => "i-f222222e",
# :aws_shutdown_state_code => 32,
# :aws_prev_state => "running",
# :aws_prev_state_code => 16}]
#
def terminate_instances(list=[])
link = generate_request("TerminateInstances", hash_params('InstanceId',list.to_a))
request_info(link, QEc2TerminateInstancesParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Retreive EC2 instance OS logs. Returns a hash of data or an exception.
#
# ec2.get_console_output('i-f222222d') =>
# {:aws_instance_id => 'i-f222222d',
# :aws_timestamp => "2007-05-23T14:36:07.000-07:00",
# :timestamp => Wed May 23 21:36:07 UTC 2007, # Time instance
# :aws_output => "Linux version 2.6.16-xenU (builder@patchbat.amazonsa) (gcc version 4.0.1 20050727 ..."
def get_console_output(instance_id)
link = generate_request("GetConsoleOutput", { 'InstanceId.1' => instance_id })
request_info(link, QEc2GetConsoleOutputParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Reboot an EC2 instance. Returns +true+ or an exception.
#
# ec2.reboot_instances(['i-f222222d','i-f222222e']) #=> true
#
def reboot_instances(list)
link = generate_request("RebootInstances", hash_params('InstanceId', list.to_a))
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
#-----------------------------------------------------------------
# Instances: Windows addons
#-----------------------------------------------------------------
# Get initial Windows Server setup password from an instance console output.
#
# my_awesome_key = ec2.create_key_pair('my_awesome_key') #=>
# {:aws_key_name => "my_awesome_key",
# :aws_fingerprint => "01:02:03:f4:25:e6:97:e8:9b:02:1a:26:32:4e:58:6b:7a:8c:9f:03",
# :aws_material => "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAK...Q8MDrCbuQ=\n-----END RSA PRIVATE KEY-----"}
#
# my_awesome_instance = ec2.run_instances('ami-a000000a',1,1,['my_awesome_group'],'my_awesome_key', 'WindowsInstance!!!') #=>
# [{:aws_image_id => "ami-a000000a",
# :aws_instance_id => "i-12345678",
# ...
# :aws_availability_zone => "us-east-1b"
# }]
#
# # wait until instance enters 'operational' state and get it's initial password
#
# puts ec2.get_initial_password(my_awesome_instance[:aws_instance_id], my_awesome_key[:aws_material]) #=> "MhjWcgZuY6"
#
def get_initial_password(instance_id, private_key)
console_output = get_console_output(instance_id)
crypted_password = console_output[:aws_output][%r{<Password>(.+)</Password>}m] && $1
unless crypted_password
raise AwsError.new("Initial password was not found in console output for #{instance_id}")
else
OpenSSL::PKey::RSA.new(private_key).private_decrypt(Base64.decode64(crypted_password))
end
rescue Exception
on_exception
end
# Bundle a Windows image.
# Internally, it queues the bundling task and shuts down the instance.
# It then takes a snapshot of the Windows volume bundles it, and uploads it to
# S3. After bundling completes, Aws::Ec2#register_image may be used to
# register the new Windows AMI for subsequent launches.
#
# ec2.bundle_instance('i-e3e24e8a', 'my-awesome-bucket', 'my-win-image-1') #=>
# [{:aws_update_time => "2008-10-16T13:58:25.000Z",
# :s3_bucket => "kd-win-1",
# :s3_prefix => "win2pr",
# :aws_state => "pending",
# :aws_id => "bun-26a7424f",
# :aws_instance_id => "i-878a25ee",
# :aws_start_time => "2008-10-16T13:58:02.000Z"}]
#
def bundle_instance(instance_id, s3_bucket, s3_prefix,
s3_owner_aws_access_key_id=nil, s3_owner_aws_secret_access_key=nil,
s3_expires = S3Interface::DEFAULT_EXPIRES_AFTER,
s3_upload_policy='ec2-bundle-read')
# S3 access and signatures
s3_owner_aws_access_key_id ||= @aws_access_key_id
s3_owner_aws_secret_access_key ||= @aws_secret_access_key
s3_expires = Time.now.utc + s3_expires if s3_expires.is_a?(Fixnum) && (s3_expires < S3Interface::ONE_YEAR_IN_SECONDS)
# policy
policy = { 'expiration' => s3_expires.strftime('%Y-%m-%dT%H:%M:%SZ'),
'conditions' => [ { 'bucket' => s3_bucket },
{ 'acl' => s3_upload_policy },
[ 'starts-with', '$key', s3_prefix ] ] }.to_json
policy64 = Base64.encode64(policy).gsub("\n","")
signed_policy64 = AwsUtils.sign(s3_owner_aws_secret_access_key, policy64)
# fill request params
params = { 'InstanceId' => instance_id,
'Storage.S3.AWSAccessKeyId' => s3_owner_aws_access_key_id,
'Storage.S3.UploadPolicy' => policy64,
'Storage.S3.UploadPolicySignature' => signed_policy64,
'Storage.S3.Bucket' => s3_bucket,
'Storage.S3.Prefix' => s3_prefix,
}
link = generate_request("BundleInstance", params)
request_info(link, QEc2BundleInstanceParser.new)
rescue Exception
on_exception
end
# Describe the status of the Windows AMI bundlings.
# If +list+ is omitted the returns the whole list of tasks.
#
# ec2.describe_bundle_tasks(['bun-4fa74226']) #=>
# [{:s3_bucket => "my-awesome-bucket"
# :aws_id => "bun-0fa70206",
# :s3_prefix => "win1pr",
# :aws_start_time => "2008-10-14T16:27:57.000Z",
# :aws_update_time => "2008-10-14T16:37:10.000Z",
# :aws_error_code => "Client.S3Error",
# :aws_error_message =>
# "AccessDenied(403)- Invalid according to Policy: Policy Condition failed: [\"eq\", \"$acl\", \"aws-exec-read\"]",
# :aws_state => "failed",
# :aws_instance_id => "i-e3e24e8a"}]
#
def describe_bundle_tasks(list=[])
link = generate_request("DescribeBundleTasks", hash_params('BundleId', list.to_a))
request_info(link, QEc2DescribeBundleTasksParser.new)
rescue Exception
on_exception
end
# Cancel an in‐progress or pending bundle task by id.
#
# ec2.cancel_bundle_task('bun-73a7421a') #=>
# [{:s3_bucket => "my-awesome-bucket"
# :aws_id => "bun-0fa70206",
# :s3_prefix => "win02",
# :aws_start_time => "2008-10-14T13:00:29.000Z",
# :aws_error_message => "User has requested bundling operation cancellation",
# :aws_state => "failed",
# :aws_update_time => "2008-10-14T13:01:31.000Z",
# :aws_error_code => "Client.Cancelled",
# :aws_instance_id => "i-e3e24e8a"}
#
def cancel_bundle_task(bundle_id)
link = generate_request("CancelBundleTask", { 'BundleId' => bundle_id })
request_info(link, QEc2BundleInstanceParser.new)
rescue Exception
on_exception
end
#-----------------------------------------------------------------
# Security groups
#-----------------------------------------------------------------
# Retrieve Security Group information. If +list+ is omitted the returns the whole list of groups.
#
# ec2.describe_security_groups #=>
# [{:aws_group_name => "default-1",
# :aws_owner => "000000000888",
# :aws_description => "Default allowing SSH, HTTP, and HTTPS ingress",
# :aws_perms =>
# [{:owner => "000000000888", :group => "default"},
# {:owner => "000000000888", :group => "default-1"},
# {:to_port => "-1", :protocol => "icmp", :from_port => "-1", :cidr_ips => "0.0.0.0/0"},
# {:to_port => "22", :protocol => "tcp", :from_port => "22", :cidr_ips => "0.0.0.0/0"},
# {:to_port => "80", :protocol => "tcp", :from_port => "80", :cidr_ips => "0.0.0.0/0"},
# {:to_port => "443", :protocol => "tcp", :from_port => "443", :cidr_ips => "0.0.0.0/0"}]},
# ..., {...}]
#
def describe_security_groups(list=[])
link = generate_request("DescribeSecurityGroups", hash_params('GroupName',list.to_a))
request_cache_or_info( :describe_security_groups, link, QEc2DescribeSecurityGroupsParser, @@bench, list.blank?) do |parser|
result = []
parser.result.each do |item|
perms = []
item.ipPermissions.each do |perm|
perm.groups.each do |ngroup|
perms << {:group => ngroup.groupName,
:owner => ngroup.userId}
end
perm.ipRanges.each do |cidr_ip|
perms << {:from_port => perm.fromPort,
:to_port => perm.toPort,
:protocol => perm.ipProtocol,
:cidr_ips => cidr_ip}
end
end
# delete duplication
perms.each_index do |i|
(0...i).each do |j|
if perms[i] == perms[j] then perms[i] = nil; break; end
end
end
perms.compact!
result << {:aws_owner => item.ownerId,
:aws_group_name => item.groupName,
:aws_description => item.groupDescription,
:aws_perms => perms}
end
result
end
rescue Exception
on_exception
end
# Create new Security Group. Returns +true+ or an exception.
#
# ec2.create_security_group('default-1',"Default allowing SSH, HTTP, and HTTPS ingress") #=> true
#
def create_security_group(name, description)
# EC2 doesn't like an empty description...
description = " " if description.blank?
link = generate_request("CreateSecurityGroup",
'GroupName' => name.to_s,
'GroupDescription' => description.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Remove Security Group. Returns +true+ or an exception.
#
# ec2.delete_security_group('default-1') #=> true
#
def delete_security_group(name)
link = generate_request("DeleteSecurityGroup",
'GroupName' => name.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Authorize named ingress for security group. Allows instances that are member of someone
# else's security group to open connections to instances in my group.
#
# ec2.authorize_security_group_named_ingress('my_awesome_group', '7011-0219-8268', 'their_group_name') #=> true
#
def authorize_security_group_named_ingress(name, owner, group)
link = generate_request("AuthorizeSecurityGroupIngress",
'GroupName' => name.to_s,
'SourceSecurityGroupName' => group.to_s,
'SourceSecurityGroupOwnerId' => owner.to_s.gsub(/-/,''))
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Revoke named ingress for security group.
#
# ec2.revoke_security_group_named_ingress('my_awesome_group', aws_user_id, 'another_group_name') #=> true
#
def revoke_security_group_named_ingress(name, owner, group)
link = generate_request("RevokeSecurityGroupIngress",
'GroupName' => name.to_s,
'SourceSecurityGroupName' => group.to_s,
'SourceSecurityGroupOwnerId' => owner.to_s.gsub(/-/,''))
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Add permission to a security group. Returns +true+ or an exception. +protocol+ is one of :'tcp'|'udp'|'icmp'.
#
# ec2.authorize_security_group_IP_ingress('my_awesome_group', 80, 82, 'udp', '192.168.1.0/8') #=> true
# ec2.authorize_security_group_IP_ingress('my_awesome_group', -1, -1, 'icmp') #=> true
#
def authorize_security_group_IP_ingress(name, from_port, to_port, protocol='tcp', cidr_ip='0.0.0.0/0')
link = generate_request("AuthorizeSecurityGroupIngress",
'GroupName' => name.to_s,
'IpProtocol' => protocol.to_s,
'FromPort' => from_port.to_s,
'ToPort' => to_port.to_s,
'CidrIp' => cidr_ip.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Remove permission from a security group. Returns +true+ or an exception. +protocol+ is one of :'tcp'|'udp'|'icmp' ('tcp' is default).
#
# ec2.revoke_security_group_IP_ingress('my_awesome_group', 80, 82, 'udp', '192.168.1.0/8') #=> true
#
def revoke_security_group_IP_ingress(name, from_port, to_port, protocol='tcp', cidr_ip='0.0.0.0/0')
link = generate_request("RevokeSecurityGroupIngress",
'GroupName' => name.to_s,
'IpProtocol' => protocol.to_s,
'FromPort' => from_port.to_s,
'ToPort' => to_port.to_s,
'CidrIp' => cidr_ip.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
#-----------------------------------------------------------------
# Keys
#-----------------------------------------------------------------
# Retrieve a list of SSH keys. Returns an array of keys or an exception. Each key is
# represented as a two-element hash.
#
# ec2.describe_key_pairs #=>
# [{:aws_fingerprint=> "01:02:03:f4:25:e6:97:e8:9b:02:1a:26:32:4e:58:6b:7a:8c:9f:03", :aws_key_name=>"key-1"},
# {:aws_fingerprint=> "1e:29:30:47:58:6d:7b:8c:9f:08:11:20:3c:44:52:69:74:80:97:08", :aws_key_name=>"key-2"},
# ..., {...} ]
#
def describe_key_pairs(list=[])
link = generate_request("DescribeKeyPairs", hash_params('KeyName',list.to_a))
request_cache_or_info :describe_key_pairs, link, QEc2DescribeKeyPairParser, @@bench, list.blank?
rescue Exception
on_exception
end
# Create new SSH key. Returns a hash of the key's data or an exception.
#
# ec2.create_key_pair('my_awesome_key') #=>
# {:aws_key_name => "my_awesome_key",
# :aws_fingerprint => "01:02:03:f4:25:e6:97:e8:9b:02:1a:26:32:4e:58:6b:7a:8c:9f:03",
# :aws_material => "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAK...Q8MDrCbuQ=\n-----END RSA PRIVATE KEY-----"}
#
def create_key_pair(name)
link = generate_request("CreateKeyPair",
'KeyName' => name.to_s)
request_info(link, QEc2CreateKeyPairParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Delete a key pair. Returns +true+ or an exception.
#
# ec2.delete_key_pair('my_awesome_key') #=> true
#
def delete_key_pair(name)
link = generate_request("DeleteKeyPair",
'KeyName' => name.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
#-----------------------------------------------------------------
# Elastic IPs
#-----------------------------------------------------------------
# Acquire a new elastic IP address for use with your account.
# Returns allocated IP address or an exception.
#
# ec2.allocate_address #=> '75.101.154.140'
#
def allocate_address
link = generate_request("AllocateAddress")
request_info(link, QEc2AllocateAddressParser.new(:logger => @logger))
rescue Exception
on_exception
end
# Associate an elastic IP address with an instance.
# Returns +true+ or an exception.
#
# ec2.associate_address('i-d630cbbf', '75.101.154.140') #=> true
#
def associate_address(instance_id, public_ip)
link = generate_request("AssociateAddress",
"InstanceId" => instance_id.to_s,
"PublicIp" => public_ip.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception
on_exception
end
# List elastic IP addresses assigned to your account.
# Returns an array of 2 keys (:instance_id and :public_ip) hashes:
#
# ec2.describe_addresses #=> [{:instance_id=>"i-d630cbbf", :public_ip=>"75.101.154.140"},
# {:instance_id=>nil, :public_ip=>"75.101.154.141"}]
#
# ec2.describe_addresses('75.101.154.140') #=> [{:instance_id=>"i-d630cbbf", :public_ip=>"75.101.154.140"}]
#
def describe_addresses(list=[])
link = generate_request("DescribeAddresses",
hash_params('PublicIp',list.to_a))
request_cache_or_info :describe_addresses, link, QEc2DescribeAddressesParser, @@bench, list.blank?
rescue Exception
on_exception
end
# Disassociate the specified elastic IP address from the instance to which it is assigned.
# Returns +true+ or an exception.
#
# ec2.disassociate_address('75.101.154.140') #=> true
#
def disassociate_address(public_ip)
link = generate_request("DisassociateAddress",
"PublicIp" => public_ip.to_s)
request_info(link, RightBoolResponseParser.new(:logger => @logger))
rescue Exception