diff --git a/cdc/README.md b/cdc/README.md index ee90e227..5d357c48 100644 --- a/cdc/README.md +++ b/cdc/README.md @@ -27,7 +27,23 @@ $ make cdc ## Deployment ### Deploy by TiUP -_(Will be supported soon)_ + +_Note: TiUP >= `v1.11.0` is required. This version will be released before the end of Sep, 2022_ + +#### Deploy a new TiDB/TiKV cluster including TiKV-CDC + +When you deploy a new TiDB/TiKV cluster using TiUP, you can also deploy TiKV-CDC at the same time. You only need to add the `kvcdc_servers` section in the initialization configuration file that TiUP uses to start the TiDB/TiKV cluster. Please refer to the configuration [template](https://github.com/tikv/migration/blob/main/cdc/deployments/tikv-cdc/config-templates/topology.example.yaml). + +#### Add TiKV-CDC to an existing TiDB/TiKV cluster + +You can also use TiUP to add the TiKV-CDC component to an existing TiDB/TiKV cluster. Take the following procedures: + +1. Make sure that the current TiDB/TiKV version >= `6.2.0`. +2. Prepare a scale-out configuration file, refer to [template](https://github.com/tikv/migration/blob/main/cdc/deployments/tikv-cdc/config-templates/scale-out.example.yaml). +3. Scale out by `tiup cluster scale-out`. Also Refer to [Scale a TiDB Cluster Using TiUP](https://docs.pingcap.com/tidb/stable/scale-tidb-using-tiup). +``` +tiup cluster scale-out scale-out.yaml +``` ### Deploy manually diff --git a/cdc/deployments/tikv-cdc/config-templates/scale-out.example.yaml b/cdc/deployments/tikv-cdc/config-templates/scale-out.example.yaml index a150cf8a..1e061cfc 100644 --- a/cdc/deployments/tikv-cdc/config-templates/scale-out.example.yaml +++ b/cdc/deployments/tikv-cdc/config-templates/scale-out.example.yaml @@ -1,4 +1,4 @@ -tikv-cdc_servers: +kvcdc_servers: - host: 10.0.1.20 # # SSH port of the server. # ssh_port: 22 diff --git a/cdc/deployments/tikv-cdc/config-templates/topology.example.yaml b/cdc/deployments/tikv-cdc/config-templates/topology.example.yaml index 41451aed..3d656f03 100644 --- a/cdc/deployments/tikv-cdc/config-templates/topology.example.yaml +++ b/cdc/deployments/tikv-cdc/config-templates/topology.example.yaml @@ -39,7 +39,7 @@ server_configs: storage.api-version: 2 storage.enable-ttl: true # pd: - # tikv-cdc: + # kvcdc: # gc-ttl: 86400 # The TTL (Time To Live) of the service level `GC safepoint` in PD set by TiKV-CDC # # Server configs are used to specify the configuration of PD Servers. @@ -61,7 +61,7 @@ tikv_servers: - host: 10.0.1.17 # # Server configs are used to specify the configuration of TiKV-CDC Servers. -tikv-cdc_servers: +kvcdc_servers: - host: 10.0.1.20 # # SSH port of the server. # ssh_port: 22 diff --git a/cdc/manual-cn.md b/cdc/manual-cn.md index 1993ea0e..8eff1e2f 100644 --- a/cdc/manual-cn.md +++ b/cdc/manual-cn.md @@ -2,13 +2,15 @@ ## 部署 -### 使用 TiUP 部署包含 TiKV-CDC 组件的全新 TiKV 集群 -_(注意:支持 TiKV-CDC 的 TiUP 版本未正式发布)_ +### 使用 TiUP 部署 + +_(注意:支持 TiKV-CDC 的最小 TiUP 版本为 `v1.11.0`。该版本预计于2022年9月底发布)_ + +#### 使用 TiUP 部署包含 TiKV-CDC 组件的全新 TiKV 集群 在使用 [TiUP](https://docs.pingcap.com/zh/tidb/stable/production-deployment-using-tiup) 部署全新 TiKV 集群时,支持同时部署 TiKV-CDC 组件。只需在 TiUP 启动 TiKV 集群时的配置文件中加入 TiKV-CDC 部分即可,配置文件参考[模板](https://github.com/tikv/migration/blob/main/cdc/deployments/tikv-cdc/config-templates/topology.example.yaml)。 -### 使用 TiUP 在原有 TiKV 集群上新增 TiKV-CDC 组件 -_(注意:支持 TiKV-CDC 的 TiUP 版本未正式发布)_ +#### 使用 TiUP 在原有 TiKV 集群上新增 TiKV-CDC 组件 目前也支持在原有 TiKV 集群上使用 TiUP 新增 TiKV-CDC 组件,操作步骤如下: