2021-09-22 18:19:46 +02:00
|
|
|
Copyright Debezium Authors.
|
|
|
|
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
|
|
|
|
2021-10-05 11:19:59 +02:00
|
|
|
# Debezium Kafka Connect REST Extension
|
2021-09-22 18:19:46 +02:00
|
|
|
|
|
|
|
Debezium is an open source distributed platform for change data capture (CDC).
|
|
|
|
|
2021-10-05 11:19:59 +02:00
|
|
|
This repository contains Debezium-specific extensions to Kafka Connect's REST API.
|
2021-09-22 18:19:46 +02:00
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
|
|
1. Install or mount the Debezium Kafka Connect REST Extension jar into a separate
|
|
|
|
Kafka Connect plugin directory.
|
|
|
|
|
2021-10-05 11:19:59 +02:00
|
|
|
For example with Docker Compose:
|
2021-09-22 18:19:46 +02:00
|
|
|
|
|
|
|
```yaml
|
|
|
|
volumes:
|
|
|
|
- debezium-kcd-rest-extension-1.0.0.jar:/kafka/connect/dbz-rest-extension/debezium-kcd-rest-extension-1.0.0.jar
|
|
|
|
```
|
|
|
|
|
|
|
|
2. Register the REST extension with Kafka Connect:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
environment:
|
2021-10-05 11:19:59 +02:00
|
|
|
- CONNECT_REST_EXTENSION_CLASSES=io.debezium.kcrestextension.DebeziumConnectRestExtension
|
2021-09-22 18:19:46 +02:00
|
|
|
```
|
|
|
|
|
2021-10-05 11:19:59 +02:00
|
|
|
or set `rest.extension.classes=io.debezium.kcrestextension.DebeziumConnectRestExtension` in your Kafka Connect properties file.
|
2021-09-22 18:19:46 +02:00
|
|
|
|
|
|
|
## Contribution
|
|
|
|
|
2021-10-05 11:19:59 +02:00
|
|
|
This project is under active development, any contributions are very welcome.
|