From 0c820dfe37ef4ae346a2cb2570ad452017572be6 Mon Sep 17 00:00:00 2001 From: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com> Date: Mon, 2 Aug 2021 11:33:27 +0800 Subject: [PATCH 1/2] Add documentation on how to modify gcttl by tiup --- ticdc/manage-ticdc.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index e51ed6dd0e3c4..e77546abb9c9a 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -5,7 +5,7 @@ summary: Learn how to manage a TiCDC cluster and replication tasks. # Manage TiCDC Cluster and Replication Tasks -This document describes how to manage the TiCDC cluster and replication tasks using the command line tool `cdc cli` and the HTTP interface. +This document describes how to upgrade TiCDC cluster and modify the configuration of TiCDC cluster using TiUP, and how to manage the TiCDC cluster and replication tasks using the command line tool `cdc cli` and the HTTP interface. ## Upgrade TiCDC using TiUP @@ -24,6 +24,35 @@ tiup cluster upgrade v5.1.0 * The `changefeed` configuration has changed in TiCDC v4.0.2. See [Compatibility notes for the configuration file](/production-deployment-using-tiup.md#step-3-initialize-cluster-topology-file) for details. * If you encounter any issues, see [Upgrade TiDB using TiUP - FAQ](/upgrade-tidb-using-tiup.md#faq). +## Modify TiCDC configuration using TiUP + +This section introduces how to modify the configuration of TiCDC cluster using the [`tiup cluster edit-config`](/tiup/tiup-component-cluster-edit-config.md) command of TiUP. The following example aims to change the value of `gc-ttl` from the default value of `86400` to `3600`, namely, an hour. + +First, execute the following command. You need to replace `` with your actual cluster name. + +{{< copyable "shell-regular" >}} + +```shell +tiup cluster edit-config +``` + +Then, enter the vi editor page and modify the `cdc` configuraion under [`server-configs`](/tiup/tiup-cluster-topology-reference.md#server_configs). The command is shown below: + +```shell + server_configs: + tidb: {} + tikv: {} + pd: {} + tiflash: {} + tiflash-learner: {} + pump: {} + drainer: {} + cdc: + gc-ttl: 3600 +``` + +After the modification, you need to execute `tiup cluster relaod -R cdc` command to reload the configuration file. + ## Use TLS For details about using encrypted data transmission (TLS), see [Enable TLS Between TiDB Components](/enable-tls-between-components.md). From 54b8b21aa78c63e53e4122e6cc1dbc1d630631e9 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Mon, 2 Aug 2021 14:09:48 +0800 Subject: [PATCH 2/2] Apply suggestions from code review --- ticdc/manage-ticdc.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md index e77546abb9c9a..83e01b4bb2646 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -5,7 +5,7 @@ summary: Learn how to manage a TiCDC cluster and replication tasks. # Manage TiCDC Cluster and Replication Tasks -This document describes how to upgrade TiCDC cluster and modify the configuration of TiCDC cluster using TiUP, and how to manage the TiCDC cluster and replication tasks using the command line tool `cdc cli` and the HTTP interface. +This document describes how to upgrade TiCDC cluster and modify the configuration of TiCDC cluster using TiUP, and how to manage the TiCDC cluster and replication tasks using the command-line tool `cdc cli` and the HTTP interface. ## Upgrade TiCDC using TiUP @@ -26,7 +26,7 @@ tiup cluster upgrade v5.1.0 ## Modify TiCDC configuration using TiUP -This section introduces how to modify the configuration of TiCDC cluster using the [`tiup cluster edit-config`](/tiup/tiup-component-cluster-edit-config.md) command of TiUP. The following example aims to change the value of `gc-ttl` from the default value of `86400` to `3600`, namely, an hour. +This section introduces how to modify the configuration of TiCDC cluster using the [`tiup cluster edit-config`](/tiup/tiup-component-cluster-edit-config.md) command of TiUP. The following example changes the value of `gc-ttl` from the default `86400` to `3600`, namely, one hour. First, execute the following command. You need to replace `` with your actual cluster name. @@ -36,7 +36,7 @@ First, execute the following command. You need to replace `` with tiup cluster edit-config ``` -Then, enter the vi editor page and modify the `cdc` configuraion under [`server-configs`](/tiup/tiup-cluster-topology-reference.md#server_configs). The command is shown below: +Then, enter the vi editor page and modify the `cdc` configuraion under [`server-configs`](/tiup/tiup-cluster-topology-reference.md#server_configs). The configuration is shown below: ```shell server_configs: @@ -51,7 +51,7 @@ Then, enter the vi editor page and modify the `cdc` configuraion under [`server- gc-ttl: 3600 ``` -After the modification, you need to execute `tiup cluster relaod -R cdc` command to reload the configuration file. +After the modification, execute the `tiup cluster relaod -R cdc` command to reload the configuration. ## Use TLS