From afdabd55a215d90c1971c72c85b0de4960ab3ea7 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Wed, 21 Apr 2021 13:55:31 +0800 Subject: [PATCH 1/3] update the external links that contains master to release-5.0 --- best-practices/pd-scheduling-best-practices.md | 2 +- expression-syntax.md | 2 +- functions-and-operators/precision-math.md | 2 +- geo-distributed-deployment-topology.md | 2 +- hybrid-deployment-topology.md | 4 ++-- information-schema/information-schema-cluster-info.md | 2 +- minimal-deployment-topology.md | 4 ++-- pd-configuration-file.md | 2 +- production-deployment-using-tiup.md | 2 +- sync-diff-inspector/sync-diff-inspector-overview.md | 2 +- ticdc-deployment-topology.md | 4 ++-- ticdc/ticdc-open-protocol.md | 4 ++-- tidb-binlog-deployment-topology.md | 6 +++--- tidb-binlog/binlog-consumer-client.md | 4 ++-- tidb-binlog/tidb-binlog-configuration-file.md | 4 ++-- tidb-binlog/tidb-binlog-overview.md | 8 ++++---- tidb-configuration-file.md | 2 +- tidb-scheduling.md | 4 ++-- tiflash-deployment-topology.md | 4 ++-- tiflash/tiflash-configuration.md | 2 +- tikv-configuration-file.md | 2 +- tispark-deployment-topology.md | 4 ++-- tiup/tiup-faq.md | 2 +- tiup/tiup-playground.md | 2 +- troubleshoot-lock-conflicts.md | 2 +- 25 files changed, 39 insertions(+), 39 deletions(-) diff --git a/best-practices/pd-scheduling-best-practices.md b/best-practices/pd-scheduling-best-practices.md index abd0da376dfe2..c06471495691d 100644 --- a/best-practices/pd-scheduling-best-practices.md +++ b/best-practices/pd-scheduling-best-practices.md @@ -247,7 +247,7 @@ Hot regions scheduling issues generally fall into the following categories: - The load of some nodes is significantly higher than that of other nodes from TiKV-related metrics, which becomes the bottleneck of the whole system. Currently, PD counts hotspots through traffic analysis only, so it is possible that PD fails to identify hotspots in certain scenarios. For example, when there are intensive point lookup requests for some regions, it might not be obvious to detect in traffic, but still the high QPS might lead to bottlenecks in key modules. - **Solutions**: Firstly, locate the table where hot regions are formed based on the specific business. Then add a `scatter-range-scheduler` scheduler to make all regions of this table evenly distributed. TiDB also provides an interface in its HTTP API to simplify this operation. Refer to [TiDB HTTP API](https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md) for more details. + **Solutions**: Firstly, locate the table where hot regions are formed based on the specific business. Then add a `scatter-range-scheduler` scheduler to make all regions of this table evenly distributed. TiDB also provides an interface in its HTTP API to simplify this operation. Refer to [TiDB HTTP API](https://github.com/pingcap/tidb/blob/release-5.0/docs/tidb_http_api.md) for more details. ### Region merge is slow diff --git a/expression-syntax.md b/expression-syntax.md index 633da80f6caf9..5db4e46347bb6 100644 --- a/expression-syntax.md +++ b/expression-syntax.md @@ -17,7 +17,7 @@ The expressions can be divided into the following types: - ParamMarker (`?`), system variables, user variables and CASE expressions. -The following rules are the expression syntax, which is based on the [parser.y](https://github.com/pingcap/parser/blob/master/parser.y) rules of TiDB parser. For the navigable version of the following syntax diagram, refer to [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/#Expression). +The following rules are the expression syntax, which is based on the [parser.y](https://github.com/pingcap/parser/blob/release-5.0/parser.y) rules of TiDB parser. For the navigable version of the following syntax diagram, refer to [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/#Expression). ```ebnf+diagram Expression ::= diff --git a/functions-and-operators/precision-math.md b/functions-and-operators/precision-math.md index 7b7c5dd1c9fe7..30b2eaedb892b 100644 --- a/functions-and-operators/precision-math.md +++ b/functions-and-operators/precision-math.md @@ -50,7 +50,7 @@ DECIMAL columns do not store a leading `+` character or `-` character or leading DECIMAL columns do not permit values larger than the range implied by the column definition. For example, a `DECIMAL(3,0)` column supports a range of `-999` to `999`. A `DECIMAL(M,D)` column permits at most `M - D` digits to the left of the decimal point. -For more information about the internal format of the DECIMAL values, see [`mydecimal.go`](https://github.com/pingcap/tidb/blob/master/types/mydecimal.go) in TiDB souce code. +For more information about the internal format of the DECIMAL values, see [`mydecimal.go`](https://github.com/pingcap/tidb/blob/release-5.0/types/mydecimal.go) in TiDB souce code. ## Expression handling diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md index c251020e88f2e..53b79bd5e9240 100644 --- a/geo-distributed-deployment-topology.md +++ b/geo-distributed-deployment-topology.md @@ -18,7 +18,7 @@ This document takes the typical architecture of three data centers (DC) in two c ### Topology templates -- [The geo-distributed topology template](https://github.com/pingcap/docs/blob/master/config-templates/geo-redundancy-deployment.yaml) +- [The geo-distributed topology template](https://github.com/pingcap/docs/blob/release-5.0/config-templates/geo-redundancy-deployment.yaml) ### Key parameters diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md index b982cb5d233a0..2b8ec45a62c0e 100644 --- a/hybrid-deployment-topology.md +++ b/hybrid-deployment-topology.md @@ -22,8 +22,8 @@ The deployment machine has multiple CPU processors with sufficient memory. To im ### Topology templates -- [The simple template for the hybrid deployment](https://github.com/pingcap/docs-cn/blob/master/config-templates/simple-multi-instance.yaml) -- [The complex template for the hybrid deployment](https://github.com/pingcap/docs/blob/master/config-templates/complex-multi-instance.yaml) +- [The simple template for the hybrid deployment](https://github.com/pingcap/docs-cn/blob/release-5.0/config-templates/simple-multi-instance.yaml) +- [The complex template for the hybrid deployment](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-multi-instance.yaml) ### Key parameters diff --git a/information-schema/information-schema-cluster-info.md b/information-schema/information-schema-cluster-info.md index f1956d28e72ba..12c4bf9a85ddf 100644 --- a/information-schema/information-schema-cluster-info.md +++ b/information-schema/information-schema-cluster-info.md @@ -33,7 +33,7 @@ Field description: * `TYPE`: The instance type. The optional values are `tidb`, `pd`, and `tikv`. * `INSTANCE`: The instance address, which is a string in the format of `IP:PORT`. -* `STATUS_ADDRESS`: The service address of HTTP API. Some commands in tikv-ctl, pd-ctl, or tidb-ctl might use this API and this address. You can also get more cluster information via this address. Refer to [TiDB HTTP API document](https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md) for details. +* `STATUS_ADDRESS`: The service address of HTTP API. Some commands in tikv-ctl, pd-ctl, or tidb-ctl might use this API and this address. You can also get more cluster information via this address. Refer to [TiDB HTTP API document](https://github.com/pingcap/tidb/blob/release-5.0/docs/tidb_http_api.md) for details. * `VERSION`: The semantic version number of the corresponding instance. To be compatible with the MySQL version number, the TiDB version is displayed in the format of `${mysql-version}-${tidb-version}`. * `GIT_HASH`: The Git Commit Hash when compiling the instance version, which is used to identify whether two instances are of the absolutely consistent version. * `START_TIME`: The starting time of the corresponding instance. diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md index 10087e2cee92a..65706fe02cc0d 100644 --- a/minimal-deployment-topology.md +++ b/minimal-deployment-topology.md @@ -18,8 +18,8 @@ This document describes the minimal deployment topology of TiDB clusters. ### Topology templates -- [The simple template for the minimal topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-mini.yaml) -- [The complex template for the minimal topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-mini.yaml) +- [The simple template for the minimal topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-mini.yaml) +- [The complex template for the minimal topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-mini.yaml) > **Note:** > diff --git a/pd-configuration-file.md b/pd-configuration-file.md index 131fc299de798..4ea3f8d3f5992 100644 --- a/pd-configuration-file.md +++ b/pd-configuration-file.md @@ -7,7 +7,7 @@ summary: Learn the PD configuration file. -The PD configuration file supports more options than command-line parameters. You can find the default configuration file [here](https://github.com/pingcap/pd/blob/master/conf/config.toml). +The PD configuration file supports more options than command-line parameters. You can find the default configuration file [here](https://github.com/tikv/pd/blob/release-5.0/conf/config.toml). This document only describes parameters that are not included in command-line parameters. Check [here](/command-line-flags-for-pd-configuration.md) for the command line parameters. diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 7024e57afede3..0836744329820 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -229,7 +229,7 @@ The following examples cover six common scenarios. You need to modify the config > - For parameters that should be globally effective, configure these parameters of corresponding components in the `server_configs` section of the configuration file. > - For parameters that should be effective on a specific node, configure these parameters in the `config` of this node. > - Use `.` to indicate the subcategory of the configuration, such as `log.slow-threshold`. For more formats, see [TiUP configuration template](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml). -> - For more parameter description, see [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/master/config/config.toml.example), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/master/etc/config-template.toml), [PD `config.toml.example`](https://github.com/pingcap/pd/blob/master/conf/config.toml), and [TiFlash configuration](/tiflash/tiflash-configuration.md). +> - For more parameter description, see [TiDB `config.toml.example`](https://github.com/pingcap/docs-cn/blob/release-5.0/config-templates/simple-cdc.yaml), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/release-5.0/etc/config-template.toml), [PD `config.toml.example`](https://github.com/tikv/pd/blob/release-5.0/conf/config.toml), and [TiFlash configuration](/tiflash/tiflash-configuration.md). ## Step 4: Execute the deployment command diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index da4d9ad780c84..aedad7319de24 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -5,7 +5,7 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. # sync-diff-inspector User Guide -[sync-diff-inspector](https://github.com/pingcap/tidb-tools/tree/master/sync_diff_inspector) is a tool used to compare data stored in the databases with the MySQL protocol. For example, it can compare the data in MySQL with that in TiDB, the data in MySQL with that in MySQL, or the data in TiDB with that in TiDB. In addition, you can also use this tool to repair data in the scenario where a small amount of data is inconsistent. +[sync-diff-inspector](https://github.com/pingcap/tidb-tools/tree/release-5.0/sync_diff_inspector) is a tool used to compare data stored in the databases with the MySQL protocol. For example, it can compare the data in MySQL with that in TiDB, the data in MySQL with that in MySQL, or the data in TiDB with that in TiDB. In addition, you can also use this tool to repair data in the scenario where a small amount of data is inconsistent. This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. To download sync-diff-inspector, use one of the following methods: diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md index 7412e35920dea..ea3e01bee5774 100644 --- a/ticdc-deployment-topology.md +++ b/ticdc-deployment-topology.md @@ -25,8 +25,8 @@ TiCDC is a tool for replicating the incremental data of TiDB, introduced in TiDB ### Topology templates -- [The simple template for the TiCDC topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-cdc.yaml) -- [The complex template for the TiCDC topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-cdc.yaml) +- [The simple template for the TiCDC topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-cdc.yaml) +- [The complex template for the TiCDC topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-cdc.yaml) > **Note:** > diff --git a/ticdc/ticdc-open-protocol.md b/ticdc/ticdc-open-protocol.md index ecfc0cf40d7ab..648411499a012 100644 --- a/ticdc/ticdc-open-protocol.md +++ b/ticdc/ticdc-open-protocol.md @@ -273,8 +273,8 @@ COMMIT; Currently, TiCDC does not provide the standard parsing library for TiCDC Open Protocol, but the Golang version and Java version of parsing demonstrations are provided. You can refer to the data format provided in this document and the following demonstrations to implement the protocol parsing for consumers. -- [Golang demo](https://github.com/pingcap/ticdc/tree/master/kafka_consumer) -- [Java demo](https://github.com/pingcap/ticdc/tree/master/demo/java) +- [Golang demo](https://github.com/pingcap/ticdc/tree/release-5.0/kafka_consumer) +- [Java demo](https://github.com/pingcap/ticdc/tree/release-5.0/demo/java) ## Column type code diff --git a/tidb-binlog-deployment-topology.md b/tidb-binlog-deployment-topology.md index 84345348d439f..9b4bc543cc470 100644 --- a/tidb-binlog-deployment-topology.md +++ b/tidb-binlog-deployment-topology.md @@ -21,9 +21,9 @@ TiDB Binlog is the widely used component for replicating incremental data. It pr ### Topology templates -- [The simple template for the TiDB Binlog topology (with `mysql` as the downstream type)](https://github.com/pingcap/docs/blob/master/config-templates/simple-tidb-binlog.yaml) -- [The simple template for the TiDB Binlog topology (with `file` as the downstream type)](https://github.com/pingcap/docs/blob/master/config-templates/simple-file-binlog.yaml) -- [The complex template for the TiDB Binlog topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-tidb-binlog.yaml) +- [The simple template for the TiDB Binlog topology (with `mysql` as the downstream type)](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-tidb-binlog.yaml) +- [The simple template for the TiDB Binlog topology (with `file` as the downstream type)](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-file-binlog.yaml) +- [The complex template for the TiDB Binlog topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-tidb-binlog.yaml) ### Key parameters diff --git a/tidb-binlog/binlog-consumer-client.md b/tidb-binlog/binlog-consumer-client.md index 495f36ff45cc0..2541fb772f0a8 100644 --- a/tidb-binlog/binlog-consumer-client.md +++ b/tidb-binlog/binlog-consumer-client.md @@ -117,11 +117,11 @@ message Binlog { } ``` -For the definition of the data format, see [`binlog.proto`](https://github.com/pingcap/tidb-tools/blob/master/tidb-binlog/proto/proto/binlog.proto). +For the definition of the data format, see [`binlog.proto`](https://github.com/pingcap/tidb-tools/blob/release-5.0/tidb-binlog/proto/proto/binlog.proto). ### Driver -The [TiDB-Tools](https://github.com/pingcap/tidb-tools/) project provides [Driver](https://github.com/pingcap/tidb-tools/tree/master/tidb-binlog/driver), which is used to read the binlog data in Kafka. It has the following features: +The [TiDB-Tools](https://github.com/pingcap/tidb-tools/) project provides [Driver](https://github.com/pingcap/tidb-tools/tree/release-5.0/tidb-binlog/driver), which is used to read the binlog data in Kafka. It has the following features: * Read the Kafka data. * Locate the binlog stored in Kafka based on `commit ts`. diff --git a/tidb-binlog/tidb-binlog-configuration-file.md b/tidb-binlog/tidb-binlog-configuration-file.md index e5fbc86cc0677..2aebbd0d6aa9f 100644 --- a/tidb-binlog/tidb-binlog-configuration-file.md +++ b/tidb-binlog/tidb-binlog-configuration-file.md @@ -9,7 +9,7 @@ This document introduces the configuration items of TiDB Binlog. ## Pump -This section introduces the configuration items of Pump. For the example of a complete Pump configuration file, see [Pump Configuration](https://github.com/pingcap/tidb-binlog/blob/master/cmd/pump/pump.toml). +This section introduces the configuration items of Pump. For the example of a complete Pump configuration file, see [Pump Configuration](https://github.com/pingcap/tidb-binlog/blob/release-5.0/cmd/pump/pump.toml). ### addr @@ -128,7 +128,7 @@ For the detailed description of the above items, see [GoLevelDB Document](https: ## Drainer -This section introduces the configuration items of Drainer. For the example of a complete Drainer configuration file, see [Drainer Configuration](https://github.com/pingcap/tidb-binlog/blob/master/cmd/drainer/drainer.toml) +This section introduces the configuration items of Drainer. For the example of a complete Drainer configuration file, see [Drainer Configuration](https://github.com/pingcap/tidb-binlog/blob/release-5.0/cmd/drainer/drainer.toml) ### addr diff --git a/tidb-binlog/tidb-binlog-overview.md b/tidb-binlog/tidb-binlog-overview.md index 7c407316adc74..26312ffd4058c 100644 --- a/tidb-binlog/tidb-binlog-overview.md +++ b/tidb-binlog/tidb-binlog-overview.md @@ -28,15 +28,15 @@ The TiDB Binlog cluster is composed of Pump and Drainer. ### Pump -[Pump](https://github.com/pingcap/tidb-binlog/blob/master/pump) is used to record the binlogs generated in TiDB, sort the binlogs based on the commit time of the transaction, and send binlogs to Drainer for consumption. +[Pump](https://github.com/pingcap/tidb-binlog/blob/release-5.0/pump) is used to record the binlogs generated in TiDB, sort the binlogs based on the commit time of the transaction, and send binlogs to Drainer for consumption. ### Drainer -[Drainer](https://github.com/pingcap/tidb-binlog/tree/master/drainer) collects and merges binlogs from each Pump, converts the binlog to SQL or data of a specific format, and replicates the data to a specific downstream platform. +[Drainer](https://github.com/pingcap/tidb-binlog/tree/release-5.0/drainer) collects and merges binlogs from each Pump, converts the binlog to SQL or data of a specific format, and replicates the data to a specific downstream platform. ### `binlogctl` guide -[`binlogctl`](https://github.com/pingcap/tidb-binlog/tree/master/binlogctl) is an operations tool for TiDB Binlog with the following features: +[`binlogctl`](https://github.com/pingcap/tidb-binlog/tree/release-5.0/binlogctl) is an operations tool for TiDB Binlog with the following features: * Obtaining the current `tso` of TiDB cluster * Checking the Pump/Drainer state @@ -65,7 +65,7 @@ The TiDB Binlog cluster is composed of Pump and Drainer. * Drainer supports replicating binlogs to MySQL, TiDB, Kafka or local files. If you need to replicate binlogs to other Drainer unsuppored destinations, you can set Drainer to replicate the binlog to Kafka and read the data in Kafka for customized processing according to binlog consumer protocol. See [Binlog Consumer Client User Guide](/tidb-binlog/binlog-consumer-client.md). -* To use TiDB Binlog for recovering incremental data, set the config `db-type` to `file` (local files in the proto buffer format). Drainer converts the binlog to data in the specified [proto buffer format](https://github.com/pingcap/tidb-binlog/blob/master/proto/binlog.proto) and writes the data to local files. In this way, you can use [Reparo](/tidb-binlog/tidb-binlog-reparo.md) to recover data incrementally. +* To use TiDB Binlog for recovering incremental data, set the config `db-type` to `file` (local files in the proto buffer format). Drainer converts the binlog to data in the specified [proto buffer format](https://github.com/pingcap/tidb-binlog/blob/release-5.0/proto/binlog.proto) and writes the data to local files. In this way, you can use [Reparo](/tidb-binlog/tidb-binlog-reparo.md) to recover data incrementally. Pay attention to the value of `db-type`: diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 65d9c8a1cd3b1..8f679ff0fbfd2 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -8,7 +8,7 @@ summary: Learn the TiDB configuration file options that are not involved in comm # TiDB Configuration File -The TiDB configuration file supports more options than command-line parameters. You can download the default configuration file [`config.toml.example`](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) and rename it to `config.toml`. This document describes only the options that are not involved in [command line options](/command-line-flags-for-tidb-configuration.md). +The TiDB configuration file supports more options than command-line parameters. You can download the default configuration file [`config.toml.example`](https://github.com/pingcap/tidb/blob/release-5.0/config/config.toml.example) and rename it to `config.toml`. This document describes only the options that are not involved in [command line options](/command-line-flags-for-tidb-configuration.md). ### `split-table` diff --git a/tidb-scheduling.md b/tidb-scheduling.md index 36cde677a214c..a011bdbb30306 100644 --- a/tidb-scheduling.md +++ b/tidb-scheduling.md @@ -67,7 +67,7 @@ Scheduling is based on information collection. In short, the PD scheduling compo - State information reported by each TiKV peer: - Each TiKV peer sends heartbeats to PD periodically. PD not only checks whether the store is alive, but also collects [`StoreState`](https://github.com/pingcap/kvproto/blob/release-3.1/proto/pdpb.proto#L421) in the heartbeat message. `StoreState` includes: + Each TiKV peer sends heartbeats to PD periodically. PD not only checks whether the store is alive, but also collects [`StoreState`](https://github.com/pingcap/kvproto/blob/master/proto/pdpb.proto#L473) in the heartbeat message. `StoreState` includes: * Total disk space * Available disk space @@ -79,7 +79,7 @@ Scheduling is based on information collection. In short, the PD scheduling compo - Information reported by Region leaders: - Each Region leader sends heartbeats to PD periodically to report [`RegionState`](https://github.com/pingcap/kvproto/blob/release-3.1/proto/pdpb.proto#L271), including: + Each Region leader sends heartbeats to PD periodically to report [`RegionState`](https://github.com/pingcap/kvproto/blob/master/proto/pdpb.proto#L312), including: * Position of the leader itself * Positions of other replicas diff --git a/tiflash-deployment-topology.md b/tiflash-deployment-topology.md index 4b725acc40ce1..0ba9b97a9bb3d 100644 --- a/tiflash-deployment-topology.md +++ b/tiflash-deployment-topology.md @@ -21,8 +21,8 @@ TiFlash is a columnar storage engine, and gradually becomes the standard cluster ### Topology templates -- [The simple template for the TiFlash topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-tiflash.yaml) -- [The complex template for the TiFlash topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-tiflash.yaml) +- [The simple template for the TiFlash topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-tiflash.yaml) +- [The complex template for the TiFlash topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-tiflash.yaml) ### Key parameters diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index d4c15df6fef9c..4dae3709421f6 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -193,7 +193,7 @@ In addition to the items above, other parameters are the same with those of TiKV ### Multi-disk deployment -TiFlash supports multi-disk deployment. If there are multiple disks in your TiFlash node, you can make full use of those disks by configuring the parameters described in the following sections. For TiFlash's configuration template to be used for TiUP, see [The complex template for the TiFlash topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-tiflash.yaml). +TiFlash supports multi-disk deployment. If there are multiple disks in your TiFlash node, you can make full use of those disks by configuring the parameters described in the following sections. For TiFlash's configuration template to be used for TiUP, see [The complex template for the TiFlash topology](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-tiflash.yaml). #### Multi-disk deployment with TiDB version earlier than v4.0.9 diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index f1e80cea6feaf..1ebd8e2a74c09 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -7,7 +7,7 @@ summary: Learn the TiKV configuration file. -The TiKV configuration file supports more options than command-line parameters. You can find the default configuration file in [etc/config-template.toml](https://github.com/tikv/tikv/blob/master/etc/config-template.toml) and rename it to `config.toml`. +The TiKV configuration file supports more options than command-line parameters. You can find the default configuration file in [etc/config-template.toml](https://github.com/tikv/tikv/blob/release-5.0/etc/config-template.toml) and rename it to `config.toml`. This document only describes the parameters that are not included in command-line parameters. For more details, see [command-line parameter](/command-line-flags-for-tikv-configuration.md). diff --git a/tispark-deployment-topology.md b/tispark-deployment-topology.md index ae8e2b3df4e8e..176cc4b03c8bc 100644 --- a/tispark-deployment-topology.md +++ b/tispark-deployment-topology.md @@ -27,8 +27,8 @@ For more information about the TiSpark architecture and how to use it, see [TiSp ## Topology templates -- [Simple TiSpark topology template](https://github.com/pingcap/docs/blob/master/config-templates/simple-tispark.yaml) -- [Complex TiSpark topology template](https://github.com/pingcap/docs/blob/master/config-templates/complex-tispark.yaml) +- [Simple TiSpark topology template](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-tispark.yaml) +- [Complex TiSpark topology template](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-tispark.yaml) > **Note:** > diff --git a/tiup/tiup-faq.md b/tiup/tiup-faq.md index b1be6b89ed9a9..b53704b0634de 100644 --- a/tiup/tiup-faq.md +++ b/tiup/tiup-faq.md @@ -24,7 +24,7 @@ The TiUP playground component is mainly used to build a stand-alone development ## How do I write the topology file for the TiUP cluster component? -Refer to [these templates](https://github.com/pingcap/tiup/tree/master/examples) to write the topology file. The templates include: +Refer to [these templates](https://github.com/pingcap/tiup/tree/master/embed/templates/examples) to write the topology file. The templates include: - Multi-DC deployment topology - Minimal deployment topology diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index a42f8000fc9c8..424c451f0ef72 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -77,7 +77,7 @@ This command starts Prometheus on port 9090 to display the time series data in t ### Override PD's default configuration -First, you need to copy the [PD configuration template](https://github.com/pingcap/pd/blob/master/conf/config.toml). Assume you place the copied file to `~/config/pd.toml` and make some changes according to your need, then you can execute the following command to override PD's default configuration: +First, you need to copy the [PD configuration template](https://github.com/tikv/pd/blob/release-5.0/conf/config.toml). Assume you place the copied file to `~/config/pd.toml` and make some changes according to your need, then you can execute the following command to override PD's default configuration: {{< copyable "shell-regular" >}} diff --git a/troubleshoot-lock-conflicts.md b/troubleshoot-lock-conflicts.md index a9a57b21be9ed..d2ad49775aa42 100644 --- a/troubleshoot-lock-conflicts.md +++ b/troubleshoot-lock-conflicts.md @@ -205,7 +205,7 @@ Solutions: #### TTL manager has timed out -The transaction execution time can not exceed the GC time limit. In addition, the TTL time of pessimistic transactions has an upper limit, whose default value is 10 minutes. Therefore, a pessimistic transaction executed for more than 10 minutes will fail to commit. This timeout threshold is controlled by the TiDB parameter [performance.max-txn-ttl](https://github.com/pingcap/tidb/blob/master/config/config.toml.example). +The transaction execution time can not exceed the GC time limit. In addition, the TTL time of pessimistic transactions has an upper limit, whose default value is 10 minutes. Therefore, a pessimistic transaction executed for more than 10 minutes will fail to commit. This timeout threshold is controlled by the TiDB parameter [performance.max-txn-ttl](https://github.com/pingcap/tidb/blob/release-5.0/config/config.toml.example). When the execution time of a pessimistic transaction exceeds the TTL time, the following error message occurs in the TiDB log: From 287e627a0662b4b4b0e7f99e6b52f9e5b82ac38e Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Wed, 21 Apr 2021 14:04:30 +0800 Subject: [PATCH 2/3] Update production-deployment-using-tiup.md --- production-deployment-using-tiup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 0836744329820..5fb5d1d7dd64f 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -229,7 +229,7 @@ The following examples cover six common scenarios. You need to modify the config > - For parameters that should be globally effective, configure these parameters of corresponding components in the `server_configs` section of the configuration file. > - For parameters that should be effective on a specific node, configure these parameters in the `config` of this node. > - Use `.` to indicate the subcategory of the configuration, such as `log.slow-threshold`. For more formats, see [TiUP configuration template](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml). -> - For more parameter description, see [TiDB `config.toml.example`](https://github.com/pingcap/docs-cn/blob/release-5.0/config-templates/simple-cdc.yaml), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/release-5.0/etc/config-template.toml), [PD `config.toml.example`](https://github.com/tikv/pd/blob/release-5.0/conf/config.toml), and [TiFlash configuration](/tiflash/tiflash-configuration.md). +> - For more parameter description, see [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/release-5.0/config/config.toml.example), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/release-5.0/etc/config-template.toml), [PD `config.toml.example`](https://github.com/tikv/pd/blob/release-5.0/conf/config.toml), and [TiFlash configuration](/tiflash/tiflash-configuration.md). ## Step 4: Execute the deployment command From f3fd188b059a25e7caf231f5010f74d0353f5f88 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Thu, 22 Apr 2021 13:34:02 +0800 Subject: [PATCH 3/3] Update hybrid-deployment-topology.md Co-authored-by: Coco Yee <40977455+yikeke@users.noreply.github.com> --- hybrid-deployment-topology.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md index 536c7cfce1f59..55eeae0379663 100644 --- a/hybrid-deployment-topology.md +++ b/hybrid-deployment-topology.md @@ -22,7 +22,7 @@ The deployment machine has multiple CPU processors with sufficient memory. To im ### Topology templates -- [The simple template for the hybrid deployment](https://github.com/pingcap/docs-cn/blob/release-5.0/config-templates/simple-multi-instance.yaml) +- [The simple template for the hybrid deployment](https://github.com/pingcap/docs/blob/release-5.0/config-templates/simple-multi-instance.yaml) - [The complex template for the hybrid deployment](https://github.com/pingcap/docs/blob/release-5.0/config-templates/complex-multi-instance.yaml) For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).