Atlas

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.

Requirements

Create Database Service

You need to create database services before ingesting the metadata from Atlas. In OpenMetadata we have to create database services.

To create database service follow these steps:

1. Visit the Services Page

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu.

Find Databases option on left panel of the settings page

2. Create a New Service

Click on the 'Add New Service' button to start the Service creation.

Add a new Service from the Database Services page

3. Complete the ingestion

For ingestion, please click here

4. Pass the Service

Pass the service name in your config like given below

service name

Metadata Ingestion

All connectors are now defined as JSON Schemas. Here you can find the structure to create a connection to Atlas.

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.

Note: Every table ingested will have a tag name AtlasMetadata.atlas_table, that can be found under explore section on top left corner

1. Visit the Services Page

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu.

Find Metadata option on left panel of the settings page

2. Create a New Service

Click on the 'Add New Service' button to start the Service creation.

Add a new Service from the Services page

3. Select the Service Type

Select Atlas as the service type and click Next.

Select your service from the list

4. Name and Describe your Service

Provide a name and description for your service as illustrated below.

Service Name

OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your azuresql service as desired.

Configure the service connection by filling the form

Connection Options

• Host and Port: Host and port of the Atlas service.
• Username: username to connect to the Atlas. This user should have privileges to read all the metadata in Atlas.
• Password: password to connect to the Atlas.
• databaseServiceName: source database of the data source(Database service that you created from UI. example- local_hive)
• messagingServiceName: messaging service source of the data source.
• Entity_Type: Name of the entity type in Atlas.

6. Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.

Test the connection and save the Service

8. Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.

Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.

If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.

After configuring the workflow, you can click on Deploy to create the pipeline.

Schedule the Ingestion Pipeline and Deploy

9. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View the Ingestion Pipeline from the Service Page

Troubleshooting

Workflow Deployment Error

If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.

• You can then edit the Ingestion Pipeline and Deploy it again.

• From the Connection tab, you can also Edit the Service if needed.

Edit and Deploy the Ingestion Pipeline

1. Define the YAML Config

This is a sample config for Atlas:

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. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

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.