
Kafka
PRODIn this section, we provide guides and references to use the Kafka connector.
Configure and schedule Kafka metadata and profiler workflows from the OpenMetadata UI:
Requirements
Python Requirements
To run the Kafka 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 Kafka.
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 Kafka:
Source Configuration - Service Connection
bootstrapServers: List of brokers as comma separated values of broker host
or host:port
.
Example: host1:9092,host2:9092
schemaRegistryURL: URL of the Schema Registry used to ingest the schemas of the topics.
If you encounter issues connecting to the Schema Registry, ensure that the protocol is explicitly specified in the Schema Registry URL. For example:
- Use
http://localhost:8081
instead oflocalhost:8081
. The Schema Registry requires a properly formatted URL, including the protocol (http://
orhttps://
). While this differentiation is expected in the Schema Registry configuration, it may not be immediately apparent.
NOTE: For now, the schema will be the last version found for the schema name {topic-name}-value
. An issue to improve how it currently works has been opened.
saslUsername: SASL username for use with the PLAIN and SASL-SCRAM mechanisms.
saslPassword: SASL password for use with the PLAIN and SASL-SCRAM mechanisms.
saslMechanism: SASL mechanism to use for authentication.
Supported: GSSAPI, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, OAUTHBEARER.
NOTE: Despite the name only one mechanism must be configured.
basicAuthUserInfo: Schema Registry Client HTTP credentials in the form of username:password
.
By default, user info is extracted from the URL if present.
consumerConfig: The accepted additional values for the consumer configuration can be found in the following link.
schemaRegistryConfig: The accepted additional values for the Schema Registry configuration can be found in the following link.
Note: To ingest the topic schema, schemaRegistryURL
must be passed.
securityProtocol: security.protocol consumer config property. It accepts PLAINTEXT
,SASL_PLAINTEXT
, SASL_SSL
, SSL
.
schemaRegistryTopicSuffixName: Schema Registry Topic Suffix Name. The suffix to be appended to the topic name to get topic schema from registry.
schemaRegistrySSL: Schema Registry SSL Config. Configuration for enabling SSL for the Schema Registry connection.
supportsMetadataExtraction: Supports Metadata Extraction. supportsMetadataExtraction
supports boolean value either true or false.
Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, in the YAML
you can provide the CA certificate used for SSL validation by specifying the caCertificate
. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: ssl key
, ssl cert
, and caCertificate
. In this case, ssl_cert
is used for the client’s SSL certificate, ssl_key
for the private key associated with the SSL certificate, and caCertificate
for the CA certificate to validate the server’s certificate.