This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 40
/
ecs.py
1601 lines (1413 loc) · 60.9 KB
/
ecs.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
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
"""
DEPRECATION WARNING:
This module is deprecated as of March 2024 and will not be available after September 2024.
It has been replaced by the ECS worker, which offers enhanced functionality and better performance.
For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
Integrations with the Amazon Elastic Container Service.
Examples:
Run a task using ECS Fargate
```python
ECSTask(command=["echo", "hello world"]).run()
```
Run a task using ECS Fargate with a spot container instance
```python
ECSTask(command=["echo", "hello world"], launch_type="FARGATE_SPOT").run()
```
Run a task using ECS with an EC2 container instance
```python
ECSTask(command=["echo", "hello world"], launch_type="EC2").run()
```
Run a task on a specific VPC using ECS Fargate
```python
ECSTask(command=["echo", "hello world"], vpc_id="vpc-01abcdf123456789a").run()
```
Run a task and stream the container's output to the local terminal. Note an
execution role must be provided with permissions: logs:CreateLogStream,
logs:CreateLogGroup, and logs:PutLogEvents.
```python
ECSTask(
command=["echo", "hello world"],
stream_output=True,
execution_role_arn="..."
)
```
Run a task using an existing task definition as a base
```python
ECSTask(command=["echo", "hello world"], task_definition_arn="arn:aws:ecs:...")
```
Run a task with a specific image
```python
ECSTask(command=["echo", "hello world"], image="alpine:latest")
```
Run a task with custom memory and CPU requirements
```python
ECSTask(command=["echo", "hello world"], memory=4096, cpu=2048)
```
Run a task with custom environment variables
```python
ECSTask(command=["echo", "hello $PLANET"], env={"PLANET": "earth"})
```
Run a task in a specific ECS cluster
```python
ECSTask(command=["echo", "hello world"], cluster="my-cluster-name")
```
Run a task with custom VPC subnets
```python
ECSTask(
command=["echo", "hello world"],
task_customizations=[
{
"op": "add",
"path": "/networkConfiguration/awsvpcConfiguration/subnets",
"value": ["subnet-80b6fbcd", "subnet-42a6fdgd"],
},
]
)
```
Run a task without a public IP assigned
```python
ECSTask(
command=["echo", "hello world"],
vpc_id="vpc-01abcdf123456789a",
task_customizations=[
{
"op": "replace",
"path": "/networkConfiguration/awsvpcConfiguration/assignPublicIp",
"value": "DISABLED",
},
]
)
```
Run a task with custom VPC security groups
```python
ECSTask(
command=["echo", "hello world"],
vpc_id="vpc-01abcdf123456789a",
task_customizations=[
{
"op": "add",
"path": "/networkConfiguration/awsvpcConfiguration/securityGroups",
"value": ["sg-d72e9599956a084f5"],
},
],
)
```
""" # noqa
import copy
import difflib
import json
import logging
import pprint
import shlex
import sys
import time
import warnings
from typing import TYPE_CHECKING, Any, Dict, Generator, List, Optional, Tuple, Union
import boto3
import yaml
from anyio.abc import TaskStatus
from jsonpointer import JsonPointerException
from prefect._internal.compatibility.deprecated import deprecated_class
from prefect.blocks.core import BlockNotSavedError
from prefect.exceptions import InfrastructureNotAvailable, InfrastructureNotFound
from prefect.infrastructure.base import Infrastructure, InfrastructureResult
from prefect.utilities.asyncutils import run_sync_in_worker_thread, sync_compatible
from prefect.utilities.dockerutils import get_prefect_image_name
from prefect.utilities.pydantic import JsonPatch
from pydantic import VERSION as PYDANTIC_VERSION
from prefect_aws.utilities import assemble_document_for_patches
if PYDANTIC_VERSION.startswith("2."):
from pydantic.v1 import Field, root_validator, validator
else:
from pydantic import Field, root_validator, validator
from slugify import slugify
from typing_extensions import Literal, Self
from prefect_aws import AwsCredentials
from prefect_aws.workers.ecs_worker import _TAG_REGEX, ECSWorker
# Internal type alias for ECS clients which are generated dynamically in botocore
_ECSClient = Any
if TYPE_CHECKING:
from prefect.client.schemas import FlowRun
from prefect.server.schemas.core import Deployment, Flow
class ECSTaskResult(InfrastructureResult):
"""The result of a run of an ECS task"""
PREFECT_ECS_CONTAINER_NAME = "prefect"
ECS_DEFAULT_CPU = 1024
ECS_DEFAULT_MEMORY = 2048
ECS_DEFAULT_FAMILY = "prefect"
POST_REGISTRATION_FIELDS = [
"compatibilities",
"taskDefinitionArn",
"revision",
"status",
"requiresAttributes",
"registeredAt",
"registeredBy",
"deregisteredAt",
]
def get_prefect_container(containers: List[dict]) -> Optional[dict]:
"""
Extract the Prefect container from a list of containers or container definitions.
If not found, `None` is returned.
"""
return get_container(containers, PREFECT_ECS_CONTAINER_NAME)
def get_container(containers: List[dict], name: str) -> Optional[dict]:
"""
Extract a container from a list of containers or container definitions.
If not found, `None` is returned.
"""
for container in containers:
if container.get("name") == name:
return container
return None
def parse_task_identifier(identifier: str) -> Tuple[str, str]:
"""
Splits identifier into its cluster and task components, e.g.
input "cluster_name::task_arn" outputs ("cluster_name", "task_arn").
"""
cluster, task = identifier.split("::", maxsplit=1)
return cluster, task
def _pretty_diff(d1: dict, d2: dict) -> str:
"""
Return a string with a pretty printed difference between two dictionaries.
"""
return "\n" + "\n".join(
difflib.ndiff(pprint.pformat(d1).splitlines(), pprint.pformat(d2).splitlines())
)
@deprecated_class(
start_date="Mar 2024",
help=(
"Use the ECS worker instead."
" Refer to the upgrade guide for more information:"
" https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/."
),
)
class ECSTask(Infrastructure):
"""
Run a command as an ECS task.
Attributes:
type: The slug for this task type with a default value of "ecs-task".
aws_credentials: The AWS credentials to use to connect to ECS with a
default factory of AwsCredentials.
task_definition_arn: An optional identifier for an existing task definition
to use. If fields are set on the ECSTask that conflict with the task
definition, a new copy will be registered with the required values.
Cannot be used with task_definition. If not provided, Prefect will
generate and register a minimal task definition.
task_definition: An optional ECS task definition to use. Prefect may set
defaults or override fields on this task definition to match other
ECSTask fields. Cannot be used with task_definition_arn.
If not provided, Prefect will generate and register
a minimal task definition.
family: An optional family for the task definition. If not provided,
it will be inferred from the task definition. If the task definition
does not have a family, the name will be generated. When flow and
deployment metadata is available, the generated name will include
their names. Values for this field will be slugified to match
AWS character requirements.
image: An optional image to use for the Prefect container in the task.
If this value is not null, it will override the value in the task
definition. This value defaults to a Prefect base image matching
your local versions.
auto_deregister_task_definition: A boolean that controls if any task
definitions that are created by this block will be deregistered
or not. Existing task definitions linked by ARN will never be
deregistered. Deregistering a task definition does not remove
it from your AWS account, instead it will be marked as INACTIVE.
cpu: The amount of CPU to provide to the ECS task. Valid amounts are
specified in the AWS documentation. If not provided, a default
value of ECS_DEFAULT_CPU will be used unless present on
the task definition.
memory: The amount of memory to provide to the ECS task.
Valid amounts are specified in the AWS documentation.
If not provided, a default value of ECS_DEFAULT_MEMORY
will be used unless present on the task definition.
execution_role_arn: An execution role to use for the task.
This controls the permissions of the task when it is launching.
If this value is not null, it will override the value in the task
definition. An execution role must be provided to capture logs
from the container.
configure_cloudwatch_logs: A boolean that controls if the Prefect
container will be configured to send its output to the
AWS CloudWatch logs service or not. This functionality requires
an execution role with permissions to create log streams and groups.
cloudwatch_logs_options: A dictionary of options to pass to
the CloudWatch logs configuration.
stream_output: A boolean indicating whether logs will be
streamed from the Prefect container to the local console.
launch_type: An optional launch type for the ECS task run infrastructure.
vpc_id: An optional VPC ID to link the task run to.
This is only applicable when using the 'awsvpc' network mode for your task.
cluster: An optional ECS cluster to run the task in.
The ARN or name may be provided. If not provided,
the default cluster will be used.
env: A dictionary of environment variables to provide to
the task run. These variables are set on the
Prefect container at task runtime.
task_role_arn: An optional role to attach to the task run.
This controls the permissions of the task while it is running.
task_customizations: A list of JSON 6902 patches to apply to the task
run request. If a string is given, it will parsed as a JSON expression.
task_start_timeout_seconds: The amount of time to watch for the
start of the ECS task before marking it as failed. The task must
enter a RUNNING state to be considered started.
task_watch_poll_interval: The amount of time to wait between AWS API
calls while monitoring the state of an ECS task.
"""
_block_type_slug = "ecs-task"
_block_type_name = "ECS Task"
_logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d74b16fe84ce626345adf235a47008fea2869a60-225x225.png" # noqa
_description = "Run a command as an ECS task." # noqa
_documentation_url = (
"https://prefecthq.github.io/prefect-aws/ecs/#prefect_aws.ecs.ECSTask" # noqa
)
type: Literal["ecs-task"] = Field(
"ecs-task", description="The slug for this task type."
)
aws_credentials: AwsCredentials = Field(
title="AWS Credentials",
default_factory=AwsCredentials,
description="The AWS credentials to use to connect to ECS.",
)
# Task definition settings
task_definition_arn: Optional[str] = Field(
default=None,
description=(
"An identifier for an existing task definition to use. If fields are set "
"on the `ECSTask` that conflict with the task definition, a new copy "
"will be registered with the required values. "
"Cannot be used with `task_definition`. If not provided, Prefect will "
"generate and register a minimal task definition."
),
)
task_definition: Optional[dict] = Field(
default=None,
description=(
"An ECS task definition to use. Prefect may set defaults or override "
"fields on this task definition to match other `ECSTask` fields. "
"Cannot be used with `task_definition_arn`. If not provided, Prefect will "
"generate and register a minimal task definition."
),
)
family: Optional[str] = Field(
default=None,
description=(
"A family for the task definition. If not provided, it will be inferred "
"from the task definition. If the task definition does not have a family, "
"the name will be generated. When flow and deployment metadata is "
"available, the generated name will include their names. Values for this "
"field will be slugified to match AWS character requirements."
),
)
image: Optional[str] = Field(
default=None,
description=(
"The image to use for the Prefect container in the task. If this value is "
"not null, it will override the value in the task definition. This value "
"defaults to a Prefect base image matching your local versions."
),
)
auto_deregister_task_definition: bool = Field(
default=True,
description=(
"If set, any task definitions that are created by this block will be "
"deregistered. Existing task definitions linked by ARN will never be "
"deregistered. Deregistering a task definition does not remove it from "
"your AWS account, instead it will be marked as INACTIVE."
),
)
# Mixed task definition / run settings
cpu: int = Field(
title="CPU",
default=None,
description=(
"The amount of CPU to provide to the ECS task. Valid amounts are "
"specified in the AWS documentation. If not provided, a default value of "
f"{ECS_DEFAULT_CPU} will be used unless present on the task definition."
),
)
memory: int = Field(
default=None,
description=(
"The amount of memory to provide to the ECS task. Valid amounts are "
"specified in the AWS documentation. If not provided, a default value of "
f"{ECS_DEFAULT_MEMORY} will be used unless present on the task definition."
),
)
execution_role_arn: str = Field(
title="Execution Role ARN",
default=None,
description=(
"An execution role to use for the task. This controls the permissions of "
"the task when it is launching. If this value is not null, it will "
"override the value in the task definition. An execution role must be "
"provided to capture logs from the container."
),
)
configure_cloudwatch_logs: bool = Field(
default=None,
description=(
"If `True`, the Prefect container will be configured to send its output "
"to the AWS CloudWatch logs service. This functionality requires an "
"execution role with logs:CreateLogStream, logs:CreateLogGroup, and "
"logs:PutLogEvents permissions. The default for this field is `False` "
"unless `stream_output` is set."
),
)
cloudwatch_logs_options: Dict[str, str] = Field(
default_factory=dict,
description=(
"When `configure_cloudwatch_logs` is enabled, this setting may be used to "
"pass additional options to the CloudWatch logs configuration or override "
"the default options. See the AWS documentation for available options. "
"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html#create_awslogs_logdriver_options." # noqa
),
)
stream_output: bool = Field(
default=None,
description=(
"If `True`, logs will be streamed from the Prefect container to the local "
"console. Unless you have configured AWS CloudWatch logs manually on your "
"task definition, this requires the same prerequisites outlined in "
"`configure_cloudwatch_logs`."
),
)
# Task run settings
launch_type: Optional[Literal["FARGATE", "EC2", "EXTERNAL", "FARGATE_SPOT"]] = (
Field(
default="FARGATE",
description=(
"The type of ECS task run infrastructure that should be used. Note that"
" 'FARGATE_SPOT' is not a formal ECS launch type, but we will configure"
" the proper capacity provider strategy if set here."
),
)
)
vpc_id: Optional[str] = Field(
title="VPC ID",
default=None,
description=(
"The AWS VPC to link the task run to. This is only applicable when using "
"the 'awsvpc' network mode for your task. FARGATE tasks require this "
"network mode, but for EC2 tasks the default network mode is 'bridge'. "
"If using the 'awsvpc' network mode and this field is null, your default "
"VPC will be used. If no default VPC can be found, the task run will fail."
),
)
cluster: Optional[str] = Field(
default=None,
description=(
"The ECS cluster to run the task in. The ARN or name may be provided. If "
"not provided, the default cluster will be used."
),
)
env: Dict[str, Optional[str]] = Field(
title="Environment Variables",
default_factory=dict,
description=(
"Environment variables to provide to the task run. These variables are set "
"on the Prefect container at task runtime. These will not be set on the "
"task definition."
),
)
task_role_arn: str = Field(
title="Task Role ARN",
default=None,
description=(
"A role to attach to the task run. This controls the permissions of the "
"task while it is running."
),
)
task_customizations: JsonPatch = Field(
default_factory=lambda: JsonPatch([]),
description=(
"A list of JSON 6902 patches to apply to the task run request. "
"If a string is given, it will parsed as a JSON expression."
),
)
# Execution settings
task_start_timeout_seconds: int = Field(
default=120,
description=(
"The amount of time to watch for the start of the ECS task "
"before marking it as failed. The task must enter a RUNNING state to be "
"considered started."
),
)
task_watch_poll_interval: float = Field(
default=5.0,
description=(
"The amount of time to wait between AWS API calls while monitoring the "
"state of an ECS task."
),
)
@root_validator(pre=True)
def set_default_configure_cloudwatch_logs(cls, values: dict) -> dict:
"""
Streaming output generally requires CloudWatch logs to be configured.
To avoid entangled arguments in the simple case, `configure_cloudwatch_logs`
defaults to matching the value of `stream_output`.
"""
configure_cloudwatch_logs = values.get("configure_cloudwatch_logs")
if configure_cloudwatch_logs is None:
values["configure_cloudwatch_logs"] = values.get("stream_output")
return values
@root_validator
def configure_cloudwatch_logs_requires_execution_role_arn(
cls, values: dict
) -> dict:
"""
Enforces that an execution role arn is provided (or could be provided by a
runtime task definition) when configuring logging.
"""
if (
values.get("configure_cloudwatch_logs")
and not values.get("execution_role_arn")
# Do not raise if they've linked to another task definition or provided
# it without using our shortcuts
and not values.get("task_definition_arn")
and not (values.get("task_definition") or {}).get("executionRoleArn")
):
raise ValueError(
"An `execution_role_arn` must be provided to use "
"`configure_cloudwatch_logs` or `stream_logs`."
)
return values
@root_validator
def cloudwatch_logs_options_requires_configure_cloudwatch_logs(
cls, values: dict
) -> dict:
"""
Enforces that an execution role arn is provided (or could be provided by a
runtime task definition) when configuring logging.
"""
if values.get("cloudwatch_logs_options") and not values.get(
"configure_cloudwatch_logs"
):
raise ValueError(
"`configure_cloudwatch_log` must be enabled to use "
"`cloudwatch_logs_options`."
)
return values
@root_validator(pre=True)
def image_is_required(cls, values: dict) -> dict:
"""
Enforces that an image is available if image is `None`.
"""
has_image = bool(values.get("image"))
has_task_definition_arn = bool(values.get("task_definition_arn"))
# The image can only be null when the task_definition_arn is set
if has_image or has_task_definition_arn:
return values
prefect_container = (
get_prefect_container(
(values.get("task_definition") or {}).get("containerDefinitions", [])
)
or {}
)
image_in_task_definition = prefect_container.get("image")
# If a task_definition is given with a prefect container image, use that value
if image_in_task_definition:
values["image"] = image_in_task_definition
# Otherwise, it should default to the Prefect base image
else:
values["image"] = get_prefect_image_name()
return values
@validator("task_customizations", pre=True)
def cast_customizations_to_a_json_patch(
cls, value: Union[List[Dict], JsonPatch, str]
) -> JsonPatch:
"""
Casts lists to JsonPatch instances.
"""
if isinstance(value, str):
value = json.loads(value)
if isinstance(value, list):
return JsonPatch(value)
return value # type: ignore
class Config:
"""Configuration of pydantic."""
# Support serialization of the 'JsonPatch' type
arbitrary_types_allowed = True
json_encoders = {JsonPatch: lambda p: p.patch}
def dict(self, *args, **kwargs) -> Dict:
"""
Convert to a dictionary.
"""
# Support serialization of the 'JsonPatch' type
d = super().dict(*args, **kwargs)
d["task_customizations"] = self.task_customizations.patch
return d
def prepare_for_flow_run(
self: Self,
flow_run: "FlowRun",
deployment: Optional["Deployment"] = None,
flow: Optional["Flow"] = None,
) -> Self:
"""
Return an copy of the block that is prepared to execute a flow run.
"""
new_family = None
# Update the family if not specified elsewhere
if (
not self.family
and not self.task_definition_arn
and not (self.task_definition and self.task_definition.get("family"))
):
if flow and deployment:
new_family = f"{ECS_DEFAULT_FAMILY}__{flow.name}__{deployment.name}"
elif flow and not deployment:
new_family = f"{ECS_DEFAULT_FAMILY}__{flow.name}"
elif deployment and not flow:
# This is a weird case and should not be see in the wild
new_family = f"{ECS_DEFAULT_FAMILY}__unknown-flow__{deployment.name}"
new = super().prepare_for_flow_run(flow_run, deployment=deployment, flow=flow)
if new_family:
return new.copy(update={"family": new_family})
else:
# Avoid an extra copy if not needed
return new
@sync_compatible
async def run(self, task_status: Optional[TaskStatus] = None) -> ECSTaskResult:
"""
Run the configured task on ECS.
"""
boto_session, ecs_client = await run_sync_in_worker_thread(
self._get_session_and_client
)
(
task_arn,
cluster_arn,
task_definition,
is_new_task_definition,
) = await run_sync_in_worker_thread(
self._create_task_and_wait_for_start, boto_session, ecs_client
)
# Display a nice message indicating the command and image
command = self.command or get_prefect_container(
task_definition["containerDefinitions"]
).get("command", [])
self.logger.info(
f"{self._log_prefix}: Running command {' '.join(command)!r} "
f"in container {PREFECT_ECS_CONTAINER_NAME!r} ({self.image})..."
)
# The task identifier is "{cluster}::{task}" where we use the configured cluster
# if set to preserve matching by name rather than arn
# Note "::" is used despite the Prefect standard being ":" because ARNs contain
# single colons.
identifier = (self.cluster if self.cluster else cluster_arn) + "::" + task_arn
if task_status:
task_status.started(identifier)
status_code = await run_sync_in_worker_thread(
self._watch_task_and_get_exit_code,
task_arn,
cluster_arn,
task_definition,
is_new_task_definition and self.auto_deregister_task_definition,
boto_session,
ecs_client,
)
return ECSTaskResult(
identifier=identifier,
# If the container does not start the exit code can be null but we must
# still report a status code. We use a -1 to indicate a special code.
status_code=status_code if status_code is not None else -1,
)
@sync_compatible
async def kill(self, identifier: str, grace_seconds: int = 30) -> None:
"""
Kill a task running on ECS.
Args:
identifier: A cluster and task arn combination. This should match a value
yielded by `ECSTask.run`.
"""
if grace_seconds != 30:
self.logger.warning(
f"Kill grace period of {grace_seconds}s requested, but AWS does not "
"support dynamic grace period configuration so 30s will be used. "
"See https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html for configuration of grace periods." # noqa
)
cluster, task = parse_task_identifier(identifier)
await run_sync_in_worker_thread(self._stop_task, cluster, task)
@staticmethod
def get_corresponding_worker_type() -> str:
"""Return the corresponding worker type for this infrastructure block."""
return ECSWorker.type
async def generate_work_pool_base_job_template(self) -> dict:
"""
Generate a base job template for a cloud-run work pool with the same
configuration as this block.
Returns:
- dict: a base job template for a cloud-run work pool
"""
base_job_template = copy.deepcopy(ECSWorker.get_default_base_job_template())
for key, value in self.dict(exclude_unset=True, exclude_defaults=True).items():
if key == "command":
base_job_template["variables"]["properties"]["command"]["default"] = (
shlex.join(value)
)
elif key in [
"type",
"block_type_slug",
"_block_document_id",
"_block_document_name",
"_is_anonymous",
"task_customizations",
]:
continue
elif key == "aws_credentials":
if not self.aws_credentials._block_document_id:
raise BlockNotSavedError(
"It looks like you are trying to use a block that"
" has not been saved. Please call `.save` on your block"
" before publishing it as a work pool."
)
base_job_template["variables"]["properties"]["aws_credentials"][
"default"
] = {
"$ref": {
"block_document_id": str(
self.aws_credentials._block_document_id
)
}
}
elif key == "task_definition":
base_job_template["job_configuration"]["task_definition"] = value
elif key in base_job_template["variables"]["properties"]:
base_job_template["variables"]["properties"][key]["default"] = value
else:
self.logger.warning(
f"Variable {key!r} is not supported by Cloud Run work pools."
" Skipping."
)
if self.task_customizations:
network_config_patches = JsonPatch(
[
patch
for patch in self.task_customizations
if "networkConfiguration" in patch["path"]
]
)
minimal_network_config = assemble_document_for_patches(
network_config_patches
)
if minimal_network_config:
minimal_network_config_with_patches = network_config_patches.apply(
minimal_network_config
)
base_job_template["variables"]["properties"]["network_configuration"][
"default"
] = minimal_network_config_with_patches["networkConfiguration"]
try:
base_job_template["job_configuration"]["task_run_request"] = (
self.task_customizations.apply(
base_job_template["job_configuration"]["task_run_request"]
)
)
except JsonPointerException:
self.logger.warning(
"Unable to apply task customizations to the base job template."
"You may need to update the template manually."
)
return base_job_template
def _stop_task(self, cluster: str, task: str) -> None:
"""
Stop a running ECS task.
"""
if self.cluster is not None and cluster != self.cluster:
raise InfrastructureNotAvailable(
"Cannot stop ECS task: this infrastructure block has access to "
f"cluster {self.cluster!r} but the task is running in cluster "
f"{cluster!r}."
)
_, ecs_client = self._get_session_and_client()
try:
ecs_client.stop_task(cluster=cluster, task=task)
except Exception as exc:
# Raise a special exception if the task does not exist
if "ClusterNotFound" in str(exc):
raise InfrastructureNotFound(
f"Cannot stop ECS task: the cluster {cluster!r} could not be found."
) from exc
if "not find task" in str(exc) or "referenced task was not found" in str(
exc
):
raise InfrastructureNotFound(
f"Cannot stop ECS task: the task {task!r} could not be found in "
f"cluster {cluster!r}."
) from exc
if "no registered tasks" in str(exc):
raise InfrastructureNotFound(
f"Cannot stop ECS task: the cluster {cluster!r} has no tasks."
) from exc
# Reraise unknown exceptions
raise
@property
def _log_prefix(self) -> str:
"""
Internal property for generating a prefix for logs where `name` may be null
"""
if self.name is not None:
return f"ECSTask {self.name!r}"
else:
return "ECSTask"
def _get_session_and_client(self) -> Tuple[boto3.Session, _ECSClient]:
"""
Retrieve a boto3 session and ECS client
"""
boto_session = self.aws_credentials.get_boto3_session()
ecs_client = boto_session.client("ecs")
return boto_session, ecs_client
def _create_task_and_wait_for_start(
self, boto_session: boto3.Session, ecs_client: _ECSClient
) -> Tuple[str, str, dict, bool]:
"""
Register the task definition, create the task run, and wait for it to start.
Returns a tuple of
- The task ARN
- The task's cluster ARN
- The task definition
- A bool indicating if the task definition is newly registered
"""
new_task_definition_registered = False
requested_task_definition = (
self._retrieve_task_definition(ecs_client, self.task_definition_arn)
if self.task_definition_arn
else self.task_definition
) or {}
task_definition_arn = requested_task_definition.get("taskDefinitionArn", None)
task_definition = self._prepare_task_definition(
requested_task_definition, region=ecs_client.meta.region_name
)
# We must register the task definition if the arn is null or changes were made
if task_definition != requested_task_definition or not task_definition_arn:
# Before registering, check if the latest task definition in the family
# can be used
latest_task_definition = self._retrieve_latest_task_definition(
ecs_client, task_definition["family"]
)
if self._task_definitions_equal(latest_task_definition, task_definition):
self.logger.debug(
f"{self._log_prefix}: The latest task definition matches the "
"required task definition; using that instead of registering a new "
" one."
)
task_definition_arn = latest_task_definition["taskDefinitionArn"]
else:
if task_definition_arn:
self.logger.warning(
f"{self._log_prefix}: Settings require changes to the linked "
"task definition. A new task definition will be registered. "
+ (
"Enable DEBUG level logs to see the difference."
if self.logger.level > logging.DEBUG
else ""
)
)
self.logger.debug(
f"{self._log_prefix}: Diff for requested task definition"
+ _pretty_diff(requested_task_definition, task_definition)
)
else:
self.logger.info(
f"{self._log_prefix}: Registering task definition..."
)
self.logger.debug(
"Task definition payload\n" + yaml.dump(task_definition)
)
task_definition_arn = self._register_task_definition(
ecs_client, task_definition
)
new_task_definition_registered = True
if task_definition.get("networkMode") == "awsvpc":
network_config = self._load_vpc_network_config(self.vpc_id, boto_session)
else:
network_config = None
task_run = self._prepare_task_run(
network_config=network_config,
task_definition_arn=task_definition_arn,
)
self.logger.info(f"{self._log_prefix}: Creating task run...")
self.logger.debug("Task run payload\n" + yaml.dump(task_run))
try:
task = self._run_task(ecs_client, task_run)
task_arn = task["taskArn"]
cluster_arn = task["clusterArn"]
except Exception as exc:
self._report_task_run_creation_failure(task_run, exc)
# Raises an exception if the task does not start
self.logger.info(f"{self._log_prefix}: Waiting for task run to start...")
self._wait_for_task_start(
task_arn, cluster_arn, ecs_client, timeout=self.task_start_timeout_seconds
)
return task_arn, cluster_arn, task_definition, new_task_definition_registered
def _watch_task_and_get_exit_code(
self,
task_arn: str,
cluster_arn: str,
task_definition: dict,
deregister_task_definition: bool,
boto_session: boto3.Session,
ecs_client: _ECSClient,
) -> Optional[int]:
"""
Wait for the task run to complete and retrieve the exit code of the Prefect
container.
"""
# Wait for completion and stream logs
task = self._wait_for_task_finish(
task_arn, cluster_arn, task_definition, ecs_client, boto_session
)
if deregister_task_definition:
ecs_client.deregister_task_definition(
taskDefinition=task["taskDefinitionArn"]
)
# Check the status code of the Prefect container
prefect_container = get_prefect_container(task["containers"])
assert (
prefect_container is not None
), f"'prefect' container missing from task: {task}"
status_code = prefect_container.get("exitCode")
self._report_container_status_code(PREFECT_ECS_CONTAINER_NAME, status_code)
return status_code
def _task_definitions_equal(self, taskdef_1, taskdef_2) -> bool:
"""
Compare two task definitions.
Since one may come from the AWS API and have populated defaults, we do our best
to homogenize the definitions without changing their meaning.
"""
if taskdef_1 == taskdef_2:
return True
if taskdef_1 is None or taskdef_2 is None:
return False
taskdef_1 = copy.deepcopy(taskdef_1)
taskdef_2 = copy.deepcopy(taskdef_2)
def _set_aws_defaults(taskdef):
"""Set defaults that AWS would set after registration"""
container_definitions = taskdef.get("containerDefinitions", [])
essential = any(
container.get("essential") for container in container_definitions
)
if not essential:
container_definitions[0].setdefault("essential", True)
taskdef.setdefault("networkMode", "bridge")
_set_aws_defaults(taskdef_1)
_set_aws_defaults(taskdef_2)