Getting started

Prerequisites

The Kafka Connect framework v2.8 or later should be installed in the environment.

Installation Instructions

Package Structure

The connectors are distributed in a ZIP file named: init-kafka-connect-odatav4-<connector version>.zip.

The ZIP archive contains the following directories:

  • lib/: This folder includes the Java archive (JAR) that should be extracted into Kafka Connect’s plugin.path.
  • etc/: Contains sample properties files for the connectors.
  • doc/: Provides comprehensive documentation, including licensing information and configuration details.
  • assets/: Contains media assets such as icons and company logos.

Manual Installation

  1. Extract the JAR files from the lib/ directory.
  2. Place these JAR files into the plugin.path directory configured for Kafka Connect.

Confluent CLI Installation

You can also install the connector using the Confluent CLI. For instructions, refer to the Confluent CLI Command Reference.

Quickstart Guides

This section includes two types of guides to help you get started:

  1. Confluent Cloud: Instructions for operating the Connector in a Confluent Cloud environment.
  2. Docker Deployment: Instructions for operating the Confluent Platform within a Docker container.
  3. Local Standalone Mode: Instructions for deploying the OData V4 Connectors with Apache Kafka in a standalone environment.

It also includes a guide on setting up your license key.

Note

For using all the functionalities of the connector, we recommend going for the Confluent Platform.