OpenMetadata/openmetadata-docs/content/v1.3.x-SNAPSHOT/connectors/messaging/kafka/yaml.md

title	slug
Run the Kafka Connector Externally	/connectors/messaging/kafka/yaml

Run the Kafka Connector Externally

In 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
• Metadata Ingestion

{% partial file="/v1.3/connectors/external-ingestion-deployment.md" /%}

Requirements

{%inlineCallout icon="description" bold="OpenMetadata 0.12 or later" href="/deployment"%} To deploy OpenMetadata, check the Deployment guides. {%/inlineCallout%}

Python Requirements

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

pip3 install "openmetadata-ingestion[kafka]"

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:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

bootstrapServers: List of brokers as comma separated values of broker host or host:port.

Example: host1:9092,host2:9092

{% /codeInfo %}

{% codeInfo srNumber=2 %}

schemaRegistryURL: URL of the Schema Registry used to ingest the schemas of the topics.

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.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

saslUsername: SASL username for use with the PLAIN and SASL-SCRAM mechanisms.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

saslPassword: SASL password for use with the PLAIN and SASL-SCRAM mechanisms.

{% /codeInfo %}

{% codeInfo srNumber=5 %}

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.

{% /codeInfo %}

{% codeInfo srNumber=6 %}

basicAuthUserInfo: Schema Registry Client HTTP credentials in the form of username:password.

By default, user info is extracted from the URL if present.

{% /codeInfo %}

{% codeInfo srNumber=7 %}

consumerConfig: The accepted additional values for the consumer configuration can be found in the following link.

{% /codeInfo %}

{% codeInfo srNumber=8 %}

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.

{% /codeInfo %}

{% partial file="/v1.3/connectors/yaml/messaging/source-config-def.md" /%}

{% partial file="/v1.3/connectors/yaml/ingestion-sink-def.md" /%}

{% partial file="/v1.3/connectors/yaml/workflow-config-def.md" /%}

{% /codeInfoContainer %}

{% codeBlock fileName="filename.yaml" %}

source:
  type: kafka
  serviceName: local_kafka
  serviceConnection:
    config:
      type: Kafka

      bootstrapServers: localhost:9092

      schemaRegistryURL: http://localhost:8081  # Needs to be a URI

      saslUsername: username

      saslPassword: password

      saslMechanism: PLAIN

      basicAuthUserInfo: username:password

      consumerConfig: {}

      schemaRegistryConfig: {}

{% partial file="/v1.3/connectors/yaml/messaging/source-config.md" /%}

{% partial file="/v1.3/connectors/yaml/ingestion-sink.md" /%}

{% partial file="/v1.3/connectors/yaml/workflow-config.md" /%}

{% /codeBlock %}

{% /codePreview %}

{% partial file="/v1.3/connectors/yaml/ingestion-cli.md" /%}