How to integrate Google Cloud Composer/OpenLineage

To integrate Google Cloud Composer/OpenLineage with Atlan, complete the following steps. To learn more about OpenLineage, refer to OpenLineage configuration and facets.

💪 Did you know? For Apache Airflow operators supported for OpenLineage extraction, you can refer to Airflow's Supported operators documentation. To learn how to extract lineage though OpenLineage methods, custom extractors, or manually annotated lineage, see How to implement OpenLineage in Airflow operators.

Create an API token in Atlan

Before running the workflow, you will need to create an API token in Atlan.

Configure the integration in Atlan

Select the source in Atlan

To select Google Cloud Composer/OpenLineage as your source, from within Atlan:

  1. In the top right of any screen, click New and then click New workflow.
  2. From the filters along the top, click Orchestrator.
  3. From the list of packages, select Google Cloud Composer Airflow Assets and then click Setup Workflow.

Create the connection

You will only need to create a connection once to enable Atlan to receive incoming OpenLineage events. Once you have set up the connection, you neither have to rerun the workflow nor schedule it. Atlan will process the OpenLineage events as and when your DAGs run to catalog your Apache Airflow assets.

To configure the Google Cloud Composer/OpenLineage connection, from within Atlan:

  1. For Connection Name, provide a connection name that represents your source environment. For example, you might use values like production,development,gold, or analytics.
  2. (Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.
    🚨 Careful! If you do not specify any user or group, no one will be able to manage the connection — not even admins.
  3. (Optional) For Host, enter the URL of your Google Cloud Composer Airflow UI. This will allow Atlan to help you view your assets directly in Google Cloud Composer from the asset profile.
  4. (Optional) For Port, enter the port number for your Google Cloud Composer Airflow UI.
  5. For Enable OpenLineage Events, click Yes to enable the processing of OpenLineage events or click No to disable it. If disabled, new events will not be processed in Atlan.
  6. To create a connection, at the bottom of the screen, click the Create connection button.

Configure the integration in Google Cloud Composer

💪 Did you know? You will need the Atlan API token and connection name to configure the integration in Google Cloud Composer. This will allow Google Cloud Composer to connect with the OpenLineage API and send events to Atlan.
🚨 Careful! Atlan does not support integrating with Apache Airflow versions older than 2.5.0.

To configure Google Cloud Composer to send OpenLineage events to Atlan:

  1. You will need to configure Google Cloud Composer for the integration:
    1. Open your Google Cloud console and navigate to the Environments page.
    2. From the list of environments, click the name of your environment. Configure the following:
      • For Apache Airflow versions 2.7.0 onward, set override Airflow configuration options:
        1. In the Environment details page, click the Airflow configuration overrides tab and then click Edit.
        2. In the Airflow configuration overrides form, click the Add Airflow configuration override button to specify the first set of values:
          1. For Section 1, enter openlineage.
          2. For Key 1, enter namespace.
          3. For Value 1, enter the connection name as exactly configured in Atlan.
        3. Click the Add Airflow configuration override button to specify the second set of values:
          1. For Section 2, enter openlineage.
          2. For Key 2, enter transport.
          3. For Value 2, enter the following:
            {
             "type": "http", 
             "url": "https://<instance>.atlan.com/events/openlineage/airflow-cloud-composer/", 
             "auth": {
            "type": "api_key", "api_key": "<API_KEY>" } }
            • For <API_key>, set the API token generated in Atlan.
      • For Apache Airflow versions 2.5.0 onward and prior to 2.7.0, set environment variables:
        1. In the Environment details page, click the Environment variables tab and then click Edit.
        2. Add the following environment variable names and corresponding values:
          • OPENLINEAGE_URL: points to the service that will consume OpenLineage events — for example, https://<instance>.atlan.com/events/openlineage/airflow-cloud-composer/.
          • OPENLINEAGE_API_KEY: set the API token generated in Atlan.
          • OPENLINEAGE_NAMESPACE: set the connection name as exactly configured in Atlan.
        3. Click Save to save your changes.
  2. You will also need to install the OpenLineage PyPI package in Google Cloud Composer. To install the OpenLineage PyPI package in your environment:
    1. In the Environment details page, click the PyPI packages tab and then click Edit.
    2. Click Add package to add a custom package.
    3. Under PyPI packages, for Package name, specify the package name.
      • For Apache Airflow versions 2.7.0 onward:
        apache-airflow-providers-openlineage
      • For Apache Airflow versions 2.5.0 onward:
        openlineage-airflow
    4. Click Save to save your configuration.

Verify the Atlan connection in Google Cloud Composer

To verify connectivity to Google Cloud Composer:

  1. For Verify connection with Cloud Composer, click the clipboard icon to copy and run the preflight check DAG on your Google Cloud Composer instance to test connectivity with Atlan. If you encounter any errors after running the DAG, refer to the preflight checks documentation.
  2. Click Done to complete setup.

Once your DAGs have completed running in Apache Airflow, you will see Apache Airflow DAGs and tasks along with lineage from OpenLineage events in Atlan! 🎉

You can also view event logs in Atlan to track and debug events received from OpenLineage.

Related articles

Was this article helpful?
0 out of 0 found this helpful