Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at Stonebranch Integration Hub - Terms of Use.

Overview

Apache Airflow is an open source platform created to programmatically author, schedule, and monitor workflows.

This Universal Extension provides the capability to integrate with Apache Airflow and use it as part of your end-to-end Universal Controller workflow, allowing high-level visibility and orchestration of data-oriented jobs or pipelines.

Version Information

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

Software Requirements for Universal Agent

Both Windows and Linux agents are supported.

• Universal Agent for Windows x64 Version 7.0.0.0 and later with python options installed.

• Universal Agent for Linux Version 7.0.0.0 and later with python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.0.0.0 and later.

Supported Apache Airflow Versions

This integration is tested on Apache airflow v2.2.3. It should be compatible with newer versions of Airflow as long as Airflow backward compatibility is preserved.

Key Features

The main key features of this integration are the following.

• Triggering a new DAG run.

• Trigger a DAG run and wait until it reaches state "success" or "failed".

• Information retrieval of a specific DAG run.

• Information retrieval for a task that is part of a specific DAG run.

• Basic authentication (username/password) and SSL protocol.

• Using a proxy between Universal Controller and Apache Airflow server.

Import the Universal Template

To use this downloadable Universal Template, you first must perform the following steps.

1. This Universal Task requires the Resolvable Credentials feature, check that the Resolvable Credentials Permitted system property has been set to true. For more information about Resolvable Credentials click here.

2. To import the Universal Template into your Controller, follow the instructions here.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Configure Universal Task

For the new Universal Task type, create a new task and enter the task-specific details that were created in the Universal Template.

Input Fields

The input fields for this Universal Extension are described in the following table.

Cancellation and Re-Run

In the case of "Trigger DAG Run" Action, the executing task is immediately populating output only field DAG Run Id asynchronously for information purposes and to keep the state of execution in case of "Cancel" and "Re-run". In case of "Re-run", the executing task checks if the DAG Run Id output field is populated and in the case it is not, it will trigger the DAG run.

⚠ Canceling the task execution for Action "Trigger DAG Run" before the DAG Run Id output only field is populated, can lead to undesirable behavior on task "Re-run"

Task Examples

Trigger a new DAG Run

Example of Universal Task for triggering a new DAG Run. In this specific example SSL protocol, as well as a proxy, is used.

Read DAG Run information

Example of Universal Task for getting DAG Run information

Reading Airflow Task Instance information

Example of Universal Task for getting information on Airflow Task instance.

Trigger a DAG run and wait until it reaches state "success" or "failed"

Example of Universal Task for triggering a new DAG Run and waiting for "success" or "failure" state as result.

Task Output

Output Only Fields

The output fields for this Universal Extension are described below.

Exit Codes

The exit codes for this Universal Extension are described in the following table.

Extension Output

The Extension Output for this Universal Extension is in JSON format as described below.

{
   "exit_code":0,
   "status_description":"SUCCESS: Successful Task Execution!",
   "changed":true,
   "invocation":{
      "extension":"ue-airflow",
      "version":"1.1.0",
      "fields":{
         "action":"trigger_dag_run",
         "base_url":"https://foo-airflow-base-url:8443/api/v1",
         "credentials_user":"****",
         "credentials_password":"****",
         "use_ssl":true,
         "trusted_certificate_file": "/home/****/temp/airflow_cert.cer",
         "ssl_verify":false,
         "private_key_certificate":null,
         "public_key_certificate":null,
         "dag_id":"example_sla_dag",
         "dag_run_id":null,
         "task_id":null,
         "use_proxy":false,
         "proxies":null,
         "wait_for_success_or_failure":false,
         "polling_interval":1,
         "dag_run_id_output":null
      }
   },
   "result":{
      "conf":{
         
      },
      "dag_id":"example_sla_dag",
      "dag_run_id":"manual__2022-06-06T10:48:37.891324+00:00",
      "end_date":null,
      "execution_date":"2022-06-06T10:48:37.891324+00:00",
      "external_trigger":true,
      "logical_date":"2022-06-06T10:48:37.891324+00:00",
      "start_date":null,
      "state":"queued"
   }
}

Attribute changed is populated as follows.

• true, in case when a DAG Run is successfully triggered.
• false, in case when DAG Run is not triggered or the Action is "Read DAG Run information" or "Read Task Instance information".

If subsequent tasks in a workflow rely on the output of this Universal Extension then they should rely on Extension Output. The Extension output contains Attribute result. The result section, as displayed above, is based on the response of the related Airflow REST APIs for the respective actions and version 2.2.3. Other versions of Airflow may produce different information as part of the result attribute.

STDOUT and STDERR

STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice.

Document References

This document references the following documents.

Changelog

ue-airflow-1.1.0 (2022-06-10)

Enhancements

• Added: Support for Trigger a DAG run and wait for state "success" or "failed".

ue-airflow-1.0.0 (2022-03-03)

• Initial version.