# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from datetime import datetime
from airflow import DAG
from airflow.models.baseoperator import chain
from airflow.providers.amazon.aws.hooks.ecs import EcsClusterStates, EcsTaskStates
from airflow.providers.amazon.aws.operators.ecs import (
EcsCreateClusterOperator,
EcsDeleteClusterOperator,
EcsDeregisterTaskDefinitionOperator,
EcsRegisterTaskDefinitionOperator,
EcsRunTaskOperator,
)
from airflow.providers.amazon.aws.sensors.ecs import (
EcsClusterStateSensor,
EcsTaskDefinitionStateSensor,
EcsTaskStateSensor,
)
from airflow.utils.trigger_rule import TriggerRule
[docs]DAG_ID = 'new_ecs_refactor'
# NOTE: Creating a functional ECS Cluster which uses EC2 requires manually creating
# and configuring a number of resources such as autoscaling groups, networking
# etc which is out of scope for this demo and time-consuming for a system test
# To simplify this demo and make it run in a reasonable length of time as a
# system test, follow the steps below to create a new cluster on the AWS Console
# which handles all asset creation and configuration using default values:
# 1. https://us-east-1.console.aws.amazon.com/ecs/home?region=us-east-1#/clusters
# 2. Select "EC2 Linux + Networking" and hit "Next"
# 3. Name your cluster in the first field and click Create
# 4. Enter the name you provided and the subnets that were generated below:
[docs]EXISTING_CLUSTER_NAME = 'using-defaults'
[docs]SUBNETS = ['subnet-08c6deb88019ef902']
with DAG(
dag_id=DAG_ID,
schedule_interval=None,
start_date=datetime(2021, 1, 1),
tags=['example'],
catchup=False,
) as dag:
cluster_name = f'{env_id}-cluster'
container_name = f'{env_id}-container'
family_name = f'{env_id}-task-definition'
asg_name = f'{env_id}-asg'
# [START howto_operator_ecs_create_cluster]
create_cluster = EcsCreateClusterOperator(
task_id='create_cluster',
cluster_name=cluster_name,
wait_for_completion=False,
)
# [END howto_operator_ecs_create_cluster]
# [START howto_sensor_ecs_cluster_state]
await_cluster = EcsClusterStateSensor(
task_id='await_cluster',
cluster_name=cluster_name,
)
# [END howto_sensor_ecs_cluster_state]
# [START howto_operator_ecs_register_task_definition]
register_task = EcsRegisterTaskDefinitionOperator(
task_id='register_task',
family=family_name,
container_definitions=[
{
'name': container_name,
'image': 'ubuntu',
'workingDirectory': '/usr/bin',
'entryPoint': ['sh', '-c'],
'command': ['ls'],
}
],
register_task_kwargs={
'cpu': '256',
'memory': '512',
'networkMode': 'awsvpc',
},
)
# [END howto_operator_ecs_register_task_definition]
# [START howto_sensor_ecs_task_definition_state]
await_task_definition = EcsTaskDefinitionStateSensor(
task_id='await_task_definition',
task_definition=register_task.output,
)
# [END howto_sensor_ecs_task_definition_state]
# [START howto_operator_ecs_run_task]
run_task = EcsRunTaskOperator(
task_id="run_task",
cluster=EXISTING_CLUSTER_NAME,
task_definition=register_task.output,
launch_type="EC2",
overrides={
"containerOverrides": [
{
"name": container_name,
"command": ["echo", "hello", "world"],
},
],
},
network_configuration={'awsvpcConfiguration': {'subnets': SUBNETS}},
tags={
"Customer": "X",
"Project": "Y",
"Application": "Z",
"Version": "0.0.1",
"Environment": "Development",
},
# [START howto_awslogs_ecs]
awslogs_group="/ecs/hello-world",
awslogs_region='us-east-1',
awslogs_stream_prefix="ecs/hello-world-container",
# [END howto_awslogs_ecs]
# NOTE: You must set `reattach=True` in order to get ecs_task_arn if you plan to use a Sensor.
reattach=True,
)
# [END howto_operator_ecs_run_task]
# [START howto_sensor_ecs_task_state]
# By default, EcsTaskStateSensor waits until the task has started, but the
# demo task runs so fast that the sensor misses it. This sensor instead
# demonstrates how to wait until the ECS Task has completed by providing
# the target_state and failure_states parameters.
await_task_finish = EcsTaskStateSensor(
task_id='await_task_finish',
cluster=EXISTING_CLUSTER_NAME,
task='{{ ti.xcom_pull(key="ecs_task_arn") }}',
target_state=EcsTaskStates.STOPPED,
failure_states={EcsTaskStates.NONE},
)
# [END howto_sensor_ecs_task_state]
# [START howto_operator_ecs_deregister_task_definition]
deregister_task = EcsDeregisterTaskDefinitionOperator(
task_id='deregister_task',
trigger_rule=TriggerRule.ALL_DONE,
task_definition=register_task.output,
)
# [END howto_operator_ecs_deregister_task_definition]
# [START howto_operator_ecs_delete_cluster]
delete_cluster = EcsDeleteClusterOperator(
task_id='delete_cluster',
trigger_rule=TriggerRule.ALL_DONE,
cluster_name=cluster_name,
wait_for_completion=False,
)
# [END howto_operator_ecs_delete_cluster]
# [START howto_operator_ecs_delete_cluster]
await_delete_cluster = EcsClusterStateSensor(
task_id='await_delete_cluster',
cluster_name=cluster_name,
target_state=EcsClusterStates.INACTIVE,
)
# [END howto_operator_ecs_delete_cluster]
chain(
create_cluster,
await_cluster,
register_task,
await_task_definition,
run_task,
await_task_finish,
deregister_task,
delete_cluster,
await_delete_cluster,
)
