From 4a264c1fa3eeefce3243a407c63e1dd36c21757a Mon Sep 17 00:00:00 2001 From: JoyinQin <56883733+Joyinqin@users.noreply.github.com> Date: Thu, 13 Aug 2020 12:39:00 +0800 Subject: [PATCH 1/6] add tiup deployment prompt in ticdc docs --- ticdc/manage-ticdc.md | 10 +++++----- ticdc/ticdc-overview.md | 13 +++++++++++-- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index a5b953ec0db68..1d7b54f2d8a12 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -8,7 +8,7 @@ aliases: ['/docs/dev/ticdc/manage-ticdc/','/docs/dev/reference/tools/ticdc/manag This document describes how to deploy a TiCDC cluster and how to manage the TiCDC cluster and replication tasks through the command line tool `cdc cli` and the HTTP interface. -## Deploy TiCDC +## Deploy and install TiCDC You can deploy TiCDC using either TiUP or Binary. @@ -21,13 +21,13 @@ In production environments, the recommendations of software and hardware for TiC | Red Hat Enterprise Linux | 7.3 or later versions | | CentOS | 7.3 or later versions | -| **CPU** | **Memory** | **Disk Type** | **Network** | **Instances (Minimum Requirements)** | +| **CPU** | **Memory** | **Disk Type** | **Network** | **Number of TiCDC Cluster Instances (Minimum Requirements for Production Environment)** | | --- | --- | --- | --- | --- | | 16 core+ | 64 GB+ | SSD | 10 Gigabit network card (2 preferred） | 2 | For more information, see [Software and Hardware Recommendations](/hardware-and-software-requirements.md) -### Use TiUP +### Deploy and install TiCDC using TiUP If you use TiUP to deploy TiCDC, you can choose one of the following ways: @@ -426,7 +426,7 @@ case-sensitive = true ignore-txn-start-ts = [1, 2] # Filter rules. -# Filter syntax: https://github.com/pingcap/tidb-tools/tree/master/pkg/table-filter#syntax. +# Filter syntax: https://docs.pingcap.com/tidb/stable/table-filter#syntax. rules = ['*.*', '!test.*'] [mounter] @@ -482,7 +482,7 @@ To use the cyclic replication feature, you need to configure the following param To create a cyclic replication task, take the following steps: -1. [Enable the TiCDC component](#deploy-ticdc) in TiDB cluster A, cluster B, and cluster C. +1. [Enable the TiCDC component](#deploy-and-install-ticdc) in TiDB cluster A, cluster B, and cluster C. {{< copyable "shell-regular" >}} diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index 4c477092583b3..fca62e848ece9 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -6,7 +6,7 @@ aliases: ['/docs/dev/ticdc/ticdc-overview/','/docs/dev/reference/tools/ticdc/ove # TiCDC Overview -> **Note:** +> **Warning:** > > TiCDC is still an experimental feature. It is **NOT** recommended that you use it in the production environment. @@ -85,9 +85,18 @@ Currently, The following scenarios are not supported: - The [TiKV Hibernate Region](https://github.com/tikv/tikv/blob/master/docs/reference/configuration/raftstore-config.md#hibernate-region). TiCDC prevents the Region from entering the hibernated state. - The scheduling of existing replication tables to new TiCDC nodes, after the capacity of the TiCDC cluster is scaled out. +## Install and deploy TiCDC + +TiCDC supports deploying TiCDC components while deploying a new TiDB cluster using TiUP. You only need to [add the TiCDC](/production-deployment-using-tiup.md#step-3-edit-the-initialization-configuration-file) to the configuration file when TiUP starts the TiDB cluster. + +Currently, TiCDC supports adding TiCDC components to the TiDB cluster using either TiUP or Binary. For details, see [Deploy and install TiCDC](/ticdc/manage-ticdc.md#deploy-and-install-ticdc). + ## Manage TiCDC Cluster and Replication Tasks -For details, see [Manage TiCDC Cluster and Replication Tasks](/ticdc/manage-ticdc.md). +Currently, TiCDC supports using `cdc cli` to manage a TiCDC cluster and data replication tasks. For details, see: + +- [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-cdc-cli-to-manage-cluster-status-and-data-replication-task) +- [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#manage-ticdc-cluster-and-replication-tasks) ## Troubleshoot TiCDC From db7d4bd8f648f43c351793d3f10a0eade60d8547 Mon Sep 17 00:00:00 2001 From: JoyinQin <56883733+Joyinqin@users.noreply.github.com> Date: Thu, 13 Aug 2020 13:39:00 +0800 Subject: [PATCH 2/6] Update manage-ticdc.md --- ticdc/manage-ticdc.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 1d7b54f2d8a12..2c41118888d7c 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -436,6 +436,7 @@ worker-num = 16 [sink] # For the sink of MQ type, you can use dispatchers to configure the event dispatcher. # Supports four dispatchers: default, ts, rowid, and table +# The matching syntax of matcher is the same as the filter rule syntax. dispatchers = [ {matcher = ['test1.*', 'test2.*'], dispatcher = "ts"}, {matcher = ['test3.*', 'test4.*'], dispatcher = "rowid"}, From c982cc91e566c16151582085ece000decc239fc2 Mon Sep 17 00:00:00 2001 From: JoyinQin <56883733+Joyinqin@users.noreply.github.com> Date: Thu, 13 Aug 2020 14:05:24 +0800 Subject: [PATCH 3/6] Update ticdc-overview.md --- ticdc/ticdc-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index fca62e848ece9..9da02dcef2a37 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -96,7 +96,7 @@ Currently, TiCDC supports adding TiCDC components to the TiDB cluster using eith Currently, TiCDC supports using `cdc cli` to manage a TiCDC cluster and data replication tasks. For details, see: - [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-cdc-cli-to-manage-cluster-status-and-data-replication-task) -- [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#manage-ticdc-cluster-and-replication-tasks) +- [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-http-interface-to-manage-cluster-status-and-data-replication-task) ## Troubleshoot TiCDC From 443fbc0442e4a34b4cb3ba5628b7525c330e18f6 Mon Sep 17 00:00:00 2001 From: JoyinQin <56883733+Joyinqin@users.noreply.github.com> Date: Thu, 13 Aug 2020 14:13:31 +0800 Subject: [PATCH 4/6] Update ticdc-overview.md --- ticdc/ticdc-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index 9da02dcef2a37..c4a8d1963cec7 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -95,7 +95,7 @@ Currently, TiCDC supports adding TiCDC components to the TiDB cluster using eith Currently, TiCDC supports using `cdc cli` to manage a TiCDC cluster and data replication tasks. For details, see: -- [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-cdc-cli-to-manage-cluster-status-and-data-replication-task) +- [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use--cdc-cli--to-manage-cluster-status-and-data-replication-task) - [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-http-interface-to-manage-cluster-status-and-data-replication-task) ## Troubleshoot TiCDC From 39ec049891d91f0248c8e914d5c8a2bc721de284 Mon Sep 17 00:00:00 2001 From: JoyinQin <56883733+Joyinqin@users.noreply.github.com> Date: Thu, 13 Aug 2020 14:19:22 +0800 Subject: [PATCH 5/6] Revert "Update ticdc-overview.md" This reverts commit 443fbc0442e4a34b4cb3ba5628b7525c330e18f6. --- ticdc/ticdc-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index c4a8d1963cec7..9da02dcef2a37 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -95,7 +95,7 @@ Currently, TiCDC supports adding TiCDC components to the TiDB cluster using eith Currently, TiCDC supports using `cdc cli` to manage a TiCDC cluster and data replication tasks. For details, see: -- [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use--cdc-cli--to-manage-cluster-status-and-data-replication-task) +- [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-cdc-cli-to-manage-cluster-status-and-data-replication-task) - [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-http-interface-to-manage-cluster-status-and-data-replication-task) ## Troubleshoot TiCDC From f4150bafdd9bad31e8f7300360a5994aa7a96d1c Mon Sep 17 00:00:00 2001 From: JoyinQ <56883733+Joyinqin@users.noreply.github.com> Date: Fri, 14 Aug 2020 12:59:45 +0800 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- ticdc/manage-ticdc.md | 2 +- ticdc/ticdc-overview.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 2c41118888d7c..53dbbde900c81 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -21,7 +21,7 @@ In production environments, the recommendations of software and hardware for TiC | Red Hat Enterprise Linux | 7.3 or later versions | | CentOS | 7.3 or later versions | -| **CPU** | **Memory** | **Disk Type** | **Network** | **Number of TiCDC Cluster Instances (Minimum Requirements for Production Environment)** | +| **CPU** | **Memory** | **Disk type** | **Network** | **Number of TiCDC cluster instances (minimum requirements for production environment)** | | --- | --- | --- | --- | --- | | 16 core+ | 64 GB+ | SSD | 10 Gigabit network card (2 preferred） | 2 | diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index 9da02dcef2a37..9169462a58c80 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -87,13 +87,13 @@ Currently, The following scenarios are not supported: ## Install and deploy TiCDC -TiCDC supports deploying TiCDC components while deploying a new TiDB cluster using TiUP. You only need to [add the TiCDC](/production-deployment-using-tiup.md#step-3-edit-the-initialization-configuration-file) to the configuration file when TiUP starts the TiDB cluster. +You can deploy TiCDC components in the process of deploying a new TiDB cluster using TiUP. You only need to [add TiCDC](/production-deployment-using-tiup.md#step-3-edit-the-initialization-configuration-file) to the configuration file when TiUP starts the TiDB cluster. -Currently, TiCDC supports adding TiCDC components to the TiDB cluster using either TiUP or Binary. For details, see [Deploy and install TiCDC](/ticdc/manage-ticdc.md#deploy-and-install-ticdc). +Currently, you can also add TiCDC components to an existing TiDB cluster using either TiUP or binary. For details, see [Deploy and install TiCDC](/ticdc/manage-ticdc.md#deploy-and-install-ticdc). ## Manage TiCDC Cluster and Replication Tasks -Currently, TiCDC supports using `cdc cli` to manage a TiCDC cluster and data replication tasks. For details, see: +Currently, you can use the `cdc cli` tool to manage the status of a TiCDC cluster and data replication tasks. For details, see: - [Use `cdc cli` to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-cdc-cli-to-manage-cluster-status-and-data-replication-task) - [Use HTTP interface to manage cluster status and data replication task](/ticdc/manage-ticdc.md#use-http-interface-to-manage-cluster-status-and-data-replication-task)