From 4c256a122f35d97b895fe3331450eed5a98ce943 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 6351e0ad3a40..169962da22cf 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -4,7 +4,7 @@ title: TiCDC 运维操作及任务管理 # TiCDC 运维操作及任务管理 -本文档介绍如何通过 TiCDC 提供的命令行工具 `cdc cli` 和 HTTP 接口两种方式来管理 TiCDC 集群和同步任务。 +本文档介绍如何通过 TiCDC 提供的命令行工具 `cdc cli` 和 HTTP 接口两种方式来管理 TiCDC 集群和同步任务，并介绍了如何使用 TiUP 来升级和修改 TiCDC 集群的配置。 ## 使用 TiUP 升级 TiCDC @@ -17,12 +17,38 @@ tiup update --self && \ tiup update --all && \ tiup cluster upgrade v5.0.3 ``` - ### 升级的注意事项 * 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 7411729d0f4271ef2e85510301152536cd44c389 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 169962da22cf..56ec27bcf3d0 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -17,6 +17,7 @@ tiup update --self && \ tiup update --all && \ tiup cluster upgrade v5.0.3 ``` + ### 升级的注意事项 * TiCDC v4.0.2 对 `changefeed` 的配置做了调整，请参阅[配置文件兼容注意事项](/ticdc/manage-ticdc.md#配置文件兼容性的注意事项)。 From e996c5e1c391197a74f681358368657e506a57ea 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 56ec27bcf3d0..bfd969a22a7e 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -32,6 +32,7 @@ tiup cluster upgrade v5.0.3 ```shell tiup cluster edit-config ``` + 执行以上命令之后，进入到 vi 编辑器页面之后，修改 [server-configs](../tiup/tiup-dm-topology-reference.md#server_configs) 中 cdc 的配置，如下所示： {{< copyable "shell-regular" >}} @@ -48,6 +49,7 @@ tiup cluster edit-config cdc: gc-ttl: 3600 ``` + 修改完毕之后需要执行 tiup cluster relaod 命令来重新加载。 ## 使用加密传输 (TLS) 功能 From 6afa49e4a25b6b71c5c0b5ff867dac77e77ae9cb 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 bfd969a22a7e..3aca68a50685 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -25,7 +25,7 @@ tiup cluster upgrade v5.0.3 ## 使用 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" >}} @@ -33,7 +33,7 @@ tiup cluster upgrade v5.0.3 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 a54704bafb552213613e2b81194e85cbe8fd195e 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 3aca68a50685..f8dce089b00a 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -50,7 +50,7 @@ tiup cluster edit-config gc-ttl: 3600 ``` -修改完毕之后需要执行 tiup cluster relaod 命令来重新加载。 +修改完毕之后需要执行 tiup cluster relaod -R cdc 命令来重新加载。 ## 使用加密传输 (TLS) 功能 From 0c8413cf8196caf591bf574f23b2e1c5c2cc29a8 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 f8dce089b00a..0a3002c55617 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -33,7 +33,7 @@ tiup cluster upgrade v5.0.3 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 00ab11a494dad86c1a72ef43a9a4d4de64a54136 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 0a3002c55617..6d3c9e0230a4 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -50,7 +50,7 @@ tiup cluster edit-config gc-ttl: 3600 ``` -修改完毕之后需要执行 tiup cluster relaod -R cdc 命令来重新加载。 +修改完毕后执行 `tiup cluster relaod -R cdc` 命令重新加载配置。 ## 使用加密传输 (TLS) 功能 From 6a1725006e679db567b27331c406a288c24696fb 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 6d3c9e0230a4..b3aad4d3f861 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -35,8 +35,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 00cc610728fe8ce6692412d55183070be122ced2 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 b3aad4d3f861..a01de9127007 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -33,7 +33,7 @@ tiup cluster upgrade v5.0.3 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 062652a2cc4ad99fa0679255ceef5ccb85b69f2a 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 a01de9127007..a2124b9605d5 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -27,6 +27,8 @@ tiup cluster upgrade v5.0.3 本部分介绍如何使用 TiUP 的 [tiup cluster edit-config](/tiup/tiup-component-cluster-edit-config.md) 命令来修改 TiCDC 的配置。在以下例子中，假设需要把 TiCDC 的 `gc-ttl` 从默认值 `86400` 修改为1小时。 +首先执行以下命令。将 `` 替换成实际的集群名。 + {{< copyable "shell-regular" >}} ```shell From 44ad8361eb28385c62611b48d5e7a505f7faa888 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 a2124b9605d5..f3da75ea4db3 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -25,7 +25,7 @@ tiup cluster upgrade v5.0.3 ## 使用 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 小时。 首先执行以下命令。将 `` 替换成实际的集群名。