Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions to install JAR file for kafka sink connector #879

Open
wants to merge 1 commit into
base: 2.5.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions doc/getting_started_jar_kafka.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
- The following are the steps to install the Sink Connector Kafka JAR


**Download or Build the Sink Connector Kafka JAR** \
The Sink Connector Kafka JAR is available
in the releases artifacts or can be built from the source code.
```cd sink-connector
mvn clean package
```
The JAR file is available in the target directory.

**Identify or Create a Plugins Directory** \
Kafka Connect loads connectors from the plugin.path defined in its configuration.
If you haven't configured a plugins directory, create one. For example:
```
/usr/local/kafka/connectors/
```
**Place the JAR File in the Plugins Directory** \
Copy the connector JAR file and its dependencies into a subdirectory inside the plugin path:
```
/usr/local/kafka/connectors/my-sink-connector/
```
**Configure Kafka Connect to Use the Plugins Directory** \\
Edit your Kafka Connect worker properties file (connect-distributed.properties or connect-standalone.properties):
properties
```
plugin.path=/usr/local/kafka/connectors/
```
**Restart Kafka Connect**
Restart Kafka Connect to load the new connector:\

*For distributed mode:*

```
bin/connect-distributed.sh config/connect-distributed.properties
```

*For standalone mode:*
```
bin/connect-standalone.sh config/connect-standalone.properties <connector-config-file>
```
**Verify Connector Installation**

Use the Kafka Connect REST API to verify that the connector is installed:
```
curl -sS localhost:8083/connector-plugins | jq .
```
This command should list your newly installed connector.

**Configure and Start the Sink Connector**

Follow the steps below to configure and start the Sink Connector:

[Kafka Quick Start Guide](quickstart_kafka.md)

**Monitor the Connector**
Use the REST API to monitor the status of your connector:
```
curl -sS localhost:8083/connectors/my-sink-connector/status | jq .
```
3 changes: 3 additions & 0 deletions doc/quickstart_kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Use the following script to build the image
[docker/package-build-sink-on-debezium-base.sh](../docker/package-build-sink-on-debezium-base.sh)
Future: Github releases will push docker images to Docker hub.

## JAR file Setup
Jar file setup instructions are available in the [Getting Started](getting_started_jar_kafka.md) guide.

## docker-compose
Full pipeline can be launched via docker-compose with the help of [docker-compose.yaml][docker-compose.yaml]
It will start:
Expand Down
Loading