diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 071389270998b..712a26bf34819 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -8,7 +8,7 @@ aliases: ['/docs/stable/ticdc/manage-ticdc/','/docs/v4.0/ticdc/manage-ticdc/','/ 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] @@ -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"}, @@ -482,7 +483,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 9b04680df2fac..4ae413b5eae80 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -6,7 +6,7 @@ aliases: ['/docs/stable/ticdc/ticdc-overview/','/docs/v4.0/ticdc/ticdc-overview/ # 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 + +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, 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 -For details, see [Manage TiCDC Cluster and Replication Tasks](/ticdc/manage-ticdc.md). +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) ## Troubleshoot TiCDC