Task documentation and tags in Apache Airflow - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of task documentation in Airflow?

Task documentation in Airflow helps explain what a task does, making it easier for others (and yourself) to understand the workflow and maintain it over time.

beginner

How do you add documentation to a task in Airflow?

You add documentation to a task by setting the 'doc_md' attribute with markdown text describing the task's purpose and details.

beginner

What are tags used for in Airflow tasks?

Tags help organize and filter tasks in the Airflow UI, making it easier to find and group related tasks.

beginner

How do you assign tags to a task in Airflow?

You assign tags by passing a list of strings to the 'tags' parameter when creating the task.

intermediate

Why is it helpful to use both documentation and tags on Airflow tasks?

Documentation explains what the task does, while tags help organize tasks visually and functionally in the UI, improving workflow clarity and management.

Which attribute is used to add markdown documentation to an Airflow task?

A doc_string

B doc_md

C description

D task_doc

The 'doc_md' attribute is used to add markdown formatted documentation to an Airflow task.

How do tags help in Airflow task management?

A They run tasks faster

B They change task dependencies

C They increase task priority

D They organize and filter tasks in the UI

Tags help organize and filter tasks in the Airflow UI, making it easier to find related tasks.

What data type should be used for the 'tags' parameter in an Airflow task?

A String

B Integer

C List of strings

D Boolean

The 'tags' parameter expects a list of strings to assign multiple tags to a task.

Where can you see the documentation added to an Airflow task?

A In the Airflow UI task details

B In the task logs

C In the DAG code only

D In the scheduler logs

Task documentation added via 'doc_md' is visible in the Airflow UI under the task details.

Which of the following is NOT a benefit of using tags in Airflow tasks?

A Automatic task retries

B Improved task organization

C Easier task filtering

D Better UI grouping

Tags do not affect task retries; they are only for organization and filtering.

Explain how to add documentation and tags to an Airflow task and why each is useful.

Think about how documentation helps understanding and tags help finding tasks.

Describe the benefits of using task documentation and tags in managing Airflow workflows.

Consider how these features help both users and teams.