Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Weiler authored Sep 13, 2021
1 parent a8e458f commit b785f7c
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,48 @@

ConnOR, short for **Conn**ect**O**ffset**R**eset, is a command line tool for resetting Kafka Connect source connector offsets.

<<<<<<< HEAD
=======
# Motivation

When I've started using Kafka Connect in a project, there were a lot of resources on
running Kafka Connect, but almost no resources on resetting Kafka Connect source connector offsets,
which is a something you are doing **a lot** in the beginning.

Thankfully I've stumbled over @rmoff's great blog post [Reset Kafka Connect Source Connector Offsets](https://rmoff.net/2019/08/15/reset-kafka-connect-source-connector-offsets/) which describes the process of resetting source connector offsets in great detail. After applying it manually a few times,
I've decided to encode these manual steps into a commandline tool.

>>>>>>> 8ade3e36a463a36c7044fb4c16d8b95451f6139f
# Features
## Features

* :rocket: Fast startup time and low memory footprint
* :package: No external dependencies
* :rainbow: Colorized output

# Installation
## Installation

## Via [SDKMAN!](https://sdkman.io/)
### Via [SDKMAN!](https://sdkman.io/)

```sh
sdk install connor
```

## Via [Homebrew](https://brew.sh/)
### Via [Homebrew](https://brew.sh/)

```sh
brew tap helpermethod/homebrew-tap
brew install connor
```

## Via [Scoop](https://scoop.sh/)
### Via [Scoop](https://scoop.sh/)

```sh
scoop bucket add helpermethod https://github.com/helpermethod/scoop-helpermethod.git
scopp install connor
```

# Options
## Options

## `--bootstrap-servers`
### `--bootstrap-servers`

A comma-separated list of Kafka broker URLs.

## `--offset-topic`
### `--offset-topic`

The name of the internal topic where Kafka Connect stores its source connector offsets.

## `--connector-name`
### `--connector-name`

The name of the source connector whose offsets you want to reset.

## `--execute`
### `--execute`

Executes the reset. Without this flag, a dry run is performed.

0 comments on commit b785f7c

Please sign in to comment.