Skip to main content
Airflow

Airflow

PROD
In this section, we provide guides and references to use the Airflow connector. Configure and schedule Airflow metadata and profiler workflows from the OpenMetadata UI:

​
How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

​
Python Requirements

We have support for Python versions 3.9-3.11
To run the Airflow ingestion, you will need to install: 
pip3 install "openmetadata-ingestion[airflow]"
Note that this installs the same Airflow version that we ship in the Ingestion Container. If you are running the ingestion from Airflow already, you DON’T NEED to install the airflow plugin. Instead, just run pip3 install "openmetadata-ingestion".
Note: we only support officially supported Airflow versions. You can check the version list here.

​
Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Airflow. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server. The workflow is modeled around the following JSON Schema

​
1. Define the YAML Config

This is a sample config for Airflow:

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.