From 7bb0ae60bf3008acd28ccb32fa1ae32ecac72521 Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 17:20:56 +0800 Subject: [PATCH 1/9] Fix grammar and format for topology.example.yaml --- how-to/deploy/orchestrated/tiup.md | 28 ++++++++++++++-------------- quick-start-with-tidb.md | 4 ++-- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index 9471b084275f4..c2d4f548194d7 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -331,8 +331,8 @@ cat topology.yaml ``` ```yaml -# # Global variables are applied to all deployments and as the default value of -# # them if the specific deployment value missing. +# # Global variables are applied to all deployments and used as the default value of +# # The deployments if a specific deployment value is missing. global: user: "tidb" @@ -340,14 +340,14 @@ global: deploy_dir: "/tidb-deploy" data_dir: "/tidb-data" -# # Monitored variables are used to all the machine +# # Monitored variables are applied to all the machines. monitored: node_exporter_port: 9100 blackbox_exporter_port: 9115 # deploy_dir: "/tidb-deploy/monitored-9100" # data_dir: "/tidb-data/monitored-9100" # log_dir: "/tidb-deploy/monitored-9100/log" -# # Server configs are used to specify the runtime configuration of TiDB components +# # Server configs are used to specify the runtime configuration of TiDB components. # # All configuration items can be found in TiDB docs: # # - TiDB: https://pingcap.com/docs/stable/reference/configuration/tidb-server/configuration-file/ # # - TiKV: https://pingcap.com/docs/stable/reference/configuration/tikv-server/configuration-file/ @@ -355,7 +355,7 @@ monitored: # # All configuration items use points to represent the hierarchy, e.g: # # readpool.storage.use-unified-pool # # ^ ^ -# # You can overwrite this configuration via instance-level `config` field +# # You can overwrite this configuration via the instance-level `config` field. server_configs: tidb: @@ -391,7 +391,7 @@ pd_servers: # data_dir: "/tidb-data/pd-2379" # log_dir: "/tidb-deploy/pd-2379/log" # numa_node: "0,1" - # # Config is used to overwrite the `server_configs.pd` values + # # The following configs are used to overwrite the `server_configs.pd` values. # config: # schedule.max-merge-region-size: 20 # schedule.max-merge-region-keys: 200000 @@ -466,8 +466,8 @@ tiflash_servers: # - host: 10.0.1.17 # port: 8249 # data_dir: "/tidb-data/drainer-8249" -# # if drainer doesn't have checkpoint, use initial commitTS to initial checkpoint -# # will get a latest timestamp from pd if setting to be -1 (default -1) +# # If drainer doesn't have a checkpoint, use initial commitTS as the initial checkpoint. +# # Will get a latest timestamp from pd if commit_ts is set to -1 (the default value). # commit_ts: -1 # deploy_dir: "/tidb-deploy/drainer-8249" # log_dir: "/tidb-deploy/drainer-8249/log" @@ -620,8 +620,8 @@ cat topology.yaml ``` ```yaml -# # Global variables are applied to all deployments and as the default value of -# # them if the specific deployment value missing. +# # Global variables are applied to all deployments and used as the default value of +# # The deployments if a specific deployment value is missing. global: user: "tidb" @@ -808,8 +808,8 @@ cat topology.yaml ``` ```yaml -# # Global variables are applied to all deployments and as the default value of -# # them if the specific deployment value missing. +# # Global variables are applied to all deployments and used as the default value of +# # The deployments if a specific deployment value is missing. global: user: "tidb" @@ -872,8 +872,8 @@ drainer_servers: - host: 10.0.1.9 port: 8249 data_dir: "/tidb-data/drainer-8249" - # if drainer doesn't have checkpoint, use initial commitTS to initial checkpoint - # will get a latest timestamp from pd if setting to be -1 (default -1) + # If drainer doesn't have a checkpoint, use initial commitTS as the initial checkpoint. + # Will get a latest timestamp from pd if commit_ts is set to -1 (the default value). commit_ts: -1 deploy_dir: "/tidb-deploy/drainer-8249" # Config is used to overwrite the `server_configs.drainer` values diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index adb986b4cac0f..2479bdbe396b1 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -189,8 +189,8 @@ Other requirements for the deployment machine: {{< copyable "shell-regular" >}} ```yaml - # # Global variables are applied to all deployments and as the default value of - # # them if the specific deployment value missing. + # # Global variables are applied to all deployments and used as the default value of + # # The deployments if a specific deployment value is missing. global: user: "tidb" From 557fbe06d51ca93a3aa2e4323f58ff74a4a8214c Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 17:46:03 +0800 Subject: [PATCH 2/9] address comments --- how-to/deploy/orchestrated/tiup.md | 9 +++------ quick-start-with-tidb.md | 3 +-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index c2d4f548194d7..e1112bf6f0ab0 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -332,8 +332,7 @@ cat topology.yaml ```yaml # # Global variables are applied to all deployments and used as the default value of -# # The deployments if a specific deployment value is missing. - +# # the deployments if a specific deployment value is missing. global: user: "tidb" ssh_port: 22 @@ -621,8 +620,7 @@ cat topology.yaml ```yaml # # Global variables are applied to all deployments and used as the default value of -# # The deployments if a specific deployment value is missing. - +# # the deployments if a specific deployment value is missing. global: user: "tidb" ssh_port: 22 @@ -809,8 +807,7 @@ cat topology.yaml ```yaml # # Global variables are applied to all deployments and used as the default value of -# # The deployments if a specific deployment value is missing. - +# # the deployments if a specific deployment value is missing. global: user: "tidb" ssh_port: 22 diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 2479bdbe396b1..f5a6b12787852 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -190,8 +190,7 @@ Other requirements for the deployment machine: ```yaml # # Global variables are applied to all deployments and used as the default value of - # # The deployments if a specific deployment value is missing. - + # # the deployments if a specific deployment value is missing. global: user: "tidb" ssh_port: 22 From be9e7a0576ec35083188070b7d7161ed23c701bf Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 17:52:30 +0800 Subject: [PATCH 3/9] Update tiup.md --- how-to/deploy/orchestrated/tiup.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index e1112bf6f0ab0..00222e00079b5 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -456,7 +456,7 @@ tiflash_servers: # data_dir: "/tidb-data/pump-8249" # log_dir: "/tidb-deploy/pump-8249/log" # numa_node: "0,1" -# # Config is used to overwrite the `server_configs.drainer` values +# # The following configs are used to overwrite the `server_configs.pd` values. # config: # gc: 7 # - host: 10.0.1.18 @@ -471,7 +471,7 @@ tiflash_servers: # deploy_dir: "/tidb-deploy/drainer-8249" # log_dir: "/tidb-deploy/drainer-8249/log" # numa_node: "0,1" -# # Config is used to overwrite the `server_configs.drainer` values +# # The following configs are used to overwrite the `server_configs.pd` values. # config: # syncer.db-type: "mysql" # syncer.to.host: "127.0.0.1" @@ -846,7 +846,7 @@ pump_servers: port: 8250 deploy_dir: "/tidb-deploy/pump-8249" data_dir: "/tidb-data/pump-8249" - # Config is used to overwrite the `server_configs.drainer` values + # The following configs are used to overwrite the `server_configs.pd` values. config: gc: 7 - host: 10.0.1.7 @@ -854,7 +854,7 @@ pump_servers: port: 8250 deploy_dir: "/tidb-deploy/pump-8249" data_dir: "/tidb-data/pump-8249" - # Config is used to overwrite the `server_configs.drainer` values + # The following configs are used to overwrite the `server_configs.pd` values. config: gc: 7 - host: 10.0.1.8 @@ -862,7 +862,7 @@ pump_servers: port: 8250 deploy_dir: "/tidb-deploy/pump-8249" data_dir: "/tidb-data/pump-8249" - # Config is used to overwrite the `server_configs.drainer` values + # The following configs are used to overwrite the `server_configs.pd` values. config: gc: 7 drainer_servers: @@ -873,7 +873,7 @@ drainer_servers: # Will get a latest timestamp from pd if commit_ts is set to -1 (the default value). commit_ts: -1 deploy_dir: "/tidb-deploy/drainer-8249" - # Config is used to overwrite the `server_configs.drainer` values + # The following configs are used to overwrite the `server_configs.pd` values. config: syncer.db-type: "tidb" syncer.to.host: "10.0.1.9" From f94ceb0990a7aa289aff25545f5981fb3f3c641f Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 17:55:09 +0800 Subject: [PATCH 4/9] Update tiup.md --- how-to/deploy/orchestrated/tiup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index 00222e00079b5..a55d6fb333222 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -405,7 +405,7 @@ tidb_servers: # deploy_dir: "/tidb-deploy/tidb-4000" # log_dir: "/tidb-deploy/tidb-4000/log" # numa_node: "0,1" - # # Config is used to overwrite the `server_configs.tidb` values + # # The following configs are used to overwrite the `server_configs.pd` values. # config: # log.slow-query-file: tidb-slow-overwrited.log - host: 10.0.1.8 @@ -1275,7 +1275,7 @@ tidb_servers: deploy_dir: "deploy/tidb-4000" log_dir: "deploy/tidb-4000/log" numa_node: "0,1" - # Config is used to overwrite the `server_configs.tidb` values + # The following configs are used to overwrite the `server_configs.pd` values. config: log.slow-query-file: tidb-slow-overwritten.log ``` From a19a9e145c8c156b31cf91eb9af85074f299d320 Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 18:12:12 +0800 Subject: [PATCH 5/9] Update tiup.md --- how-to/deploy/orchestrated/tiup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index a55d6fb333222..e4593c3765e85 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -420,7 +420,7 @@ tikv_servers: # data_dir: "/tidb-data/tikv-20160" # log_dir: "/tidb-deploy/tikv-20160/log" # numa_node: "0,1" - # # Config is used to overwrite the `server_configs.tikv` values + # # The following configs are used to overwrite the `server_configs.tikv` values. # config: # server.grpc-concurrency: 4 # server.labels: { zone: "zone1", dc: "dc1", host: "host1" } @@ -440,7 +440,7 @@ tiflash_servers: # data_dir: /tidb-data/tiflash-9000 # log_dir: /tidb-deploy/tiflash-9000/log # numa_node: "0,1" - # # Config is used to overwrite the `server_configs.tiflash` values + # # The following configs are used to overwrite the `server_configs.tiflash` values. # config: # logger.level: "info" # learner_config: From 44546c637a06afa4e04542d469720387e16f1dfa Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 18:26:35 +0800 Subject: [PATCH 6/9] Update tiup.md --- how-to/deploy/orchestrated/tiup.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index e4593c3765e85..6f41ddc4b1676 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -405,7 +405,7 @@ tidb_servers: # deploy_dir: "/tidb-deploy/tidb-4000" # log_dir: "/tidb-deploy/tidb-4000/log" # numa_node: "0,1" - # # The following configs are used to overwrite the `server_configs.pd` values. + # # The following configs are used to overwrite the `server_configs.tidb` values. # config: # log.slow-query-file: tidb-slow-overwrited.log - host: 10.0.1.8 @@ -456,7 +456,7 @@ tiflash_servers: # data_dir: "/tidb-data/pump-8249" # log_dir: "/tidb-deploy/pump-8249/log" # numa_node: "0,1" -# # The following configs are used to overwrite the `server_configs.pd` values. +# # The following configs are used to overwrite the `server_configs.drainer` values. # config: # gc: 7 # - host: 10.0.1.18 @@ -471,7 +471,7 @@ tiflash_servers: # deploy_dir: "/tidb-deploy/drainer-8249" # log_dir: "/tidb-deploy/drainer-8249/log" # numa_node: "0,1" -# # The following configs are used to overwrite the `server_configs.pd` values. +# # The following configs are used to overwrite the `server_configs.drainer` values. # config: # syncer.db-type: "mysql" # syncer.to.host: "127.0.0.1" @@ -846,7 +846,7 @@ pump_servers: port: 8250 deploy_dir: "/tidb-deploy/pump-8249" data_dir: "/tidb-data/pump-8249" - # The following configs are used to overwrite the `server_configs.pd` values. + # The following configs are used to overwrite the `server_configs.drainer` values. config: gc: 7 - host: 10.0.1.7 @@ -854,7 +854,7 @@ pump_servers: port: 8250 deploy_dir: "/tidb-deploy/pump-8249" data_dir: "/tidb-data/pump-8249" - # The following configs are used to overwrite the `server_configs.pd` values. + # The following configs are used to overwrite the `server_configs.drainer` values. config: gc: 7 - host: 10.0.1.8 @@ -862,7 +862,7 @@ pump_servers: port: 8250 deploy_dir: "/tidb-deploy/pump-8249" data_dir: "/tidb-data/pump-8249" - # The following configs are used to overwrite the `server_configs.pd` values. + # The following configs are used to overwrite the `server_configs.drainer` values. config: gc: 7 drainer_servers: @@ -873,7 +873,7 @@ drainer_servers: # Will get a latest timestamp from pd if commit_ts is set to -1 (the default value). commit_ts: -1 deploy_dir: "/tidb-deploy/drainer-8249" - # The following configs are used to overwrite the `server_configs.pd` values. + # The following configs are used to overwrite the `server_configs.drainer` values. config: syncer.db-type: "tidb" syncer.to.host: "10.0.1.9" @@ -1275,7 +1275,7 @@ tidb_servers: deploy_dir: "deploy/tidb-4000" log_dir: "deploy/tidb-4000/log" numa_node: "0,1" - # The following configs are used to overwrite the `server_configs.pd` values. + # The following configs are used to overwrite the `server_configs.drainer` values. config: log.slow-query-file: tidb-slow-overwritten.log ``` From e365f5daa62115d06abca31deda0be1c62481cf6 Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 18:35:43 +0800 Subject: [PATCH 7/9] Update tiup.md --- how-to/deploy/orchestrated/tiup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index 6f41ddc4b1676..e83ec2706ea91 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -1275,7 +1275,7 @@ tidb_servers: deploy_dir: "deploy/tidb-4000" log_dir: "deploy/tidb-4000/log" numa_node: "0,1" - # The following configs are used to overwrite the `server_configs.drainer` values. + # The following configs are used to overwrite the `server_configs.tidb` values.. config: log.slow-query-file: tidb-slow-overwritten.log ``` From 3740d6977b128c9979b4ebabc4fbf8cb45a90bc2 Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 18:36:51 +0800 Subject: [PATCH 8/9] Update tiup.md --- how-to/deploy/orchestrated/tiup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index e83ec2706ea91..a9b6fe64a16b1 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -1275,7 +1275,7 @@ tidb_servers: deploy_dir: "deploy/tidb-4000" log_dir: "deploy/tidb-4000/log" numa_node: "0,1" - # The following configs are used to overwrite the `server_configs.tidb` values.. + # The following configs are used to overwrite the `server_configs.tidb` values. config: log.slow-query-file: tidb-slow-overwritten.log ``` From 33dd78e4ba49f2e703eea505a4ae0c13fcaed238 Mon Sep 17 00:00:00 2001 From: toutdesuite Date: Tue, 21 Apr 2020 18:51:46 +0800 Subject: [PATCH 9/9] Update quick-start-with-tidb.md --- quick-start-with-tidb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index f5a6b12787852..640421ab54ecb 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -197,7 +197,7 @@ Other requirements for the deployment machine: deploy_dir: "/tidb-deploy" data_dir: "/tidb-data" - # # Monitored variables are used to all the machine + # # Monitored variables are applied to all the machines. monitored: node_exporter_port: 9100 blackbox_exporter_port: 9115