Collibra
BETAIn this section, we provide guides and references to use the Collibra connector.
Configure and schedule Collibra metadata 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.
Requirements
To connect to Collibra, you will need:
- Username: A user account with privileges to read all metadata in Collibra
- Password: The password for the user account
- Host and Port: The URL of your Collibra instance (e.g., https://your-instance.collibra.com)
Data Mapping and Assumptions
Following entities are supported and will be mapped to the OpenMetadata entities as shown below.
| Collibra Entity | OpenMetadata Entity |
|---|---|
| Glossary | Glossary |
| Glossary Terms | Glossary Terms |
| Domains | Domains |
| Communities | Domains |
- Collibra glossaries will be mapped to OpenMetadata glossaries with their terms and relationships preserved.
- When Enable Asset Enrichment is enabled, the connector will match Collibra assets to existing OpenMetadata entities and enrich them with descriptions, tags, and ownership information from Collibra without creating new assets.
Python Requirements
To run the Collibra ingestion, you will need to install:
Metadata Ingestion
All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Collibra.
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
Source Configuration - Service Connection
hostPort: Host and port of the Collibra instance.
username: Username to connect to Collibra. This user should have privileges to read all the metadata in Collibra.
password: Password for the Collibra user account.
glossaryFilterPattern: Regex pattern to include or exclude glossaries based on their names. Use this to control which glossaries are ingested.
Examples:
- Include specific glossaries:
^(BusinessGlossary|DataGlossary)$ - Exclude test glossaries:
^(?!.*test).*$
domainFilterPattern: Regex pattern to include or exclude domains and communities based on their names.
Examples:
- Include specific domains:
^(Finance|Sales)$ - Exclude archived domains:
^(?!.*archived).*$
enableEnrichment: When enabled, the connector will enrich existing OpenMetadata assets with metadata from Collibra (descriptions, tags, owners) by matching Collibra assets to OpenMetadata entities. This will not create new assets, only update existing ones.
By default, this is set to false.
Sink Configuration
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.
Workflow Configuration
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.
Store Service Connection
If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.
If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.
Store Service Connection
If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.
If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.
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.caCertificate 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.
ingestionPipelineFQN
Fully qualified name of ingestion pipeline, used to identify the current ingestion pipeline.
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.