Docs Menu

Install MongoDB Kafka Connector

On this page

  • Overview
  • Install the Connector on the Confluent Platform
  • Install using the Confluent Hub Client
  • Install Manually
  • Install the Connector on Apache Kafka
  • Installation Reference Table

The MongoDB Kafka Connector is available for Confluent Platform and Apache Kafka deployments. For installation instructions for your deployment type, navigate to one of the following sections:

See the following sections for step-by-step instructions on how to install the connector using the Confluent Hub Client or manually.

  1. Install the Confluent Hub Client if not installed already.
  2. Follow the installation instructions for the MongoDB Connector for Apache Kafka component using the Confluent Hub Client.
  1. Follow the directions on the Confluent page for Manually Installing Community Connectors.
  2. Use the connector GitHub URL and uber JAR locations in the installation reference table when appropriate in the Confluent manual installation instructions.
  1. Locate and download the uber JAR to obtain all the dependencies required for the connector. Refer to the installation reference table to find the uber JAR.

    Note

    If you are unable to use the uber JAR or prefer to manage your own dependencies, download the JAR that contains the minimum required dependencies and resolve any runtime dependencies. You can use a plugin such as Maven depenedency:tree to generate the depedency tree.

  2. Copy the JAR and any dependencies into the Kafka plugins directory which you can specify in your plugin.path configuration setting (e.g. plugin.path=/usr/local/share/kafka/plugins).
Note

If you intend to run the connector as distributed worker processes, you must repeat this process for each server or VM.

You can use the following links to download the MongoDB Kafka Connector JARs. You can identify the contents of the JAR files by the suffix in the filename.

Suffix
Description
all
The uber JAR that contains the connector, MongoDB dependencies, and Apache AVRO
confluent
Contains the minimum requirements for the connector and Confluent Platform
javadoc
Contains the Javadoc documentation for the connector classes
sources
Contains the source code that corresponds to the compiled connector classes

For example, mongo-kafka-connect-1.6-all.jar is the uber JAR for the version 1.6 connector.

You can download the source and JAR files from the following repositories:

Kafka Connector GitHub repository (source code)
Maven Central repository (JAR files)
Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.