# 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 asyncio
from contextlib import contextmanager
from datetime import datetime
from typing import TYPE_CHECKING
import boto3
from kubernetes.client import V1Container, V1ObjectMeta, V1Pod, V1PodSpec
from airflow.providers.amazon.aws.hooks.eks import ClusterStates, EksHook, NodegroupStates
from airflow.providers.amazon.aws.operators.eks import (
EksCreateClusterOperator,
EksCreateNodegroupOperator,
EksDeleteClusterOperator,
EksDeleteNodegroupOperator,
EksPodExecOperator,
EksPodOperator,
)
from airflow.providers.amazon.aws.sensors.eks import EksClusterStateSensor, EksNodegroupStateSensor
from airflow.providers.cncf.kubernetes.hooks.kubernetes import KubernetesHook
from airflow.providers.cncf.kubernetes.utils.pod_manager import PodManager
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 path
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
if TYPE_CHECKING:
from collections.abc import Generator
from kubernetes.client import CoreV1Api
[docs]
DAG_ID = "example_eks_with_nodegroups"
[docs]
EXPECTED_EXEC_OUTPUT = "command executed in existing EKS pod"
# Externally fetched variables:
[docs]
ROLE_ARN_KEY = "ROLE_ARN"
[docs]
SUBNETS_KEY = "SUBNETS"
[docs]
sys_test_context_task = (
SystemTestContextBuilder().add_variable(ROLE_ARN_KEY).add_variable(SUBNETS_KEY, split_string=True).build()
)
@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)
@contextmanager
[docs]
def get_eks_kubernetes_client(cluster_name: str) -> Generator[CoreV1Api, None, None]:
eks_hook = EksHook()
with eks_hook.generate_config_file_with_credentials(
eks_cluster_name=cluster_name, pod_namespace="default"
) as (config_file, _):
yield KubernetesHook(kubernetes_conn_id=None, config_file=config_file).core_v1_client
@task
[docs]
def create_exec_pod(cluster_name: str, pod_name: str) -> None:
pod = V1Pod(
metadata=V1ObjectMeta(name=pod_name, namespace="default"),
spec=V1PodSpec(
containers=[V1Container(name="main", image="busybox:1.38.0", command=["sleep", "3600"])],
restart_policy="Never",
),
)
with get_eks_kubernetes_client(cluster_name) as kube_client:
pod_manager = PodManager(kube_client=kube_client)
created_pod = pod_manager.create_pod(pod)
asyncio.run(pod_manager.await_pod_start(created_pod))
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]
def delete_exec_pod(cluster_name: str, pod_name: str) -> None:
pod = V1Pod(metadata=V1ObjectMeta(name=pod_name, namespace="default"))
with get_eks_kubernetes_client(cluster_name) as kube_client:
PodManager(kube_client=kube_client).delete_pod(pod)
@task
[docs]
def verify_exec_output(output: str) -> None:
if output != EXPECTED_EXEC_OUTPUT:
raise ValueError(f"Unexpected command output: {output!r}")
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]
cluster_name = f"{env_id}-cluster"
nodegroup_name = f"{env_id}-nodegroup"
launch_template_name = f"{env_id}-launch-template"
exec_pod_name = f"{env_id}-exec-pod"
# [START howto_operator_eks_create_cluster]
# Create an Amazon EKS Cluster control plane without attaching compute service.
create_cluster = EksCreateClusterOperator(
task_id="create_cluster",
cluster_name=cluster_name,
cluster_role_arn=test_context[ROLE_ARN_KEY],
resources_vpc_config={"subnetIds": test_context[SUBNETS_KEY]},
compute=None,
)
# [END howto_operator_eks_create_cluster]
# [START howto_sensor_eks_cluster]
await_create_cluster = EksClusterStateSensor(
task_id="await_create_cluster",
cluster_name=cluster_name,
target_state=ClusterStates.ACTIVE,
)
# [END howto_sensor_eks_cluster]
# [START howto_operator_eks_create_nodegroup]
create_nodegroup = EksCreateNodegroupOperator(
task_id="create_nodegroup",
cluster_name=cluster_name,
nodegroup_name=nodegroup_name,
nodegroup_subnets=test_context[SUBNETS_KEY],
nodegroup_role_arn=test_context[ROLE_ARN_KEY],
)
# [END howto_operator_eks_create_nodegroup]
# The launch template enforces IMDSv2 and is required for internal compliance
# when running these system tests on AWS infrastructure. It is not required
# for the operator to work, so I'm placing it outside the demo snippet.
create_nodegroup.create_nodegroup_kwargs = {"launchTemplate": {"name": launch_template_name}}
# [START howto_sensor_eks_nodegroup]
await_create_nodegroup = EksNodegroupStateSensor(
task_id="await_create_nodegroup",
cluster_name=cluster_name,
nodegroup_name=nodegroup_name,
target_state=NodegroupStates.ACTIVE,
)
# [END howto_sensor_eks_nodegroup]
await_create_nodegroup.poke_interval = 10
# [START howto_operator_eks_pod_operator]
start_pod = EksPodOperator(
task_id="run_pod",
pod_name="run_pod",
cluster_name=cluster_name,
image="amazon/aws-cli:latest",
cmds=["sh", "-c", "echo Test Airflow; date"],
labels={"demo": "hello_world"},
get_logs=True,
on_finish_action="keep_pod",
)
# [END howto_operator_eks_pod_operator]
# Keep the pod alive, so we can describe it in case of trouble. It's deleted with the cluster anyway.
start_pod.is_delete_operator_pod = False
# In this specific situation we want to keep the pod to be able to describe it,
# it is cleaned anyway with the cluster later on.
start_pod.is_delete_operator_pod = False
create_exec_pod_task = create_exec_pod(cluster_name, exec_pod_name)
# [START howto_operator_eks_pod_exec]
run_command = EksPodExecOperator(
task_id="run_command_in_existing_pod",
cluster_name=cluster_name,
pod_name=exec_pod_name,
command=["sh", "-c", f"printf '{EXPECTED_EXEC_OUTPUT}'"],
do_xcom_push=True,
)
# [END howto_operator_eks_pod_exec]
exec_output_is_valid = verify_exec_output(run_command.output)
delete_exec_pod_task = delete_exec_pod(cluster_name, exec_pod_name)
describe_pod = get_describe_pod_operator(
cluster_name, pod_name="{{ ti.xcom_pull(key='pod_name', task_ids='run_pod') }}"
)
# only describe the pod if the task above failed, to help diagnose
describe_pod.trigger_rule = TriggerRule.ONE_FAILED
# Wait for nodegroup to be in stable state before deletion
await_nodegroup_stable = EksNodegroupStateSensor(
task_id="await_nodegroup_stable",
trigger_rule=TriggerRule.ALL_DONE,
cluster_name=cluster_name,
nodegroup_name=nodegroup_name,
target_state=NodegroupStates.ACTIVE,
)
# [START howto_operator_eks_delete_nodegroup]
delete_nodegroup = EksDeleteNodegroupOperator(
task_id="delete_nodegroup",
cluster_name=cluster_name,
nodegroup_name=nodegroup_name,
)
# [END howto_operator_eks_delete_nodegroup]
delete_nodegroup.trigger_rule = TriggerRule.ALL_DONE
await_delete_nodegroup = EksNodegroupStateSensor(
task_id="await_delete_nodegroup",
trigger_rule=TriggerRule.ALL_DONE,
cluster_name=cluster_name,
nodegroup_name=nodegroup_name,
target_state=NodegroupStates.NONEXISTENT,
)
# Wait for cluster to be in stable state before deletion
await_cluster_stable = EksClusterStateSensor(
task_id="await_cluster_stable",
trigger_rule=TriggerRule.ALL_DONE,
cluster_name=cluster_name,
target_state=ClusterStates.ACTIVE,
)
# [START howto_operator_eks_delete_cluster]
delete_cluster = EksDeleteClusterOperator(
task_id="delete_cluster",
cluster_name=cluster_name,
)
# [END howto_operator_eks_delete_cluster]
delete_cluster.trigger_rule = TriggerRule.ALL_DONE
await_delete_cluster = EksClusterStateSensor(
task_id="await_delete_cluster",
trigger_rule=TriggerRule.ALL_DONE,
cluster_name=cluster_name,
target_state=ClusterStates.NONEXISTENT,
poke_interval=10,
)
chain(
# TEST SETUP
test_context,
create_launch_template(launch_template_name),
create_cluster,
await_create_cluster,
create_nodegroup,
await_create_nodegroup,
)
chain(
# TEST BODY: EksPodOperator
await_create_nodegroup,
start_pod,
describe_pod,
await_nodegroup_stable,
)
chain(
# TEST BODY: EksPodExecOperator
await_create_nodegroup,
create_exec_pod_task,
run_command,
exec_output_is_valid,
# TEST TEARDOWN
delete_exec_pod_task,
await_nodegroup_stable,
)
chain(
# TEST TEARDOWN
await_nodegroup_stable,
delete_nodegroup, # part of the test AND teardown
await_delete_nodegroup,
await_cluster_stable,
delete_cluster, # part of the test AND teardown
await_delete_cluster,
delete_launch_template(launch_template_name),
)
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)