diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Pipeline/KafkaConnect.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Pipeline/KafkaConnect.md new file mode 100644 index 00000000000..df0a2578289 --- /dev/null +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Pipeline/KafkaConnect.md @@ -0,0 +1,42 @@ +# KafkaConnect +In this section, we provide guides and references to use the KafkaConnect connector. + +## Requirements + +OpenMetadata is integrated with kafkaconnect up to version [3.6.1](https://docs.kafkaconnect.io/getting-started) and will continue to work for future kafkaconnect versions. + +The ingestion framework uses [kafkaconnect python client](https://libraries.io/pypi/kafka-connect-py) to connect to the kafkaconnect instance and perform the API calls. + +You can find further information on the kafkaconnect connector in the [docs](https://docs.open-metadata.org/connectors/pipeline/kafkaconnect). + +## Connection Details +$$section +### Host and Port $(id="hostPort") +Pipeline Service Management URI. This should be specified as a URI string in the format `scheme://hostname:port`. E.g., `http://localhost:8083`, `http://host.docker.internal:8083`. +$$ + +$$section +### KafkaConnect Config $(id="KafkaConnectConfig") +OpenMetadata supports basic authentication (username/password) +`Optional`. +$$ + +$$section +### Username $(id="username") +Username to connect to KafkaConnect. This user should be able to send request to the KafkaConnect API. +$$ + +$$section +### Password $(id="password") +Password to connect to KafkaConnect. +$$ + +$$section +### Verify SSL $(id="verifySSL") +Whether SSL verification should be performed when authenticating. +$$ + +$$section +### Kafka Service Name $(id="messagingServiceName") +The Service Name of the Ingested [Kafka](/connectors/messaging/kafka#4.-name-and-describe-your-service) instance associated with this KafkaConnect instance. +$$