Skip to content

Commit

Permalink
*: simplify all file directories for docs master (pingcap#2560)
Browse files Browse the repository at this point in the history
* *: simplify all file directories for docs master

* replace deadlink

* fix lint

* fix links

Co-authored-by: Qiang Zhou <zhouqiang.cl@gmail.com>
  • Loading branch information
yikeke and zhouqiang-cl authored May 14, 2020
1 parent ec2b9f3 commit 6382022
Show file tree
Hide file tree
Showing 411 changed files with 1,225 additions and 2,644 deletions.
823 changes: 411 additions & 412 deletions TOC.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ category: introduction

TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP:

- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy a TiDB cluster using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment.
- [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker.
- [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive.
- [TiUP Deployment](/production-deployment-using-tiup.md): This guide describes how to deploy a TiDB cluster using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment.
- [Docker Deployment](/test-deployment-using-docker.md): This guide describes how to deploy TiDB using Docker.
- [Docker Compose Deployment](/deploy-test-cluster-using-docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive.
- Kubernetes Deployment:

You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB for production environments on:
Expand All @@ -27,7 +27,7 @@ TiDB can be deployed on-premise or in-cloud. The following deployment options ar
- [kind](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-kind/)
- [Minikube](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-minikube/)

- [Binary Tarball Deployment](/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/how-to/get-started/deploy-tidb-from-binary.md) and [testing](/how-to/deploy/from-tarball/testing-environment.md) environments are also available.
- [Binary Tarball Deployment](/production-deployment-from-binary-tarball.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/deploy-tidb-from-binary.md) and [testing](/test-deployment-from-binary-tarball.md) environments are also available.

## Community Provided Blog Posts & Tutorials

Expand Down
2 changes: 1 addition & 1 deletion reference/alert-rules.md → alert-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -809,7 +809,7 @@ Warning-level alerts are a reminder for an issue or error.

## TiDB Binlog alert rules

For the detailed descriptions of TiDB Binlog alert rules, see [TiDB Binlog monitoring document](/reference/tidb-binlog/monitor.md#alert-rules).
For the detailed descriptions of TiDB Binlog alert rules, see [TiDB Binlog monitoring document](/tidb-binlog/monitor-tidb-binlog-cluster.md#alert-rules).

## Node_exporter host alert rules

Expand Down
4 changes: 2 additions & 2 deletions reference/sql/attributes/auto-random.md → auto-random.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ category: reference
>
> `AUTO_RANDOM` is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. In later TiDB versions, the syntax or semantics of `AUTO_RANDOM` might change.
Before using the `AUTO_RANDOM` attribute, set `allow-auto-random = true` in the `experimental` section of the TiDB configuration file. Refer to [`allow-auto-random`](/reference/configuration/tidb-server/configuration-file.md#allow-auto-random) for details.
Before using the `AUTO_RANDOM` attribute, set `allow-auto-random = true` in the `experimental` section of the TiDB configuration file. Refer to [`allow-auto-random`](/tidb-configuration-file.md#allow-auto-random) for details.

## User scenario

When you write data intensively into TiDB and TiDB has the table with a primary key of the auto-increment integer type, hotspot issue might occur. To solve the hotspot issue, you can use the `AUTO_RANDOM` attribute. Refer to [Highly Concurrent Write Best Practices](/reference/best-practices/high-concurrency.md#complex-hotspot-problems) for details.
When you write data intensively into TiDB and TiDB has the table with a primary key of the auto-increment integer type, hotspot issue might occur. To solve the hotspot issue, you can use the `AUTO_RANDOM` attribute. Refer to [Highly Concurrent Write Best Practices](/best-practices/high-concurrency-best-practices.md#complex-hotspot-problems) for details.

Take the following created table as an example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs/dev/how-to/maintain/backup-and-restore/']

# Use Mydumper and TiDB Lightning for Data Backup and Restoration

This document describes how to perform full backup and restoration of the TiDB data using Mydumper and TiDB Lightning. For incremental backup and restoration, refer to [TiDB Binlog](/reference/tidb-binlog/overview.md).
This document describes how to perform full backup and restoration of the TiDB data using Mydumper and TiDB Lightning. For incremental backup and restoration, refer to [TiDB Binlog](/tidb-binlog/tidb-binlog-overview.md).

Suppose that the TiDB service information is as follows:

Expand All @@ -16,18 +16,18 @@ Suppose that the TiDB service information is as follows:

Use the following tools for data backup and restoration:

- [Mydumper](/reference/tools/mydumper.md): to export data from TiDB
- [TiDB Lightning](/reference/tools/tidb-lightning/overview.md): to import data into TiDB
- [Mydumper](/mydumper-overview.md): to export data from TiDB
- [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md): to import data into TiDB

## Full backup and restoration using Mydumper/TiDB Lightning

`mydumper` is a powerful data backup tool. For more information, refer to [`maxbube/mydumper`](https://github.com/maxbube/mydumper).

Use [Mydumper](/reference/tools/mydumper.md) to export data from TiDB and use [TiDB Lightning](/reference/tools/tidb-lightning/overview.md) to import data into TiDB.
Use [Mydumper](/mydumper-overview.md) to export data from TiDB and use [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) to import data into TiDB.

> **Note:**
>
> It is recommended to download [Mydumper](/reference/tools/mydumper.md) from the PingCAP website, because the R&D team has adapted `mydumper` for TiDB. It is not recommended to use `mysqldump` which is much slower for both backup and restoration.
> It is recommended to download [Mydumper](/mydumper-overview.md) from the PingCAP website, because the R&D team has adapted `mydumper` for TiDB. It is not recommended to use `mysqldump` which is much slower for both backup and restoration.
### Best practices for full backup and restoration using Mydumper/TiDB Lightning

Expand Down Expand Up @@ -61,7 +61,7 @@ If `mydumper` returns the following error:

Then execute two more commands:

1. Before executing the `mydumper` command, query the [GC](/reference/garbage-collection/overview.md) values of the TiDB cluster and adjust it to a suitable value using the MySQL client:
1. Before executing the `mydumper` command, query the [GC](/garbage-collection-overview.md) values of the TiDB cluster and adjust it to a suitable value using the MySQL client:

{{< copyable "sql" >}}

Expand Down Expand Up @@ -94,4 +94,4 @@ Then execute two more commands:

## Restore data into TiDB

To restore data into TiDB, use TiDB Lightning to import the exported data. See [TiDB Lightning Tutorial](/reference/tools/tidb-lightning/tidb-backend.md).
To restore data into TiDB, use TiDB Lightning to import the exported data. See [TiDB Lightning Tutorial](/tidb-lightning/tidb-lightning-tidb-backend.md).
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ category: how-to

# Explore SQL with TiDB

TiDB is compatible with MySQL, you can use MySQL statements directly in most of the cases. For unsupported features, see [Compatibility with MySQL](/reference/mysql-compatibility.md#unsupported-features).
TiDB is compatible with MySQL, you can use MySQL statements directly in most of the cases. For unsupported features, see [Compatibility with MySQL](/mysql-compatibility.md#unsupported-features).

To experiment with SQL and test out TiDB compatibility with MySQL queries, you can [run TiDB directly in your web browser without installing it](https://tour.tidb.io/). You can also first deploy a TiDB cluster and then run SQL statements in it.

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ In this test, Sysbench 1.0.14 and TiDB 3.0 Beta are used. It is recommended to u

## Test environment

- [Hardware recommendations](/how-to/deploy/hardware-recommendations.md)
- [Hardware recommendations](/hardware-and-software-requirements.md)

- The TiDB cluster is deployed according to the [TiDB Deployment Guide](/how-to/deploy/orchestrated/ansible.md). Suppose there are 3 servers in total. It is recommended to deploy 1 TiDB instance, 1 PD instance and 1 TiKV instance on each server. As for disk space, supposing that there are 32 tables and 10M rows of data on each table, it is recommended that the disk space where TiKV's data directory resides is larger than 512 GB.
- The TiDB cluster is deployed according to the [TiDB Deployment Guide](/online-deployment-using-ansible.md). Suppose there are 3 servers in total. It is recommended to deploy 1 TiDB instance, 1 PD instance and 1 TiKV instance on each server. As for disk space, supposing that there are 32 tables and 10M rows of data on each table, it is recommended that the disk space where TiKV's data directory resides is larger than 512 GB.

The number of concurrent connections to a single TiDB cluster is recommended to be under 500. If you need to increase the concurrency pressure on the entire system, you can add TiDB instances to the cluster whose number depends on the pressure of the test.

Expand Down Expand Up @@ -87,7 +87,7 @@ sync-log = false
capacity = "30GB"
```

For more detailed information on TiKV performance tuning, see [Tune TiKV Performance](/reference/performance/tune-tikv.md).
For more detailed information on TiKV performance tuning, see [Tune TiKV Performance](/tune-tikv-performance.md).

## Test process

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ enabled = true

### Configure TiKV

You can use the basic configuration at the beginning. Then after the test is run, you can adjust it based on the metrics on Grafana and the [TiKV Tuning Instructions](/reference/performance/tune-tikv.md).
You can use the basic configuration at the beginning. Then after the test is run, you can adjust it based on the metrics on Grafana and the [TiKV Tuning Instructions](/tune-tikv-performance.md).

### Configure BenchmarkSQL

Expand Down Expand Up @@ -188,11 +188,11 @@ Follow the steps below to use TiDB Lightning to load data:
3. Use Lightning to load data.
To load data using Lightning, see [TiDB Lightning Deployment](/reference/tools/tidb-lightning/deployment.md). The following steps introduce how to use TiDB Ansible to deploy Lightning and use Lightning to load data.
To load data using Lightning, see [TiDB Lightning Deployment](/tidb-lightning/deploy-tidb-lightning.md). The following steps introduce how to use TiDB Ansible to deploy Lightning and use Lightning to load data.
1. Edit `inventory.ini`.
It is recommended to manually specify the deployed IP address, the port, and the deployment directory to avoid anomalies caused by conflicts. For the disk space of `import_dir`, see [TiDB Lightning Deployment](/reference/tools/tidb-lightning/deployment.md). `data_source_dir` refers to the directory where the CSV files are stored as mentioned before.
It is recommended to manually specify the deployed IP address, the port, and the deployment directory to avoid anomalies caused by conflicts. For the disk space of `import_dir`, see [TiDB Lightning Deployment](/tidb-lightning/deploy-tidb-lightning.md). `data_source_dir` refers to the directory where the CSV files are stored as mentioned before.
```ini
[importer_server]
Expand Down
File renamed without changes.
File renamed without changes.
214 changes: 0 additions & 214 deletions benchmark/sysbench.md

This file was deleted.

Loading

0 comments on commit 6382022

Please sign in to comment.