Skip to main content
In this section, we provide guides and references to use the Redpanda connector. Configure and schedule Redpanda metadata and profiler 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.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

​
Python Requirements

We have support for Python versions 3.9-3.11
To run the Redpanda 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 Redpanda. 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 Redpanda:

​
Source Configuration - Source Config

The sourceConfig is defined here:
  • generateSampleData: Option to turn on or off generating sample data during metadata extraction. It supports boolean values either true or false.
  • topicFilterPattern: Note that the topicFilterPattern supports regex as include or exclude.
  • markDeletedTopics: Optional configuration to soft delete topics in OpenMetadata if the source topics are deleted. Also, if the topic is deleted, all the associated entities like sample data, lineage, etc., with that topic will be deleted. It supports boolean values either true or false.
  • overrideMetadata: Set the Override Metadata toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner, and displayName. It supports boolean values either true or false.
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest. The main property here is openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.
  • loggerLevel: Specify the logger level depending on your needs. If you are troubleshooting an ingestion, use DEBUG for more detailed traces.
  • JWT token: JWT tokens allow clients to authenticate against the OpenMetadata server. See Enable JWT Tokens and JWT Troubleshooting for more information.
  • storeServiceConnection: If set to true (default), sensitive information is stored encrypted with the Fernet Key or externally if you have configured a Secrets Manager. If set to false, the service is created, but the service connection information is only used by the Ingestion Framework at runtime and is not sent to the OpenMetadata server.
  • SSL configuration: If you have added SSL to the OpenMetadata server, configure the certificates for ingestion. Set verifySSL to ignore, or set it to validate and provide sslConfig.caCertificate with a local path to the server certificate. See SSL Troubleshooting for more information.
  • ingestionPipelineFQN: Fully qualified name of the 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.