# 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 __future__ import annotations
import logging
import re
import subprocess
from datetime import datetime, timedelta
import boto3
from airflow.providers.amazon.aws.hooks.eks import ClusterStates, NodegroupStates
from airflow.providers.amazon.aws.operators.eks import EksCreateClusterOperator, EksDeleteClusterOperator
from airflow.providers.amazon.aws.operators.emr import EmrContainerOperator, EmrEksCreateClusterOperator
from airflow.providers.amazon.aws.operators.s3 import (
S3CreateBucketOperator,
S3CreateObjectOperator,
S3DeleteBucketOperator,
)
from airflow.providers.amazon.aws.sensors.eks import EksClusterStateSensor, EksNodegroupStateSensor
from airflow.providers.amazon.aws.sensors.emr import EmrContainerSensor
from tests_common.test_utils.version_compat import AIRFLOW_V_3_0_PLUS
if AIRFLOW_V_3_0_PLUS:
from airflow.sdk import DAG, chain, task
else:
# Airflow 2.10 compat
from airflow.decorators import task # type: ignore[attr-defined,no-redef]
from airflow.models.baseoperator import chain # type: ignore[attr-defined,no-redef]
from airflow.models.dag import DAG # type: ignore[attr-defined,no-redef,assignment]
try:
from airflow.sdk import TriggerRule
except ImportError:
# Compatibility for Airflow < 3.1
from airflow.utils.trigger_rule import TriggerRule # type: ignore[no-redef,attr-defined]
from system.amazon.aws.utils import ENV_ID_KEY, SystemTestContextBuilder
from system.amazon.aws.utils.k8s import get_describe_pod_operator
[docs]
DAG_ID = "example_emr_eks"
# Externally fetched variables
[docs]
ROLE_ARN_KEY = "ROLE_ARN"
[docs]
JOB_ROLE_ARN_KEY = "JOB_ROLE_ARN"
[docs]
JOB_ROLE_NAME_KEY = "JOB_ROLE_NAME"
[docs]
SUBNETS_KEY = "SUBNETS"
[docs]
sys_test_context_task = (
SystemTestContextBuilder()
.add_variable(ROLE_ARN_KEY)
.add_variable(JOB_ROLE_ARN_KEY)
.add_variable(JOB_ROLE_NAME_KEY)
.add_variable(SUBNETS_KEY, split_string=True)
.build()
)
# `emr-containers create-role-associations` / `delete-role-associations` were added in this release.
[docs]
MIN_AWS_CLI_VERSION = (2, 24, 0)
[docs]
S3_FILE_CONTENT = """
k = 1
s = 0
for i in range(1000000):
if i % 2 == 0:
s += 4/k
else:
s -= 4/k
k += 2
print(s)
"""
@task
[docs]
def create_launch_template(template_name: str):
# This launch template enables IMDSv2.
boto3.client("ec2").create_launch_template(
LaunchTemplateName=template_name,
LaunchTemplateData={
"MetadataOptions": {"HttpEndpoint": "enabled", "HttpTokens": "required"},
},
)
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]
def delete_launch_template(template_name: str):
boto3.client("ec2").delete_launch_template(LaunchTemplateName=template_name)
@task
[docs]
def run_eksctl_commands(cluster_name, ns):
# Install eksctl and enable access for EMR on EKS
# See https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/setting-up-cluster-access.html
file = "https://github.com/weaveworks/eksctl/releases/latest/download/eksctl_$(uname -s)_amd64.tar.gz"
commands = f"""
curl --silent --location "{file}" | tar xz -C /tmp &&
/tmp/eksctl create iamidentitymapping --cluster {cluster_name} --namespace {ns} --service-name "emr-containers"
"""
build = subprocess.Popen(
commands,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
_, err = build.communicate()
if build.returncode != 0:
raise RuntimeError(err)
def _install_aws_cli_if_needed():
"""
Ensure an AWS CLI new enough for `emr-containers create-role-associations` is installed.
The role-association subcommands were added in AWS CLI 2.24.0. The task image may ship an
older CLI or none at all, so install a fresh one when what we find is missing or too old.
"""
log = logging.getLogger(__name__)
check = subprocess.run("aws --version", shell=True, capture_output=True, text=True, check=False)
# `aws --version` has written to stderr on some past releases, so check both streams.
version_match = re.search(r"aws-cli/(\d+)\.(\d+)\.(\d+)", f"{check.stdout}{check.stderr}")
if check.returncode == 0 and version_match:
version = tuple(int(part) for part in version_match.groups())
if version >= MIN_AWS_CLI_VERSION:
log.info("AWS CLI %s satisfies the minimum required version.", version)
return
log.info("AWS CLI %s is older than %s; upgrading.", version, MIN_AWS_CLI_VERSION)
else:
log.info("AWS CLI not found; installing.")
install = subprocess.run(
"""
curl --silent "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" &&
unzip -q -o awscliv2.zip &&
./aws/install --update --bin-dir /usr/local/bin --install-dir /usr/local/aws-cli
""",
shell=True,
capture_output=True,
text=True,
check=False,
)
if install.returncode != 0:
raise RuntimeError(f"Failed to install the AWS CLI: {install.stderr}")
@task
[docs]
def install_pod_identity_agent(cluster_name):
"""Install and wait for the EKS Pod Identity Agent add-on.
Each run creates Pod Identity associations scoped to its own cluster. The
role's trust policy stays static.
"""
log = logging.getLogger(__name__)
eks_client = boto3.client("eks")
addon_name = "eks-pod-identity-agent"
eks_client.create_addon(clusterName=cluster_name, addonName=addon_name)
waiter = eks_client.get_waiter("addon_active")
waiter.wait(
clusterName=cluster_name,
addonName=addon_name,
WaiterConfig={"Delay": 10, "MaxAttempts": 60},
)
log.info("Pod Identity Agent addon is ACTIVE on cluster %s", cluster_name)
@task
[docs]
def create_pod_identity_role_associations(cluster_name, namespace, role_name):
# `emr-containers create-role-associations` is a CLI-only helper — it creates
# the three Pod Identity associations (client, driver, executor) that the EMR
# job pods use. There is no boto3 equivalent.
# See https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/setting-up-enable-IAM.html
_install_aws_cli_if_needed()
commands = (
f"aws emr-containers create-role-associations --cluster-name {cluster_name} "
f"--namespace {namespace} --role-name {role_name}"
)
build = subprocess.Popen(
commands,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
_, err = build.communicate()
if build.returncode != 0:
raise RuntimeError(err)
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]
def delete_pod_identity_role_associations(cluster_name, namespace, role_name):
_install_aws_cli_if_needed()
commands = (
f"aws emr-containers delete-role-associations --cluster-name {cluster_name} "
f"--namespace {namespace} --role-name {role_name}"
)
build = subprocess.Popen(
commands,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
_, err = build.communicate()
if build.returncode != 0:
raise RuntimeError(err)
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]
def delete_virtual_cluster(virtual_cluster_id):
boto3.client("emr-containers").delete_virtual_cluster(
id=virtual_cluster_id,
)
with DAG(
dag_id=DAG_ID,
schedule="@once",
start_date=datetime(2021, 1, 1),
catchup=False,
) as dag:
[docs]
test_context = sys_test_context_task()
env_id = test_context[ENV_ID_KEY]
role_arn = test_context[ROLE_ARN_KEY]
subnets = test_context[SUBNETS_KEY]
job_role_arn = test_context[JOB_ROLE_ARN_KEY]
job_role_name = test_context[JOB_ROLE_NAME_KEY]
s3_bucket_name = f"{env_id}-bucket"
eks_cluster_name = f"{env_id}-cluster"
virtual_cluster_name = f"{env_id}-virtual-cluster"
nodegroup_name = f"{env_id}-nodegroup"
eks_namespace = "default"
launch_template_name = f"{env_id}-launch-template"
# [START howto_operator_emr_eks_config]
job_driver_arg = {
"sparkSubmitJobDriver": {
"entryPoint": f"s3://{s3_bucket_name}/{S3_FILE_NAME}",
"sparkSubmitParameters": "--conf spark.executors.instances=2 --conf spark.executors.memory=2G "
"--conf spark.executor.cores=2 --conf spark.driver.cores=1",
}
}
configuration_overrides_arg = {
"monitoringConfiguration": {
"cloudWatchMonitoringConfiguration": {
"logGroupName": "/emr-eks-jobs",
"logStreamNamePrefix": "airflow",
}
},
}
# [END howto_operator_emr_eks_config]
create_bucket = S3CreateBucketOperator(
task_id="create_bucket",
bucket_name=s3_bucket_name,
)
upload_s3_file = S3CreateObjectOperator(
task_id="upload_s3_file",
s3_bucket=s3_bucket_name,
s3_key=S3_FILE_NAME,
data=S3_FILE_CONTENT,
)
create_cluster_and_nodegroup = EksCreateClusterOperator(
task_id="create_cluster_and_nodegroup",
cluster_name=eks_cluster_name,
nodegroup_name=nodegroup_name,
cluster_role_arn=role_arn,
# Opting to use the same ARN for the cluster and the nodegroup here,
# but a different ARN could be configured and passed if desired.
nodegroup_role_arn=role_arn,
resources_vpc_config={"subnetIds": subnets},
# The launch template enforces IMDSv2 and is required for internal
# compliance when running these system tests on AWS infrastructure.
create_nodegroup_kwargs={"launchTemplate": {"name": launch_template_name}},
)
await_create_nodegroup = EksNodegroupStateSensor(
task_id="await_create_nodegroup",
cluster_name=eks_cluster_name,
nodegroup_name=nodegroup_name,
target_state=NodegroupStates.ACTIVE,
poke_interval=10,
)
# [START howto_operator_emr_eks_create_cluster]
create_emr_eks_cluster = EmrEksCreateClusterOperator(
task_id="create_emr_eks_cluster",
virtual_cluster_name=virtual_cluster_name,
eks_cluster_name=eks_cluster_name,
eks_namespace=eks_namespace,
)
# [END howto_operator_emr_eks_create_cluster]
# [START howto_operator_emr_container]
job_starter = EmrContainerOperator(
task_id="start_job",
virtual_cluster_id=str(create_emr_eks_cluster.output),
execution_role_arn=job_role_arn,
release_label="emr-7.13.0-latest",
job_driver=job_driver_arg,
configuration_overrides=configuration_overrides_arg,
name="pi.py",
)
# [END howto_operator_emr_container]
job_starter.wait_for_completion = True
job_starter.retries = 2
job_starter.retry_delay = timedelta(minutes=2)
# [START howto_sensor_emr_container]
job_waiter = EmrContainerSensor(
task_id="job_waiter",
virtual_cluster_id=str(create_emr_eks_cluster.output),
job_id=str(job_starter.output),
)
# [END howto_sensor_emr_container]
# Describe pods only on failure to help diagnose EMR on EKS job issues.
describe_pod = get_describe_pod_operator(cluster_name=eks_cluster_name, namespace=eks_namespace)
describe_pod.trigger_rule = TriggerRule.ONE_FAILED
delete_eks_cluster = EksDeleteClusterOperator(
task_id="delete_eks_cluster",
cluster_name=eks_cluster_name,
force_delete_compute=True,
trigger_rule=TriggerRule.ALL_DONE,
)
await_delete_eks_cluster = EksClusterStateSensor(
task_id="await_delete_eks_cluster",
cluster_name=eks_cluster_name,
target_state=ClusterStates.NONEXISTENT,
trigger_rule=TriggerRule.ALL_DONE,
poke_interval=10,
)
delete_bucket = S3DeleteBucketOperator(
task_id="delete_bucket",
bucket_name=s3_bucket_name,
force_delete=True,
trigger_rule=TriggerRule.ALL_DONE,
)
chain(
# TEST SETUP
test_context,
create_bucket,
upload_s3_file,
create_launch_template(launch_template_name),
create_cluster_and_nodegroup,
await_create_nodegroup,
run_eksctl_commands(eks_cluster_name, eks_namespace),
install_pod_identity_agent(eks_cluster_name),
create_pod_identity_role_associations(eks_cluster_name, eks_namespace, job_role_name),
# TEST BODY
create_emr_eks_cluster,
job_starter,
job_waiter,
describe_pod,
# TEST TEARDOWN
delete_pod_identity_role_associations(eks_cluster_name, eks_namespace, job_role_name),
delete_virtual_cluster(str(create_emr_eks_cluster.output)),
delete_eks_cluster,
await_delete_eks_cluster,
delete_launch_template(launch_template_name),
delete_bucket,
)
from tests_common.test_utils.watcher import watcher
# This test needs watcher in order to properly mark success/failure
# when "tearDown" task with trigger rule is part of the DAG
list(dag.tasks) >> watcher()
from tests_common.test_utils.system_tests import get_test_run # noqa: E402
# Needed to run the example DAG with pytest (see: contributing-docs/testing/system_tests.rst)
[docs]
test_run = get_test_run(dag)