/
ec2.py
600 lines (551 loc) · 24.1 KB
/
ec2.py
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
# This file is part of Buildbot. Buildbot is free software: you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Portions Copyright Buildbot Team Members
# Portions Copyright Canonical Ltd. 2009
"""
A latent worker that uses EC2 to instantiate the workers on demand.
Tested with Python boto 1.5c
"""
import os
import re
import time
from twisted.internet import defer
from twisted.internet import threads
from twisted.python import log
from buildbot import config
from buildbot.interfaces import LatentWorkerFailedToSubstantiate
from buildbot.worker import AbstractLatentWorker
try:
import boto3
import botocore
from botocore.client import ClientError
except ImportError:
boto3 = None
PENDING = 'pending'
RUNNING = 'running'
SHUTTINGDOWN = 'shutting-down'
TERMINATED = 'terminated'
SPOT_REQUEST_PENDING_STATES = ['pending-evaluation', 'pending-fulfillment']
FULFILLED = 'fulfilled'
PRICE_TOO_LOW = 'price-too-low'
class EC2LatentWorker(AbstractLatentWorker):
instance = image = None
_poll_resolution = 5 # hook point for tests
def __init__(
self,
name,
password,
instance_type,
ami=None,
valid_ami_owners=None,
valid_ami_location_regex=None,
elastic_ip=None,
identifier=None,
secret_identifier=None,
aws_id_file_path=None,
user_data=None,
region=None,
keypair_name=None,
security_name=None,
spot_instance=False,
max_spot_price=1.6,
volumes=None,
placement=None,
price_multiplier=1.2,
tags=None,
product_description='Linux/UNIX',
subnet_id=None,
security_group_ids=None,
instance_profile_name=None,
block_device_map=None,
session=None,
**kwargs,
):
if not boto3:
config.error("The python module 'boto3' is needed to use a EC2LatentWorker")
if keypair_name is None:
config.error("EC2LatentWorker: 'keypair_name' parameter must be specified")
if security_name is None and not subnet_id:
config.error("EC2LatentWorker: 'security_name' parameter must be specified")
if volumes is None:
volumes = []
if tags is None:
tags = {}
super().__init__(name, password, **kwargs)
if security_name and subnet_id:
raise ValueError(
'security_name (EC2 classic security groups) is not supported '
'in a VPC. Use security_group_ids instead.'
)
if not (
(ami is not None)
^ (valid_ami_owners is not None or valid_ami_location_regex is not None)
):
raise ValueError(
'You must provide either a specific ami, or one or both of '
'valid_ami_location_regex and valid_ami_owners'
)
self.ami = ami
if valid_ami_owners is not None:
if isinstance(valid_ami_owners, int):
valid_ami_owners = (valid_ami_owners,)
else:
for element in valid_ami_owners:
if not isinstance(element, int):
raise ValueError(
'valid_ami_owners should be int or iterable of ints', element
)
if valid_ami_location_regex is not None:
if not isinstance(valid_ami_location_regex, str):
raise ValueError('valid_ami_location_regex should be a string')
# pre-compile the regex
valid_ami_location_regex = re.compile(valid_ami_location_regex)
if spot_instance and price_multiplier is None and max_spot_price is None:
raise ValueError(
'You must provide either one, or both, of price_multiplier or max_spot_price'
)
self.valid_ami_owners = None
if valid_ami_owners:
self.valid_ami_owners = [str(o) for o in valid_ami_owners]
self.valid_ami_location_regex = valid_ami_location_regex
self.instance_type = instance_type
self.keypair_name = keypair_name
self.security_name = security_name
self.user_data = user_data
self.spot_instance = spot_instance
self.max_spot_price = max_spot_price
self.volumes = volumes
self.price_multiplier = price_multiplier
self.product_description = product_description
if None not in [placement, region]:
self.placement = f'{region}{placement}'
else:
self.placement = None
if identifier is None:
assert (
secret_identifier is None
), 'supply both or neither of identifier, secret_identifier'
if aws_id_file_path is None:
home = os.environ['HOME']
default_path = os.path.join(home, '.ec2', 'aws_id')
if os.path.exists(default_path):
aws_id_file_path = default_path
if aws_id_file_path:
log.msg('WARNING: EC2LatentWorker is using deprecated aws_id file')
with open(aws_id_file_path, 'r', encoding='utf-8') as aws_file:
identifier = aws_file.readline().strip()
secret_identifier = aws_file.readline().strip()
else:
assert aws_id_file_path is None, (
'if you supply the identifier and secret_identifier, '
'do not specify the aws_id_file_path'
)
assert (
secret_identifier is not None
), 'supply both or neither of identifier, secret_identifier'
region_found = None
# Make the EC2 connection.
self.session = session
if self.session is None:
if region is not None:
for r in boto3.Session(
aws_access_key_id=identifier, aws_secret_access_key=secret_identifier
).get_available_regions('ec2'):
if r == region:
region_found = r
if region_found is not None:
self.session = boto3.Session(
region_name=region,
aws_access_key_id=identifier,
aws_secret_access_key=secret_identifier,
)
else:
raise ValueError('The specified region does not exist: ' + region)
else:
# boto2 defaulted to us-east-1 when region was unset, we
# mimic this here in boto3
region = botocore.session.get_session().get_config_variable('region')
if region is None:
region = 'us-east-1'
self.session = boto3.Session(
aws_access_key_id=identifier,
aws_secret_access_key=secret_identifier,
region_name=region,
)
self.ec2 = self.session.resource('ec2')
self.ec2_client = self.session.client('ec2')
# Make a keypair
#
# We currently discard the keypair data because we don't need it.
# If we do need it in the future, we will always recreate the keypairs
# because there is no way to
# programmatically retrieve the private key component, unless we
# generate it and store it on the filesystem, which is an unnecessary
# usage requirement.
try:
self.ec2.KeyPair(self.keypair_name).load()
# key_pair.delete() # would be used to recreate
except ClientError as e:
if 'InvalidKeyPair.NotFound' not in str(e):
if 'AuthFailure' in str(e):
log.msg(
'POSSIBLE CAUSES OF ERROR:\n'
' Did you supply your AWS credentials?\n'
' Did you sign up for EC2?\n'
' Did you put a credit card number in your AWS '
'account?\n'
'Please doublecheck before reporting a problem.\n'
)
raise
# make one; we would always do this, and stash the result, if we
# needed the key (for instance, to SSH to the box). We'd then
# use paramiko to use the key to connect.
self.ec2.create_key_pair(KeyName=keypair_name)
# create security group
if security_name:
try:
self.ec2_client.describe_security_groups(GroupNames=[security_name])
except ClientError as e:
if 'InvalidGroup.NotFound' in str(e):
self.security_group = self.ec2.create_security_group(
GroupName=security_name,
Description='Authorization to access the buildbot instance.',
)
# Authorize the master as necessary
# TODO this is where we'd open the hole to do the reverse pb
# connect to the buildbot
# ip = urllib.urlopen(
# 'http://checkip.amazonaws.com').read().strip()
# self.security_group.authorize('tcp', 22, 22, '{}/32'.format(ip))
# self.security_group.authorize('tcp', 80, 80, '{}/32'.format(ip))
else:
raise
# get the image
if self.ami is not None:
self.image = self.ec2.Image(self.ami)
else:
# verify we have access to at least one acceptable image
discard = self.get_image()
assert discard
# get the specified elastic IP, if any
if elastic_ip is not None:
# Using ec2.vpc_addresses.filter(PublicIps=[elastic_ip]) throws a
# NotImplementedError("Filtering not supported in describe_address.") in moto
# https://github.com/spulec/moto/blob/100ec4e7c8aa3fde87ff6981e2139768816992e4/moto/ec2/responses/elastic_ip_addresses.py#L52
addresses = self.ec2.meta.client.describe_addresses(PublicIps=[elastic_ip])['Addresses']
if not addresses:
raise ValueError('Could not find EIP for IP: ' + elastic_ip)
allocation_id = addresses[0]['AllocationId']
elastic_ip = self.ec2.VpcAddress(allocation_id)
self.elastic_ip = elastic_ip
self.subnet_id = subnet_id
self.security_group_ids = security_group_ids
self.classic_security_groups = [self.security_name] if self.security_name else None
self.instance_profile_name = instance_profile_name
self.tags = tags
self.block_device_map = (
self.create_block_device_mapping(block_device_map) if block_device_map else None
)
def create_block_device_mapping(self, mapping_definitions):
if not isinstance(mapping_definitions, list):
config.error("EC2LatentWorker: 'block_device_map' must be a list")
for mapping_definition in mapping_definitions:
ebs = mapping_definition.get('Ebs')
if ebs:
ebs.setdefault('DeleteOnTermination', True)
return mapping_definitions
def get_image(self):
# pylint: disable=too-many-nested-blocks
if self.image is not None:
return self.image
images = self.ec2.images.all()
if self.valid_ami_owners:
images = images.filter(Owners=self.valid_ami_owners)
if self.valid_ami_location_regex:
level = 0
options = []
get_match = self.valid_ami_location_regex.match
for image in images:
# Image must be available
if image.state != 'available':
continue
# Image must match regex
match = get_match(image.image_location)
if not match:
continue
# Gather sorting information
alpha_sort = int_sort = None
if level < 2:
try:
alpha_sort = match.group(1)
except IndexError:
level = 2
else:
if level == 0:
try:
int_sort = int(alpha_sort)
except ValueError:
level = 1
options.append([int_sort, alpha_sort, image.image_location, image.id, image])
if level:
log.msg(f'sorting images at level {level}')
options = [candidate[level:] for candidate in options]
else:
options = [(image.image_location, image.id, image) for image in images]
options.sort()
images = [f'{candidate[-1].id} ({candidate[-1].image_location})' for candidate in options]
log.msg(f"sorted images (last is chosen): {', '.join(images)}")
if not options:
raise ValueError('no available images match constraints')
return options[-1][-1]
def dns(self):
if self.instance is None:
return None
return self.instance.public_dns_name
dns = property(dns)
def start_instance(self, build):
if self.instance is not None:
raise ValueError('instance active')
if self.spot_instance:
return threads.deferToThread(self._request_spot_instance)
return threads.deferToThread(self._start_instance)
def _remove_none_opts(self, *args, **opts):
if args:
opts = args[0]
return dict((k, v) for k, v in opts.items() if v is not None)
def _start_instance(self):
image = self.get_image()
launch_opts = {
"ImageId": image.id,
"KeyName": self.keypair_name,
"SecurityGroups": self.classic_security_groups,
"InstanceType": self.instance_type,
"UserData": self.user_data,
"Placement": self._remove_none_opts(
AvailabilityZone=self.placement,
),
"MinCount": 1,
"MaxCount": 1,
"SubnetId": self.subnet_id,
"SecurityGroupIds": self.security_group_ids,
"IamInstanceProfile": self._remove_none_opts(
Name=self.instance_profile_name,
),
"BlockDeviceMappings": self.block_device_map,
}
launch_opts = self._remove_none_opts(launch_opts)
reservations = self.ec2.create_instances(**launch_opts)
self.instance = reservations[0]
instance_id, start_time = self._wait_for_instance()
if None not in [instance_id, image.id, start_time]:
return [instance_id, image.id, start_time]
else:
self.failed_to_start(self.instance.id, self.instance.state['Name'])
return None
def stop_instance(self, fast=False):
if self.instance is None:
# be gentle. Something may just be trying to alert us that an
# instance never attached, and it's because, somehow, we never
# started.
return defer.succeed(None)
instance = self.instance
self.output = self.instance = None
return threads.deferToThread(self._stop_instance, instance, fast)
def _attach_volumes(self):
for volume_id, device_node in self.volumes:
vol = self.ec2.Volume(volume_id)
vol.attach_to_instance(InstanceId=self.instance.id, Device=device_node)
log.msg(f'Attaching EBS volume {volume_id} to {device_node}.')
def _stop_instance(self, instance, fast):
if self.elastic_ip is not None:
self.elastic_ip.association.delete()
instance.reload()
if instance.state['Name'] not in (SHUTTINGDOWN, TERMINATED):
instance.terminate()
log.msg(
f'{self.__class__.__name__} {self.workername} terminating instance '
f'{instance.id}'
)
duration = 0
interval = self._poll_resolution
if fast:
goal = (SHUTTINGDOWN, TERMINATED)
instance.reload()
else:
goal = (TERMINATED,)
while instance.state['Name'] not in goal:
time.sleep(interval)
duration += interval
if duration % 60 == 0:
log.msg(
f'{self.__class__.__name__} {self.workername} has waited {duration // 60} '
f'minutes for instance {instance.id} to end'
)
instance.reload()
log.msg(
f'{self.__class__.__name__} {self.workername} instance {instance.id} {goal} after '
f'about {duration // 60} minutes {duration % 60} seconds'
)
def _bid_price_from_spot_price_history(self):
timestamp_yesterday = time.gmtime(int(time.time() - 86400))
spot_history_starttime = time.strftime('%Y-%m-%dT%H:%M:%SZ', timestamp_yesterday)
spot_prices = self.ec2.meta.client.describe_spot_price_history(
StartTime=spot_history_starttime,
ProductDescriptions=[self.product_description],
AvailabilityZone=self.placement,
)
price_sum = 0.0
price_count = 0
for price in spot_prices['SpotPriceHistory']:
if price['InstanceType'] == self.instance_type:
price_sum += float(price['SpotPrice'])
price_count += 1
if price_count == 0:
bid_price = 0.02
else:
bid_price = (price_sum / price_count) * self.price_multiplier
return bid_price
def _request_spot_instance(self):
if self.price_multiplier is None:
bid_price = self.max_spot_price
else:
bid_price = self._bid_price_from_spot_price_history()
if self.max_spot_price is not None and bid_price > self.max_spot_price:
bid_price = self.max_spot_price
log.msg(
f'{self.__class__.__name__} {self.workername} requesting spot instance with '
f'price {bid_price:0.4f}'
)
image = self.get_image()
reservations = self.ec2.meta.client.request_spot_instances(
SpotPrice=str(bid_price),
LaunchSpecification=self._remove_none_opts(
ImageId=self.ami,
KeyName=self.keypair_name,
SecurityGroups=self.classic_security_groups,
UserData=self.user_data,
InstanceType=self.instance_type,
Placement=self._remove_none_opts(
AvailabilityZone=self.placement,
),
SubnetId=self.subnet_id,
SecurityGroupIds=self.security_group_ids,
BlockDeviceMappings=self.block_device_map,
IamInstanceProfile=self._remove_none_opts(
Name=self.instance_profile_name,
),
),
)
request, success = self._thd_wait_for_request(reservations['SpotInstanceRequests'][0])
if not success:
raise LatentWorkerFailedToSubstantiate()
instance_id = request['InstanceId']
self.instance = self.ec2.Instance(instance_id)
instance_id, start_time = self._wait_for_instance()
return instance_id, image.id, start_time
def _wait_for_instance(self):
log.msg(
f'{self.__class__.__name__} {self.workername} waiting for instance '
f'{self.instance.id} to start'
)
duration = 0
interval = self._poll_resolution
while self.instance.state['Name'] == PENDING:
time.sleep(interval)
duration += interval
if duration % 60 == 0:
log.msg(
f'{self.__class__.__name__} {self.workername} has waited {duration // 60} '
f'minutes for instance {self.instance.id}'
)
self.instance.reload()
if self.instance.state['Name'] == RUNNING:
self.properties.setProperty("instance", self.instance.id, "Worker")
self.output = self.instance.console_output().get('Output')
minutes = duration // 60
seconds = duration % 60
log.msg(
f'{self.__class__.__name__} {self.workername} instance {self.instance.id} '
f'started on {self.dns} in about {minutes} minutes {seconds} seconds '
f'({self.output})'
)
if self.elastic_ip is not None:
self.elastic_ip.associate(InstanceId=self.instance.id)
start_time = f'{minutes // 60:02d}:{minutes % 60:02d}:{seconds:02d}'
if self.volumes:
self._attach_volumes()
if self.tags:
self.instance.create_tags(
Tags=[{"Key": k, "Value": v} for k, v in self.tags.items()]
)
return self.instance.id, start_time
else:
self.failed_to_start(self.instance.id, self.instance.state['Name'])
return None # This is just to silence warning, above line throws an exception
def _thd_wait_for_request(self, reservation):
duration = 0
interval = self._poll_resolution
while True:
# Sometimes it can take a second or so for the spot request to be
# ready. If it isn't ready, you will get a "Spot instance request
# ID 'sir-abcd1234' does not exist" exception.
try:
requests = self.ec2.meta.client.describe_spot_instance_requests(
SpotInstanceRequestIds=[reservation['SpotInstanceRequestId']]
)
except ClientError as e:
if 'InvalidSpotInstanceRequestID.NotFound' in str(e):
requests = None
else:
raise
if requests is not None:
request = requests['SpotInstanceRequests'][0]
request_status = request['Status']['Code']
if request_status not in SPOT_REQUEST_PENDING_STATES:
break
time.sleep(interval)
duration += interval
if duration % 10 == 0:
log.msg(
f"{self.__class__.__name__} {self.workername} has waited {duration} "
f"seconds for spot request {reservation['SpotInstanceRequestId']}"
)
if request_status == FULFILLED:
minutes = duration // 60
seconds = duration % 60
log.msg(
f"{self.__class__.__name__} {self.workername} spot request "
f"{request['SpotInstanceRequestId']} fulfilled in about {minutes} minutes "
f"{seconds} seconds"
)
return request, True
elif request_status == PRICE_TOO_LOW:
self.ec2.meta.client.cancel_spot_instance_requests(
SpotInstanceRequestIds=[request['SpotInstanceRequestId']]
)
log.msg(
f'{self.__class__.__name__} {self.workername} spot request rejected, spot '
'price too low'
)
raise LatentWorkerFailedToSubstantiate(request['SpotInstanceRequestId'], request_status)
else:
log.msg(
f"{self.__class__.__name__} {self.workername} failed to fulfill spot request "
f"{request['SpotInstanceRequestId']} with status {request_status}"
)
# try to cancel, just for good measure
self.ec2.meta.client.cancel_spot_instance_requests(
SpotInstanceRequestIds=[request['SpotInstanceRequestId']]
)
raise LatentWorkerFailedToSubstantiate(request['SpotInstanceRequestId'], request_status)