UI에 DAG 문서화 추가하기

Web UI

다음과 같이 DAG에 대한 문서화를 작성할 수 있습니다.

또한 다음처럼 Task에 대한 문서화도 작성할 수 있습니다.

Code

from datetime import datetime, timedelta
from time import sleep

from airflow import DAG
from airflow.operators.python import PythonOperator
from pendulum.tz.timezone import Timezone

with DAG(
    dag_id="03_documentation",
    description="문서화를 추가하는 DAG 예제입니다.",
    default_args={
        "owner": "heumsi",
        "retries": 1,
        "retry_delay": timedelta(minutes=1),
    },
    start_date=datetime(2022, 1, 20, tzinfo=Timezone("Asia/Seoul")),
    schedule_interval="@once",
    tags=["examples", "03_visualization_and_documentation_dags"],
    doc_md="""
        ## 문서화를 추가하는 DAG 예제

        코드에서 DAG 인스턴스를 생성할 때 `doc_md` 인자에 문자열을 넘겨주면 됩니다.
        이처럼 마크다운으로 쓰는것이 가능합니다.
    """,
) as dag:

    def dump() -> None:
        sleep(3)

    task_1 = PythonOperator(
        task_id="task_1", python_callable=dump, doc_md="task에 대해서도 문서화를 추가할 수 있습니다."
    )
    task_2 = PythonOperator(task_id="task_2", python_callable=dump)
    task_3 = PythonOperator(task_id="task_3", python_callable=dump)

    task_1 >> task_2 >> task_3

TIP

마크다운(md) 뿐 아니라 json이나 rst형식도 가능합니다. 자세한 내용은 공식 문서 (opens new window)를 확인해보세요.