tiup: update doc for cdc_server_id (pingcap#10456)

db-will · Sep 16, 2022 · cedd961 · cedd961
1 parent 86b311d
commit cedd961
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/config-templates/complex-cdc.yaml b/config-templates/complex-cdc.yaml
@@ -98,19 +98,22 @@ cdc_servers:
     deploy_dir: "/tidb-deploy/cdc-8300"
     data_dir: "/tidb-data/cdc-8300"
     log_dir: "/tidb-deploy/cdc-8300/log"
-    # gc-ttl: 86400 
+    # gc-ttl: 86400
+    # ticdc_cluster_id: "cluster1"
   - host: 10.0.1.2
     port: 8300
     deploy_dir: "/tidb-deploy/cdc-8300"
     data_dir: "/tidb-data/cdc-8300"
     log_dir: "/tidb-deploy/cdc-8300/log"
-    # gc-ttl: 86400 
+    # gc-ttl: 86400
+    # ticdc_cluster_id: "cluster1"
   - host: 10.0.1.3
     port: 8300
     deploy_dir: "/tidb-deploy/cdc-8300"
     data_dir: "/tidb-data/cdc-8300"
     log_dir: "/tidb-deploy/cdc-8300/log"
-    # gc-ttl: 86400 
+    # gc-ttl: 86400
+    # ticdc_cluster_id: "cluster2"
 
 monitoring_servers:
   - host: 10.0.1.10

diff --git a/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md
@@ -513,6 +513,8 @@ drainer_servers:
 
 - `resource_control`: Resource control for the service. If this field is configured, the field content is merged with the `resource_control` content in `global` (if the two fields overlap, the content of this field takes effect). Then, a systemd configuration file is generated and sent to the machine specified in `host`. The configuration rules of `resource_control` are the same as the `resource_control` content in `global`.
 
+- `ticdc_cluster_id`: Specifies the TiCDC cluster ID corresponding to the service. If this field is not specified, the service joins the default TiCDC cluster. This field only takes effect in TiDB v6.3.0 or later versions.
+
 For the above fields, you cannot modify these configured fields after the deployment:
 
 - `host`
@@ -522,6 +524,7 @@ For the above fields, you cannot modify these configured fields after the deploy
 - `log_dir`
 - `arch`
 - `os`
+- `ticdc_cluster_id`
 
 A `cdc_servers` configuration example is as follows: