Run S3 using the Airflow SDK
This page contains the setup guide and reference information for the S3 connector.
Configure and schedule S3 metadata workflows from Airflow:
RequirementsOpenMetadata 1.0 or later
To deploy OpenMetadata, check the Deployment guides.
To run the metadata ingestion, we need the following permissions in AWS:
For all the buckets that we want to ingest, we need to provide the following:
Which is used to fetch the total size in bytes for a bucket and the total number of files. It requires:
To run the S3 ingestion, you will need to install:
All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to S3.
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 Athena:
Source Configuration - Service Connection
- awsAccessKeyId & awsSecretAccessKey: When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and authorize your requests (docs).
Access keys consist of two parts: An access key ID (for example,
AKIAIOSFODNN7EXAMPLE), and a secret access key (for example,
You must use both the access key ID and secret access key together to authenticate your requests.
You can find further information on how to manage your access keys here.
awsSessionToken: If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID and AWS Secrets Access Key. Also, these will include an AWS Session Token.
awsRegion: Each AWS Region is a separate geographic area in which AWS clusters data centers (docs).
As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.
Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the services programmatically, there are different ways in which we can extract and use the rest of AWS configurations.
You can find further information about configuring your credentials here.
endPointURL: To connect programmatically to an AWS service, you use an endpoint. An endpoint is the URL of the entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests.
Find more information on AWS service endpoints.
profileName: A named profile is a collection of settings and credentials that you can apply to a AWS CLI command. When you specify a profile to run a command, the settings and credentials are used to run that command. Multiple named profiles can be stored in the config and credentials files.
You can inform this field if you'd like to use a profile other than
Find here more information about Named profiles for the AWS CLI.
assumeRoleArn: Typically, you use
AssumeRole within your account or for cross-account access. In this field you'll set the
ARN (Amazon Resource Name) of the policy of the other account.
A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call
AssumeRole for the
ARN of the role in the other account.
This is a required field if you'd like to
Find more information on AssumeRole.
assumeRoleSessionName: An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons.
By default, we'll use the name
Find more information about the Role Session Name.
assumeRoleSourceIdentity: The source identity specified by the principal that is calling the
AssumeRole operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role.
Find more information about Source Identity.
Source Configuration - Source Config
sourceConfig is defined here:
containerFilterPattern: Note that the filter supports regex as include or exclude. You can find examples here.
To send the metadata to OpenMetadata, it needs to be specified as
The main property here is the
openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.
For a simple, local installation using our docker containers, this looks like:
Connection Options (Optional): Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
Workflow Configs for Security Provider
We support different security providers. You can find their definitions here.
Openmetadata JWT Auth
- JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.
- You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration. If you need information on configuring the ingestion with other security providers in your bots, you can follow this doc link.
2. Prepare the Ingestion DAG
Create a Python file in your Airflow DAGs directory with the following contents:
Import necessary modules
Workflow class that is being imported is a part of a metadata ingestion framework, which defines a process of getting data from different sources and ingesting it into a central metadata repository.
Here we are also importing all the basic requirements to parse YAMLs, handle dates and build our DAG.
Default arguments for all tasks in the Airflow DAG.
- Default arguments dictionary contains default arguments for tasks in the DAG, including the owner's name, email address, number of retries, retry delay, and execution timeout.
- config: Specifies config for the metadata ingestion as we prepare above.
- metadata_ingestion_workflow(): This code defines a function
metadata_ingestion_workflow()that loads a YAML configuration, creates a
Workflowobject, executes the workflow, checks its status, prints the status to the console, and stops the workflow.
- DAG: creates a DAG using the Airflow framework, and tune the DAG configurations to whatever fits with your requirements
- For more Airflow DAGs creation details visit here.
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.