From ac06e0603ee2dd507e57ce7ff373c4a7a246aa06 Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Thu, 21 Dec 2023 12:39:24 +0800 Subject: [PATCH] ticdc: fix tiup cmd, change `tiup ctl:v cdc` to `tiup cdc:v cli` (#15824) (#15832) --- migrate-from-tidb-to-mysql.md | 2 +- replicate-data-to-kafka.md | 6 +++--- ticdc/deploy-ticdc.md | 2 +- ticdc/integrate-confluent-using-ticdc.md | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/migrate-from-tidb-to-mysql.md b/migrate-from-tidb-to-mysql.md index b676bbee47888..9181c70fa1147 100644 --- a/migrate-from-tidb-to-mysql.md +++ b/migrate-from-tidb-to-mysql.md @@ -160,7 +160,7 @@ After setting up the environment, you can use [Dumpling](/dumpling-overview.md) In the upstream cluster, run the following command to create a changefeed from the upstream to the downstream clusters: ```shell - tiup ctl:v cdc changefeed create --server=http://127.0.0.1:8300 --sink-uri="mysql://root:@127.0.0.1:3306" --changefeed-id="upstream-to-downstream" --start-ts="434217889191428107" + tiup cdc:v cli changefeed create --server=http://127.0.0.1:8300 --sink-uri="mysql://root:@127.0.0.1:3306" --changefeed-id="upstream-to-downstream" --start-ts="434217889191428107" ``` In this command, the parameters are as follows: diff --git a/replicate-data-to-kafka.md b/replicate-data-to-kafka.md index 71d4fad32f748..7dd7bf3d3a722 100644 --- a/replicate-data-to-kafka.md +++ b/replicate-data-to-kafka.md @@ -57,7 +57,7 @@ The preceding steps are performed in a lab environment. You can also deploy a cl 2. Create a changefeed to replicate incremental data to Kafka: ```shell - tiup ctl:v cdc changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka://127.0.0.1:9092/kafka-topic-name?protocol=canal-json" --changefeed-id="kafka-changefeed" --config="changefeed.conf" + tiup cdc:v cli changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka://127.0.0.1:9092/kafka-topic-name?protocol=canal-json" --changefeed-id="kafka-changefeed" --config="changefeed.conf" ``` - If the changefeed is successfully created, changefeed information, such as changefeed ID, is displayed, as shown below: @@ -73,13 +73,13 @@ The preceding steps are performed in a lab environment. You can also deploy a cl In a production environment, a Kafka cluster has multiple broker nodes. Therefore, you can add the addresses of multiple brokers to the sink UIR. This ensures stable access to the Kafka cluster. When the Kafka cluster is down, the changefeed still works. Suppose that a Kafka cluster has three broker nodes, with IP addresses being 127.0.0.1:9092, 127.0.0.2:9092, and 127.0.0.3:9092, respectively. You can create a changefeed with the following sink URI. ```shell - tiup ctl:v cdc changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka://127.0.0.1:9092,127.0.0.2:9092,127.0.0.3:9092/kafka-topic-name?protocol=canal-json&partition-num=3&replication-factor=1&max-message-bytes=1048576" --config="changefeed.conf" + tiup cdc:v cli changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka://127.0.0.1:9092,127.0.0.2:9092,127.0.0.3:9092/kafka-topic-name?protocol=canal-json&partition-num=3&replication-factor=1&max-message-bytes=1048576" --config="changefeed.conf" ``` 3. After creating the changefeed, run the following command to check the changefeed status: ```shell - tiup ctl:v cdc changefeed list --server="http://127.0.0.1:8300" + tiup cdc:v cli changefeed list --server="http://127.0.0.1:8300" ``` You can refer to [Manage TiCDC Changefeeds](/ticdc/ticdc-manage-changefeed.md) to manage the changefeed. diff --git a/ticdc/deploy-ticdc.md b/ticdc/deploy-ticdc.md index d04bfb4c9eaea..78340ec5fef2f 100644 --- a/ticdc/deploy-ticdc.md +++ b/ticdc/deploy-ticdc.md @@ -155,7 +155,7 @@ See [Enable TLS Between TiDB Components](/enable-tls-between-components.md). Run the following command to view the TiCDC cluster status. Note that you need to replace `v` with the TiCDC cluster version, such as `v7.4.0`: ```shell -tiup ctl:v cdc capture list --server=http://10.0.10.25:8300 +tiup cdc:v cli capture list --server=http://10.0.10.25:8300 ``` ```shell diff --git a/ticdc/integrate-confluent-using-ticdc.md b/ticdc/integrate-confluent-using-ticdc.md index 43b71808f7492..1cfe340f376bb 100644 --- a/ticdc/integrate-confluent-using-ticdc.md +++ b/ticdc/integrate-confluent-using-ticdc.md @@ -99,7 +99,7 @@ The preceding steps are performed in a lab environment. You can also deploy a cl 2. Create a changefeed to replicate incremental data to Confluent Cloud: ```shell - tiup ctl:v cdc changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka:///ticdc-meta?protocol=avro&replication-factor=3&enable-tls=true&auto-create-topic=true&sasl-mechanism=plain&sasl-user=&sasl-password=" --schema-registry="https://:@" --changefeed-id="confluent-changefeed" --config changefeed.conf + tiup cdc:v cli changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka:///ticdc-meta?protocol=avro&replication-factor=3&enable-tls=true&auto-create-topic=true&sasl-mechanism=plain&sasl-user=&sasl-password=" --schema-registry="https://:@" --changefeed-id="confluent-changefeed" --config changefeed.conf ``` You need to replace the values of the following fields with those created or recorded in [Step 2. Create an access key pair](#step-2-create-an-access-key-pair): @@ -114,7 +114,7 @@ The preceding steps are performed in a lab environment. You can also deploy a cl Note that you should encode `` based on [HTML URL Encoding Reference](https://www.w3schools.com/tags/ref_urlencode.asp) before replacing its value. After you replace all the preceding fields, the configuration file is as follows: ```shell - tiup ctl:v cdc changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka://xxx-xxxxx.ap-east-1.aws.confluent.cloud:9092/ticdc-meta?protocol=avro&replication-factor=3&enable-tls=true&auto-create-topic=true&sasl-mechanism=plain&sasl-user=L5WWA4GK4NAT2EQV&sasl-password=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --schema-registry="https://7NBH2CAFM2LMGTH7:xxxxxxxxxxxxxxxxxx@yyy-yyyyy.us-east-2.aws.confluent.cloud" --changefeed-id="confluent-changefeed" --config changefeed.conf + tiup cdc:v cli changefeed create --server="http://127.0.0.1:8300" --sink-uri="kafka://xxx-xxxxx.ap-east-1.aws.confluent.cloud:9092/ticdc-meta?protocol=avro&replication-factor=3&enable-tls=true&auto-create-topic=true&sasl-mechanism=plain&sasl-user=L5WWA4GK4NAT2EQV&sasl-password=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --schema-registry="https://7NBH2CAFM2LMGTH7:xxxxxxxxxxxxxxxxxx@yyy-yyyyy.us-east-2.aws.confluent.cloud" --changefeed-id="confluent-changefeed" --config changefeed.conf ``` - Run the command to create a changefeed. @@ -132,7 +132,7 @@ The preceding steps are performed in a lab environment. You can also deploy a cl 3. After creating the changefeed, run the following command to check the changefeed status: ```shell - tiup ctl:v cdc changefeed list --server="http://127.0.0.1:8300" + tiup cdc:v cli changefeed list --server="http://127.0.0.1:8300" ``` You can refer to [Manage TiCDC Changefeeds](/ticdc/ticdc-manage-changefeed.md) to manage the changefeed.