Installing the DataStax Kafka Connector 1.1.0

Install on Linux-based platform using a binary tarball.

Install the connector from the DataStax distribution binary tarball using an account that has write access to the Kafka configuration directory.

  • The file is located in the conf directory of the DataStax Apache Kafka Connector distribution package.


  • The dse-sink-distributed.json.sample file is located in the conf directory of the DataStax Apache Kafka Connector distribution package.

Supported Apache Kafka versions

Install the DataStax Apache Kafka™ Connector on any of following versions:
  • Confluent 3.3 and later
  • Apache Kafka 0.11 and later



Important: End User License Agreement (EULA). By downloading DataStax products, you confirm that you agree to the processing of information as described in the DataStax website privacy policy and agree to the website terms of use.

Perform the following steps on a Kafka Connect node:

  1. Download the tarball from the DataStax downloads site. Click the Tools tab and then DataStax Apache Kafka Connector. If you agree, enable the Terms checkbox and click the download icon.
  2. Extract the files:
    tar zxf kafka-connect-dse-version_number.tar.gz
    where version_number is the connector version number.
    The following files are unpacked into a directory such as kafka-connect-dse-version_number.
    where version_number is the DSE connector version number.
  3. Configured the DataStax connector JAR using one of the following methods:
    • Move the DataStax connector JAR to the Kafka plugins directory:
      mv installation_location/kafka-connect-dse-version_number.jar kafka_plugins_dir
    • Configure the path to the JAR:
      Apache Kafka 0.11.x and later - Specify the JAR location in the plugin.path parameter in the or file that is passed to the worker start-up scripts. Example:
      Note: Confluent 3.3 and later are supported.
  4. Copy the sample configuration file from kafka-connect-dse-version_number/conf/ to the Kafka configuration directory, which is typically the config or etc directory.
    DataStax provides the following sample files in the conf directory of the connector distribution package:
    • for standalone mode. It is a Java properties file that contains all settings with descriptions. Settings with a default value are commented out.
    • dse-sink-distributed.json.sample for distributed mode. This file is in JSON format and contains all settings, which are enumerated and active. To use the default values, remove settings from the configuration file. JSON does not support comments.
  5. Rename the sample file to or dse-sink.json.
  6. Update the settings as necessary. See the DataStax Apache Kafka Connector configuration parameter reference.
  7. Ensure that the user running Kafka has permission to access the configuration and JAR files.