From b6272215055b430f5415a911678f2205af70959e Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 18 Jun 2021 15:15:09 +0800 Subject: [PATCH 01/11] Update manage-ticdc.md add documentation on how to modify gcttl by tiup --- ticdc/manage-ticdc.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index c23ad6dd816e..02e3076aa233 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -5,7 +5,7 @@ aliases: ['/docs-cn/dev/ticdc/manage-ticdc/','/docs-cn/dev/reference/tools/ticdc # TiCDC 运维操作及任务管理 -本文档介绍如何通过 TiCDC 提供的命令行工具 `cdc cli` 和 HTTP 接口两种方式来管理 TiCDC 集群和同步任务。 +本文档介绍如何通过 TiCDC 提供的命令行工具 `cdc cli` 和 HTTP 接口两种方式来管理 TiCDC 集群和同步任务，并介绍了如何使用 TiUP 来升级和修改 TiCDC 集群的配置。 ## 使用 TiUP 升级 TiCDC @@ -18,12 +18,38 @@ tiup update --self && \ tiup update --all && \ tiup cluster upgrade v5.1.0 ``` - ### 升级的注意事项 * TiCDC v4.0.2 对 `changefeed` 的配置做了调整，请参阅[配置文件兼容注意事项](/ticdc/manage-ticdc.md#配置文件兼容性的注意事项)。 * 升级期间遇到的问题及其解决办法，请参阅[使用 TiUP 升级 TiDB](/upgrade-tidb-using-tiup.md#4-升级-faq)。 +## 使用 TiUP 修改 TiCDC 配置 + +本部分介绍如何使用 TiUP 的 [tiup cluster edit-config](../tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为1小时。 + +{{< copyable "shell-regular" >}} + +```shell +tiup cluster edit-config +``` +执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](../tiup/tiup-dm-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： + +{{< copyable "shell-regular" >}} + +```shell + server_configs: + tidb: {} + tikv: {} + pd: {} + tiflash: {} + tiflash-learner: {} + pump: {} + drainer: {} + cdc: + gc-ttl: 3600 +``` +修改完毕之后需要执行 tiup cluster relaod 命令来重新加载。 + ## 使用加密传输 (TLS) 功能 请参阅[为 TiDB 组件间通信开启加密传输](/enable-tls-between-components.md)。 From 2beb9df4e7016213c73c71328e60777601d81458 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 18 Jun 2021 15:21:33 +0800 Subject: [PATCH 02/11] 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 02e3076aa233..36164cec5cb0 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -18,6 +18,7 @@ tiup update --self && \ tiup update --all && \ tiup cluster upgrade v5.1.0 ``` + ### 升级的注意事项 * TiCDC v4.0.2 对 `changefeed` 的配置做了调整，请参阅[配置文件兼容注意事项](/ticdc/manage-ticdc.md#配置文件兼容性的注意事项)。 From b73338dbe07b7b13c3db686d69193dabce189ad4 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 18 Jun 2021 15:22:55 +0800 Subject: [PATCH 03/11] Update manage-ticdc.md --- ticdc/manage-ticdc.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 36164cec5cb0..f4dad6d9dad5 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -33,6 +33,7 @@ tiup cluster upgrade v5.1.0 ```shell tiup cluster edit-config ``` + 执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](../tiup/tiup-dm-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： {{< copyable "shell-regular" >}} @@ -49,6 +50,7 @@ tiup cluster edit-config cdc: gc-ttl: 3600 ``` + 修改完毕之后需要执行 tiup cluster relaod 命令来重新加载。 ## 使用加密传输 (TLS) 功能 From b02b42ccd6efa6b6b64051c764d2b616f232c4e9 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 18 Jun 2021 15:26:43 +0800 Subject: [PATCH 04/11] Update manage-ticdc.md --- ticdc/manage-ticdc.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index f4dad6d9dad5..a32daf107ecf 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -26,7 +26,7 @@ tiup cluster upgrade v5.1.0 ## 使用 TiUP 修改 TiCDC 配置 -本部分介绍如何使用 TiUP 的 [tiup cluster edit-config](../tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为1小时。 +本部分介绍如何使用 TiUP 的 [tiup cluster edit-config](/tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为1小时。 {{< copyable "shell-regular" >}} @@ -34,7 +34,7 @@ tiup cluster upgrade v5.1.0 tiup cluster edit-config ``` -执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](../tiup/tiup-dm-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： +执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](/tiup/tiup-dm-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： {{< copyable "shell-regular" >}} From 10acfa6afef6f1ce39917331c9e59b5f6548afc8 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Tue, 6 Jul 2021 02:57:30 -0500 Subject: [PATCH 05/11] Update ticdc/manage-ticdc.md Co-authored-by: amyangfei --- 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 a32daf107ecf..956e18b50c11 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -51,7 +51,7 @@ tiup cluster edit-config gc-ttl: 3600 ``` -修改完毕之后需要执行 tiup cluster relaod 命令来重新加载。 +修改完毕之后需要执行 tiup cluster relaod -R cdc 命令来重新加载。 ## 使用加密传输 (TLS) 功能 From df992ebd440a8335aa3233e01930b5e8906efdba Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Tue, 6 Jul 2021 16:19:51 +0800 Subject: [PATCH 06/11] Update 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 956e18b50c11..e706ea7fd05e 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -34,7 +34,7 @@ tiup cluster upgrade v5.1.0 tiup cluster edit-config ``` -执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](/tiup/tiup-dm-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： +执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](/tiup/tiup-cluster-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： {{< copyable "shell-regular" >}} From 6b8bd0e829d34a7cfb95e3feb42c493369fd3c67 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Thu, 8 Jul 2021 04:52:52 -0500 Subject: [PATCH 07/11] Update ticdc/manage-ticdc.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- 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 e706ea7fd05e..713ecba07041 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -51,7 +51,7 @@ tiup cluster edit-config gc-ttl: 3600 ``` -修改完毕之后需要执行 tiup cluster relaod -R cdc 命令来重新加载。 +修改完毕后执行 `tiup cluster relaod -R cdc` 命令重新加载配置。 ## 使用加密传输 (TLS) 功能 From b0326c0a6cbcc65b77d29e6cb2dae150c38400eb Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Thu, 8 Jul 2021 04:53:07 -0500 Subject: [PATCH 08/11] Update ticdc/manage-ticdc.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- ticdc/manage-ticdc.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index 713ecba07041..6bad0cc81134 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -36,8 +36,6 @@ tiup cluster edit-config 执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](/tiup/tiup-cluster-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： -{{< copyable "shell-regular" >}} - ```shell server_configs: tidb: {} From 6d170454e8cdb9fff7dfcc0058e28e317d98a0c6 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Thu, 8 Jul 2021 04:53:21 -0500 Subject: [PATCH 09/11] Update ticdc/manage-ticdc.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- 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 6bad0cc81134..a9dad6dfae38 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -34,7 +34,7 @@ tiup cluster upgrade v5.1.0 tiup cluster edit-config ``` -执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](/tiup/tiup-cluster-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： +执行以上命令之后，进入到 vi 编辑器页面，修改 [`server-configs`](/tiup/tiup-cluster-topology-reference.md#server_configs) 下的 `cdc` 配置，如下所示： ```shell server_configs: From 125916dc15f77c320834a9ddc409a5bf667759ba Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Thu, 8 Jul 2021 04:53:30 -0500 Subject: [PATCH 10/11] Update ticdc/manage-ticdc.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- ticdc/manage-ticdc.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index a9dad6dfae38..970fe2718056 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -28,6 +28,8 @@ tiup cluster upgrade v5.1.0 本部分介绍如何使用 TiUP 的 [tiup cluster edit-config](/tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为1小时。 +首先执行以下命令。将 `` 替换成实际的集群名。 + {{< copyable "shell-regular" >}} ```shell From e4842268d15881b6c414aecd431b525f6eb63bae Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Thu, 8 Jul 2021 04:53:56 -0500 Subject: [PATCH 11/11] Update ticdc/manage-ticdc.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- 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 970fe2718056..e64c7e36b252 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -26,7 +26,7 @@ tiup cluster upgrade v5.1.0 ## 使用 TiUP 修改 TiCDC 配置 -本部分介绍如何使用 TiUP 的 [tiup cluster edit-config](/tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为1小时。 +本节介绍如何使用 TiUP 的 [`tiup cluster edit-config`](/tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为 `3600`，即 1 小时。 首先执行以下命令。将 `` 替换成实际的集群名。