aelzeiny / airflow-aws-executors

Airflow Executor for both AWS ECS & AWS Fargate
MIT License
53 stars 9 forks source link

Documentation update suggestion #26

Closed xuganyu96 closed 4 months ago

xuganyu96 commented 1 year ago

There are a few things that the current set of documentation is not clear about.

ECS launch type

The launch type for ECS Fargate Executor is not actually FARGATE by default (if this configuration is not set). I can tell that this executor class is not meant for Fargate exclusively, so it would be nice if the documentation can specify that ECS_FARGATE__LAUNCH_TYPE needs to be explicitly set to FARGATE

Fargate run-task network configuration

The documentation is not clear about the fact that ASSIGN_PUBLIC_IP, SUBNETS, and SECURITY_GROUPS all need to be explicitly set before the networking configurations of run_kwargs are built and fed into the run_task API command to ECS. Without network configuration, the task will not be launched.

Private subnets cannot reach ECR

https://stackoverflow.com/questions/61265108/aws-ecs-fargate-resourceinitializationerror-unable-to-pull-secrets-or-registry

Airflow tasks that are launched into private subnets do not have automatic access to AWS ECR. There are several workarounds mentioned in the stack-overflow post above. It would be nice if the documentation includes gotcha's like this in a FAQ section.