Skip to content

Clarify tidb lightning backend description #5904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ti-chi-bot merged 2 commits into from
Jul 1, 2021
Merged

Clarify tidb lightning backend description #5904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3e7432
Clarify tidb lightning backend description
Jul 1, 2021
460a768
Update tidb-lightning/deploy-tidb-lightning.md
TomShawn Jul 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions tidb-lightning/deploy-tidb-lightning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ aliases: ['/docs/dev/tidb-lightning/deploy-tidb-lightning/','/docs/dev/reference

This document describes the hardware requirements of TiDB Lightning using the Local-backend, and how to deploy it manually.

If you do not want the TiDB services to be impacted, read [TiDB Lightning TiDB-backend](/tidb-lightning/tidb-lightning-backends.md#tidb-lightning-tidb-backend) for the changes to the deployment steps.
If Local-backend is used for data import, during the import process, **the cluster cannot provide services**. If you do not want the TiDB services to be impacted, perform the data import according to [TiDB Lightning TiDB-backend](/tidb-lightning/tidb-lightning-backends.md#tidb-lightning-tidb-backend).

## Notes

Before starting TiDB Lightning, note that:

- During the import process, the cluster cannot provide normal services.
- If `tidb-lightning` crashes, the cluster is left in "import mode". Forgetting to switch back to "normal mode" can lead to a high amount of uncompacted data on the TiKV cluster, and cause abnormally high CPU usage and stall. You can manually switch the cluster back to "normal mode" via the `tidb-lightning-ctl` tool:

```sh
Expand Down
1 change: 1 addition & 0 deletions tidb-lightning/tidb-lightning-backends.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The **TiDB-backend**: `tidb-lightning` first encodes these data into SQL `INSERT
| Target tables | Must be empty | Must be empty | Can be populated |
| Additional component required | No | `tikv-importer` | No |
| TiDB versions supported | >= v4.0.0 | All | All |
| TiDB services impacted | Yes | Yes | No |

## How to choose the backend modes

Expand Down