From 14f6ea4128c8dbea13a7ff42a2240f7998cf71ab Mon Sep 17 00:00:00 2001
From: Ti Chi Robot <ti-community-prow-bot@tidb.io>
Date: Mon, 2 Aug 2021 14:31:06 +0800
Subject: [PATCH] Add documentation on how to modify gcttl by tiup (#6071)
 (#6075)

---
 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 d89d3e7774d5a..06747928d95f7 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 <cluster-name> v5.0.3
 * 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 changes the value of `gc-ttl` from the default `86400` to `3600`, namely, one hour.
+
+First, execute the following command. You need to replace `<cluster-name>` with your actual cluster name. 
+
+{{< copyable "shell-regular" >}}
+
+```shell
+tiup cluster edit-config <cluster-name> 
+```
+
+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:
+  tidb: {}
+  tikv: {}
+  pd: {}
+  tiflash: {}
+  tiflash-learner: {}
+  pump: {}
+  drainer: {}
+  cdc:
+    gc-ttl: 3600
+```
+
+After the modification, execute the `tiup cluster relaod -R cdc` command to reload the configuration.
+
 ## Use TLS
 
 For details about using encrypted data transmission (TLS), see [Enable TLS Between TiDB Components](/enable-tls-between-components.md).