connectors

No menu items for this category

Run the Amundsen Connector Externally

In this section, we provide guides and references to use the Amundsen connector.

Configure and schedule Amundsen metadata and profiler workflows from the OpenMetadata UI:

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.

Before this, you must ingest the database / messaging service you want to get metadata for. For more details click here

OpenMetadata 0.12 or later

To deploy OpenMetadata, check the Deployment guides.

To run the Amundsen ingestion, you will need to install:

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

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

hostPort: Host and port of the Amundsen Neo4j Connection. This expect a URI format like: bolt://localhost:7687.

username: Username to connect to the Amundsen. This user should have privileges to read all the metadata in Amundsen.

password: Password to connect to the Amundsen.

maxConnectionLifeTime: Maximum connection lifetime for the Amundsen Neo4j Connection.

validateSSL: Enable SSL validation for the Amundsen Neo4j Connection.

encrypted: Enable encryption for the Amundsen Neo4j Connection.

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

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.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.certificatePath with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.

filename.yaml

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.