https://github.com/bakdata/kafka-connect-resetter
An application to reset the state of Kafka Connect connectors
https://github.com/bakdata/kafka-connect-resetter
Last synced: 3 months ago
JSON representation
An application to reset the state of Kafka Connect connectors
- Host: GitHub
- URL: https://github.com/bakdata/kafka-connect-resetter
- Owner: bakdata
- License: mit
- Created: 2022-09-30T05:26:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T09:34:52.000Z (over 1 year ago)
- Last Synced: 2025-04-10T23:48:12.599Z (about 1 year ago)
- Language: Java
- Size: 293 KB
- Stars: 3
- Watchers: 8
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://dev.azure.com/bakdata/public/_build/latest?definitionId=34&repoName=bakdata%2Fkafka-connect-resetter&branchName=initial)
[](https://sonarcloud.io/summary/new_code?id=com.bakdata.kafka%3Akafka-connect-resetter)
[](https://sonarcloud.io/summary/new_code?id=com.bakdata.kafka%3Akafka-connect-resetter)
# kafka-connect-resetter
An application to reset the state of Kafka Connect connectors.
It is available on [Docker Hub](https://hub.docker.com/r/bakdata/kafka-connect-resetter).
## Usage
You can reset both source and sink connectors using this tool.
### Source resetter
This command resets the state of a Kafka Connect source connector by sending tombstone messages for each stored Kafka
connect offset.
```
Usage: source [-hV] --brokers=
--offset-topic=
[--poll-duration=]
[--config=[,...]]...
Connector to reset
--brokers= List of Kafka brokers
--config=[,...]
Kafka client and producer configuration properties
-h, --help Show this help message and exit.
--offset-topic=
Topic where Kafka connect offsets are stored
--poll-duration=
Consumer poll duration
-V, --version Print version information and exit.
```
### Sink resetter
This command resets or deletes the consumer group of a Kafka Connect sink connector.
```
Usage: sink [-hV] [--delete-consumer-group] --brokers=
[--config=[,...]]...
Connector to reset
--brokers= List of Kafka brokers
--config=[,...]
Kafka client and producer configuration properties
--delete-consumer-group
Whether to delete the consumer group
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
```
### Helm Charts
For the configuration and deployment to Kubernetes, you can use
the [Helm Chart](https://github.com/bakdata/kafka-connect-resetter/tree/master/charts).
## Development
If you want to contribute to this project, you can simply clone the repository and build it via Gradle.
All dependencies should be included in the Gradle files, there are no external prerequisites.
```bash
> git clone git@github.com:bakdata/kafka-connect-resetter.git
> cd kafka-connect-resetter && ./gradlew build
```
Please note, that we have [code styles](https://github.com/bakdata/bakdata-code-styles) for Java.
They are basically the Google style guide, with some small modifications.
## Contributing
We are happy if you want to contribute to this project.
If you find any bugs or have suggestions for improvements, please open an issue.
We are also happy to accept your PRs.
Just open an issue beforehand and let us know what you want to do and why.
## License
This project is licensed under the MIT license.
Have a look at the [LICENSE](https://github.com/bakdata/kafka-connect-resetter/blob/main/LICENSE) for more details.