From 2b95263c2c6a37e9cab368bad04e2a6a14186807 Mon Sep 17 00:00:00 2001 From: Chunzhu Li Date: Wed, 5 Aug 2020 15:47:39 +0800 Subject: [PATCH 1/5] add tiup deployment docs in ticdc --- ticdc/manage-ticdc.md | 4 ++-- ticdc/ticdc-overview.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 1218fb422fc9..f23d4bc2a064 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -7,7 +7,7 @@ aliases: ['/docs-cn/dev/ticdc/manage-ticdc/','/docs-cn/dev/reference/tools/ticdc 本文档介绍如何部署 TiCDC 集群，以及如何通过 TiCDC 提供的命令行工具 `cdc cli` 和 HTTP 接口两种方式来管理 TiCDC 集群和同步任务。 -## TiCDC 部署 +## 部署安装 TiCDC ### 软件和硬件环境推荐配置 @@ -24,7 +24,7 @@ aliases: ['/docs-cn/dev/ticdc/manage-ticdc/','/docs-cn/dev/reference/tools/ticdc 更多信息参见 [TiDB 软件和硬件环境建议配置](/hardware-and-software-requirements.md) -### 使用 TiUP 部署 +### 使用 TiUP 部署安装 TiCDC #### 使用 TiUP 部署包含 TiCDC 组件的 TiDB 集群 diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index de7a44d2ecfe..2260cff21d1d 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -85,6 +85,8 @@ TiCDC 的系统架构如下图所示： TiCDC 的详细部署和任务管理说明请参考 [TiCDC 运维操作及任务管理](/ticdc/manage-ticdc.md)。 +TiCDC 已支持使用 TiUP 部署，只需在 TiUP 启动 TiDB 集群时的配置项中 [加入 TiCDC 部分](/production-deployment-using-tiup.md#第-3-步编辑初始化配置文件) 即可。 + ## TiCDC 常见问题 在使用 TiCDC 过程中经常遇到的问题以及相对应的解决方案请参考 [TiCDC 常见问题](/ticdc/troubleshoot-ticdc.md)。 From 9f30b9dc1bc54cf5bbabbae03061f6fabb66dc8b Mon Sep 17 00:00:00 2001 From: Chunzhu Li Date: Wed, 5 Aug 2020 16:00:09 +0800 Subject: [PATCH 2/5] fix dead anchor --- ticdc/manage-ticdc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index f23d4bc2a064..dc570faf795c 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -493,7 +493,7 @@ sync-ddl = true 环形同步任务创建步骤如下： -1. 在 TiDB 集群 A，B 和 C 上[启动 TiCDC 组件](#ticdc-部署)。 +1. 在 TiDB 集群 A，B 和 C 上[启动 TiCDC 组件](#部署安装-TiCDC)。 {{< copyable "shell-regular" >}} From f62916b7db8e25349d4db3f42b206cf2e6c9a91d Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Wed, 5 Aug 2020 16:01:23 +0800 Subject: [PATCH 3/5] Update ticdc/manage-ticdc.md --- ticdc/manage-ticdc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index dc570faf795c..1a8f259f4a26 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -493,7 +493,7 @@ sync-ddl = true 环形同步任务创建步骤如下： -1. 在 TiDB 集群 A，B 和 C 上[启动 TiCDC 组件](#部署安装-TiCDC)。 +1. 在 TiDB 集群 A，B 和 C 上[启动 TiCDC 组件](#部署安装-ticdc)。 {{< copyable "shell-regular" >}} From cdb7228dd9074d66147b4e50ef0205754de3bf8f Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 5 Aug 2020 16:27:33 +0800 Subject: [PATCH 4/5] add more details in ticdc-overview.md --- ticdc/manage-ticdc.md | 2 +- ticdc/ticdc-overview.md | 15 +++++++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 1a8f259f4a26..e3f81c96d815 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -18,7 +18,7 @@ aliases: ['/docs-cn/dev/ticdc/manage-ticdc/','/docs-cn/dev/reference/tools/ticdc | Red Hat Enterprise Linux | 7.3 及以上 | | CentOS | 7.3 及以上 | -| **CPU** | **内存** | **硬盘类型** | **网络** | **实例数量(最低要求)** | +| **CPU** | **内存** | **硬盘类型** | **网络** | **TiCDC 集群实例数量（生产环境最低要求）** | | --- | --- | --- | --- | --- | | 16 核+ | 64 GB+ | SSD | 万兆网卡（2 块最佳） | 2 | diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index 2260cff21d1d..a83df4a03900 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -5,7 +5,7 @@ aliases: ['/docs-cn/dev/ticdc/ticdc-overview/','/docs-cn/dev/reference/tools/tic # TiCDC 简介 -> **注意：** +> **警告：** > > TiCDC 目前为实验特性，不建议在生产环境中使用。 @@ -81,11 +81,18 @@ TiCDC 的系统架构如下图所示： - 暂不支持 [TiKV Hibernate Region](https://github.com/tikv/tikv/blob/master/docs/reference/configuration/raftstore-config.md#hibernate-region)。TiCDC 会使 Region 无法进入静默状态。 - TiCDC 集群扩容后，不支持将已有的同步表调度到新的 TiCDC 节点中。 -## TiCDC 部署和任务管理 +## TiCDC 安装和部署 -TiCDC 的详细部署和任务管理说明请参考 [TiCDC 运维操作及任务管理](/ticdc/manage-ticdc.md)。 +在使用 TiUP 部署全新 TiDB 集群时，支持同时部署 TiCDC 集群，只需在 TiUP 启动 TiDB 集群时的配置文件中 [加入 TiCDC 部分](/production-deployment-using-tiup.md#第-3-步编辑初始化配置文件) 即可。 -TiCDC 已支持使用 TiUP 部署，只需在 TiUP 启动 TiDB 集群时的配置项中 [加入 TiCDC 部分](/production-deployment-using-tiup.md#第-3-步编辑初始化配置文件) 即可。 +目前也支持使用 TiUP 或 binary 方式在原有 TiDB 集群上新增 TiCDC 组件，详细部署方案请参考 [部署安装 TiCDC](/ticdc/manage-ticdc.md#部署安装-ticdc)。 + +## TiCDC 集群管理和同步任务管理 + +目前支持使用 `cdc cli` 工具或 HTTP 接口来管理 TiCDC 集群状态和数据同步任务。详细操作见： + +- [使用 `cdc cli` 工具来管理集群状态和数据同步](/ticdc/manage-ticdc.md#使用-cdc-cli-工具来管理集群状态和数据同步) +- [使用 HTTP 接口管理集群状态和数据同步](/ticdc/manage-ticdc.md#使用-http-接口管理集群状态和数据同步) ## TiCDC 常见问题 From 43616cce7300e2c03bd68a2642e0010b516558bb Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Wed, 5 Aug 2020 16:32:21 +0800 Subject: [PATCH 5/5] Update ticdc/ticdc-overview.md Co-authored-by: Chunzhu Li --- 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 a83df4a03900..0b9199bbc574 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -83,7 +83,7 @@ TiCDC 的系统架构如下图所示： ## TiCDC 安装和部署 -在使用 TiUP 部署全新 TiDB 集群时，支持同时部署 TiCDC 集群，只需在 TiUP 启动 TiDB 集群时的配置文件中 [加入 TiCDC 部分](/production-deployment-using-tiup.md#第-3-步编辑初始化配置文件) 即可。 +在使用 TiUP 部署全新 TiDB 集群时，支持同时部署 TiCDC 组件，只需在 TiUP 启动 TiDB 集群时的配置文件中 [加入 TiCDC 部分](/production-deployment-using-tiup.md#第-3-步编辑初始化配置文件) 即可。 目前也支持使用 TiUP 或 binary 方式在原有 TiDB 集群上新增 TiCDC 组件，详细部署方案请参考 [部署安装 TiCDC](/ticdc/manage-ticdc.md#部署安装-ticdc)。