-
Notifications
You must be signed in to change notification settings - Fork 466
/
scratch.py
428 lines (363 loc) · 11.7 KB
/
scratch.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
# Copyright Materialize, Inc. and contributors. All rights reserved.
#
# Use of this software is governed by the Business Source License
# included in the LICENSE file at the root of this repository.
#
# As of the Change Date specified in that file, in accordance with
# the Business Source License, use of this software will be governed
# by the Apache License, Version 2.0.
"""Utilities for launching and interacting with scratch EC2 instances."""
import asyncio
import csv
import datetime
import os
import shlex
import subprocess
import sys
from subprocess import CalledProcessError
from typing import Dict, List, NamedTuple, Optional, cast
import boto3
from botocore.exceptions import ClientError
from mypy_boto3_ec2.literals import InstanceTypeType
from mypy_boto3_ec2.service_resource import Instance
from mypy_boto3_ec2.type_defs import (
InstanceNetworkInterfaceSpecificationTypeDef,
InstanceTypeDef,
RunInstancesRequestRequestTypeDef,
)
from prettytable import PrettyTable
from pydantic import BaseModel
from materialize import ROOT, git, spawn, ui, util
# Sane defaults for internal Materialize use in the scratch account
DEFAULT_SECURITY_GROUP_NAME = "scratch-security-group"
DEFAULT_INSTANCE_PROFILE_NAME = "admin-instance"
SSH_COMMAND = ["mssh", "-o", "StrictHostKeyChecking=off"]
SFTP_COMMAND = ["msftp", "-o", "StrictHostKeyChecking=off"]
say = ui.speaker("scratch> ")
def tags(i: Instance) -> Dict[str, str]:
if not i.tags:
return {}
return {t["Key"]: t["Value"] for t in i.tags}
def instance_typedef_tags(i: InstanceTypeDef) -> Dict[str, str]:
return {t["Key"]: t["Value"] for t in i.get("Tags", [])}
def name(tags: Dict[str, str]) -> Optional[str]:
return tags.get("Name")
def launched_by(tags: Dict[str, str]) -> Optional[str]:
return tags.get("LaunchedBy")
def ami_user(tags: Dict[str, str]) -> Optional[str]:
return tags.get("ami-user", "ubuntu")
def delete_after(tags: Dict[str, str]) -> Optional[datetime.datetime]:
unix = tags.get("scratch-delete-after")
if not unix:
return None
unix = int(float(unix))
return datetime.datetime.fromtimestamp(unix)
def instance_host(instance: Instance, user: Optional[str] = None) -> str:
if user is None:
user = ami_user(tags(instance))
return f"{user}@{instance.id}"
def print_instances(ists: List[Instance], format: str) -> None:
field_names = [
"Name",
"Instance ID",
"Public IP Address",
"Private IP Address",
"Launched By",
"Delete After",
"State",
]
rows = [
[
name(tags),
i.instance_id,
i.public_ip_address,
i.private_ip_address,
launched_by(tags),
delete_after(tags),
i.state["Name"],
]
for (i, tags) in [(i, tags(i)) for i in ists]
]
if format == "table":
pt = PrettyTable()
pt.field_names = field_names
pt.add_rows(rows)
print(pt)
elif format == "csv":
w = csv.writer(sys.stdout)
w.writerow(field_names)
w.writerows(rows)
else:
raise RuntimeError("Unknown format passed to print_instances")
def launch(
*,
key_name: Optional[str],
instance_type: str,
ami: str,
ami_user: str,
tags: Dict[str, str],
display_name: Optional[str] = None,
size_gb: int,
security_group_name: str,
instance_profile: Optional[str],
nonce: str,
delete_after: datetime.datetime,
) -> Instance:
"""Launch and configure an ec2 instance with the given properties."""
if display_name:
tags["Name"] = display_name
tags["scratch-delete-after"] = str(delete_after.timestamp())
tags["nonce"] = nonce
tags["git_ref"] = git.describe()
tags["ami-user"] = ami_user
ec2 = boto3.client("ec2")
groups = ec2.describe_security_groups()
security_group_id = None
for group in groups["SecurityGroups"]:
if group["GroupName"] == security_group_name:
security_group_id = group["GroupId"]
break
if security_group_id is None:
vpcs = ec2.describe_vpcs()
vpc_id = None
for vpc in vpcs["Vpcs"]:
if vpc["IsDefault"] == True:
vpc_id = vpc["VpcId"]
break
if vpc_id is None:
default_vpc = ec2.create_default_vpc()
vpc_id = default_vpc["Vpc"]["VpcId"]
securitygroup = ec2.create_security_group(
GroupName=security_group_name,
Description="Allows all.",
VpcId=vpc_id,
)
security_group_id = securitygroup["GroupId"]
ec2.authorize_security_group_ingress(
GroupId=security_group_id,
CidrIp="0.0.0.0/0",
IpProtocol="tcp",
FromPort=1,
ToPort=28000,
)
network_interface: InstanceNetworkInterfaceSpecificationTypeDef = {
"AssociatePublicIpAddress": True,
"DeviceIndex": 0,
"Groups": [security_group_id],
}
say(f"launching instance {display_name or '(unnamed)'}")
with open(ROOT / "misc" / "scratch" / "provision.bash") as f:
provisioning_script = f.read()
kwargs: RunInstancesRequestRequestTypeDef = {
"MinCount": 1,
"MaxCount": 1,
"ImageId": ami,
"InstanceType": cast(InstanceTypeType, instance_type),
"UserData": provisioning_script,
"TagSpecifications": [
{
"ResourceType": "instance",
"Tags": [{"Key": k, "Value": v} for (k, v) in tags.items()],
}
],
"NetworkInterfaces": [network_interface],
"BlockDeviceMappings": [
{
"DeviceName": "/dev/sda1",
"Ebs": {
"VolumeSize": size_gb,
"VolumeType": "gp3",
},
}
],
"MetadataOptions": {
# Allow Docker containers to access IMDSv2.
"HttpPutResponseHopLimit": 2,
},
}
if key_name:
kwargs["KeyName"] = key_name
if instance_profile:
kwargs["IamInstanceProfile"] = {"Name": instance_profile}
i = boto3.resource("ec2").create_instances(**kwargs)[0]
return i
class CommandResult(NamedTuple):
status: str
stdout: str
stderr: str
async def setup(
i: Instance,
git_rev: str,
) -> None:
def is_ready(i: Instance) -> bool:
return bool(
i.public_ip_address and i.state and i.state.get("Name") == "running"
)
done = False
async for remaining in ui.async_timeout_loop(60, 5):
say(f"Waiting for instance to become ready: {remaining}s remaining")
try:
i.reload()
if is_ready(i):
done = True
break
except ClientError:
pass
if not done:
raise RuntimeError(
f"Instance {i} did not become ready in a reasonable amount of time"
)
done = False
async for remaining in ui.async_timeout_loop(300, 5):
say(f"Checking whether setup has completed: {remaining}s remaining")
try:
mssh(i, "[[ -f /opt/provision/done ]]")
done = True
break
except CalledProcessError:
continue
if not done:
raise RuntimeError(
"Instance did not finish setup in a reasonable amount of time"
)
mkrepo(i, git_rev)
def mkrepo(i: Instance, rev: str, init: bool = True, force: bool = False) -> None:
if init:
mssh(i, "git init --bare materialize/.git")
rev = git.rev_parse(rev)
cmd: List[str] = [
"git",
"push",
"--no-verify",
f"{instance_host(i)}:materialize/.git",
# Explicit refspec is required if the host repository is in detached
# HEAD mode.
f"{rev}:refs/heads/scratch",
]
if force:
cmd.append("--force")
spawn.runv(
cmd,
cwd=ROOT,
env=dict(os.environ, GIT_SSH_COMMAND=" ".join(SSH_COMMAND)),
)
mssh(
i,
f"cd materialize && git config core.bare false && git checkout {rev}",
)
class MachineDesc(BaseModel):
name: str
launch_script: Optional[str]
instance_type: str
ami: str
tags: Dict[str, str] = {}
size_gb: int
checkout: bool = True
ami_user: str = "ubuntu"
def launch_cluster(
descs: List[MachineDesc],
*,
nonce: Optional[str] = None,
key_name: Optional[str] = None,
security_group_name: str = DEFAULT_SECURITY_GROUP_NAME,
instance_profile: Optional[str] = DEFAULT_INSTANCE_PROFILE_NAME,
extra_tags: Dict[str, str] = {},
delete_after: datetime.datetime,
git_rev: str = "HEAD",
extra_env: Dict[str, str] = {},
) -> List[Instance]:
"""Launch a cluster of instances with a given nonce"""
if not nonce:
nonce = util.nonce(8)
instances = [
launch(
key_name=key_name,
instance_type=d.instance_type,
ami=d.ami,
ami_user=d.ami_user,
tags={**d.tags, **extra_tags},
display_name=f"{nonce}-{d.name}",
size_gb=d.size_gb,
security_group_name=security_group_name,
instance_profile=instance_profile,
nonce=nonce,
delete_after=delete_after,
)
for d in descs
]
loop = asyncio.get_event_loop()
loop.run_until_complete(
asyncio.gather(
*(
setup(i, git_rev if d.checkout else "HEAD")
for (i, d) in zip(instances, descs)
)
)
)
hosts_str = "".join(
(f"{i.private_ip_address}\t{d.name}\n" for (i, d) in zip(instances, descs))
)
for i in instances:
mssh(i, "sudo tee -a /etc/hosts", input=hosts_str.encode())
env = " ".join(f"{k}={shlex.quote(v)}" for k, v in extra_env.items())
for (i, d) in zip(instances, descs):
if d.launch_script:
mssh(
i,
f"(cd materialize && {env} nohup bash -c {shlex.quote(d.launch_script)}) &> mzscratch.log &",
)
return instances
def whoami() -> str:
return boto3.client("sts").get_caller_identity()["UserId"].split(":")[1]
def get_instances_by_tag(k: str, v: str) -> List[InstanceTypeDef]:
return [
i
for r in boto3.client("ec2").describe_instances()["Reservations"]
for i in r["Instances"]
if instance_typedef_tags(i).get(k) == v
]
def get_old_instances() -> List[InstanceTypeDef]:
def exists(i: InstanceTypeDef) -> bool:
return i["State"]["Name"] != "terminated"
def is_old(i: InstanceTypeDef) -> bool:
delete_after = instance_typedef_tags(i).get("scratch-delete-after")
if delete_after is None:
return False
delete_after = float(delete_after)
return datetime.datetime.utcnow().timestamp() > delete_after
return [
i
for r in boto3.client("ec2").describe_instances()["Reservations"]
for i in r["Instances"]
if exists(i) and is_old(i)
]
def mssh(
instance: Instance,
command: str,
*,
input: Optional[bytes] = None,
) -> None:
"""Runs a command over SSH via EC2 Instance Connect."""
host = instance_host(instance)
if command:
print(f"{host}$ {command}", file=sys.stderr)
# Quote to work around:
# https://github.com/aws/aws-ec2-instance-connect-cli/pull/26
command = shlex.quote(command)
else:
print(f"$ mssh {host}")
subprocess.run(
[
*SSH_COMMAND,
host,
command,
],
check=True,
input=input,
)
def msftp(
instance: Instance,
) -> None:
"""Connects over SFTP via EC2 Instance Connect."""
host = instance_host(instance)
spawn.runv([*SFTP_COMMAND, host])