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

cdc: add kafka supported version table (#17812) #18053

Merged
Merged
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
15 changes: 14 additions & 1 deletion ticdc/ticdc-sink-to-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ Info: {"sink-uri":"kafka://127.0.0.1:9092/topic-name?protocol=canal-json&kafka-v
- `--target-ts`: Specifies the ending TSO of the changefeed. To this TSO, the TiCDC cluster stops pulling data. The default value is empty, which means that TiCDC does not automatically stop pulling data.
- `--config`: Specifies the changefeed configuration file. For details, see [TiCDC Changefeed Configuration Parameters](/ticdc/ticdc-changefeed-config.md).

## Supported Kafka versions

The following table shows the minimum supported Kafka versions for each TiCDC version:

| TiCDC version | Minimum supported Kafka version |
|:-------------------------|:--------------------------------|
| TiCDC >= v8.1.0 | 2.1.0 |
| v7.6.0 <= TiCDC < v8.1.0 | 2.4.0 |
| v7.5.2 <= TiCDC < v8.0.0 | 2.1.0 |
| v7.5.0 <= TiCDC < v7.5.2 | 2.4.0 |
| v6.5.0 <= TiCDC < v7.5.0 | 2.1.0 |
| v6.1.0 <= TiCDC < v6.5.0 | 2.0.0 |

## Configure sink URI for Kafka

Sink URI is used to specify the connection information of the TiCDC target system. The format is as follows:
Expand All @@ -52,7 +65,7 @@ The following are descriptions of sink URI parameters and values that can be con
| `127.0.0.1` | The IP address of the downstream Kafka services. |
| `9092` | The port for the downstream Kafka. |
| `topic-name` | Variable. The name of the Kafka topic. |
| `kafka-version` | The version of the downstream Kafka (optional, `2.4.0` by default. Currently, the earliest supported Kafka version is `0.11.0.2` and the latest one is `3.2.0`. This value needs to be consistent with the actual version of the downstream Kafka). |
| `kafka-version` | The version of the downstream Kafka. This value needs to be consistent with the actual version of the downstream Kafka. |
| `kafka-client-id` | Specifies the Kafka client ID of the replication task (optional. `TiCDC_sarama_producer_replication ID` by default). |
| `partition-num` | The number of the downstream Kafka partitions (optional. The value must be **no greater than** the actual number of partitions; otherwise, the replication task cannot be created successfully. `3` by default). |
| `max-message-bytes` | The maximum size of data that is sent to Kafka broker each time (optional, `10MB` by default). From v5.0.6 and v4.0.6, the default value has changed from `64MB` and `256MB` to `10MB`. |
Expand Down
Loading