-
Notifications
You must be signed in to change notification settings - Fork 713
master: remove TiDB Lightning web interface #23095
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.
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 3 commits into
pingcap:master
from
lilin90:remove-lightning-web-interface
Jun 23, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,20 @@ | ||
| --- | ||
| title: TiDB Lightning Web Interface | ||
|
lilin90 marked this conversation as resolved.
|
||
| summary: Control TiDB Lightning through the web interface. | ||
| summary: Learn about the removal of the TiDB Lightning Web Interface and the recommended alternatives. | ||
| aliases: ['/docs/dev/tidb-lightning/tidb-lightning-web-interface/','/docs/dev/reference/tools/tidb-lightning/web/'] | ||
| --- | ||
|
|
||
| # TiDB Lightning Web Interface | ||
|
lilin90 marked this conversation as resolved.
|
||
|
|
||
| > **Warning:** | ||
| > | ||
| > Starting from v8.5.6, the TiDB Lightning Web Interface is deprecated and will be removed in v8.5.7. The web UI build has been broken since v8.4.0. Use the [`tidb-lightning` CLI](/tidb-lightning/tidb-lightning-overview.md) or the [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) statement instead. If this affects your workflow, comment on [#67697](https://github.com/pingcap/tidb/issues/67697). | ||
| > Starting from TiDB v8.5.7, TiDB Lightning no longer supports the web interface. | ||
|
|
||
| TiDB Lightning provides a webpage for viewing the import progress and performing some simple task management. This is called the *server mode*. | ||
| To import data with TiDB Lightning, use the TiDB Lightning command-line tools: `tidb-lightning` for import tasks and `tidb-lightning-ctl` for checkpoint and troubleshooting operations. | ||
|
|
||
| To enable server mode, either start `tidb-lightning` with the `--server-mode` flag | ||
| - For a basic procedure, see [Get Started with TiDB Lightning](/get-started-with-tidb-lightning.md). | ||
| - For command-line options, see [TiDB Lightning Command Line Flags](/tidb-lightning/tidb-lightning-command-line-full.md). | ||
|
|
||
| ```sh | ||
| tiup tidb-lightning --server-mode --status-addr :8289 | ||
| ``` | ||
| To check the import progress, search for the `progress` keyword in the TiDB Lightning log, or use the [TiDB Lightning monitoring dashboard](/tidb-lightning/monitor-tidb-lightning.md). | ||
|
|
||
| or set the `lightning.server-mode` setting in the configuration file. | ||
|
|
||
| ```toml | ||
| [lightning] | ||
| server-mode = true | ||
| status-addr = ':8289' | ||
| ``` | ||
|
|
||
| After TiDB Lightning is launched, visit `http://127.0.0.1:8289` to control the program (the actual URL depends on the `status-addr` setting). | ||
|
|
||
| In server mode, TiDB Lightning does not start running immediately. Rather, users submit (multiple) *tasks* via the web interface to import data. | ||
|
|
||
| ## Front page | ||
|
|
||
|  | ||
|
|
||
| Functions of the title bar, from left to right: | ||
|
|
||
| | Icon | Function | | ||
| |:----|:----| | ||
| | "TiDB Lightning" | Click to go back to the front page | | ||
| | ⚠ | Display any error message from *previous* task | | ||
| | ⓘ | List current and queued tasks; a badge may appear here to indicate number of queued tasks | | ||
| | + | Submit a task | | ||
| | ⏸/▶ | Pause/resume current execution | | ||
| | ⟳ | Configure auto-refresh of the web page | | ||
|
|
||
| Three panels below the title bar show all tables in different states: | ||
|
|
||
| * Active: these tables are currently being imported | ||
| * Completed: these tables have been imported successfully or failed | ||
| * Pending: these tables are not yet processed | ||
|
|
||
| Each panel contains cards describing the status of the table. | ||
|
|
||
| ## Submit task | ||
|
|
||
| Click the **+** button on the title bar to submit a task. | ||
|
|
||
|  | ||
|
|
||
| Tasks are TOML files described as [task configurations](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-task). One could also open a local TOML file by clicking **UPLOAD**. | ||
|
|
||
| Click **SUBMIT** to run the task. If a task is already running, the new task will be queued and executed after the current task succeeds. | ||
|
|
||
| ## Table progress | ||
|
|
||
| Click the **>** button of a table card on the front page to view the detailed progress of a table. | ||
|
|
||
|  | ||
|
|
||
| The page shows the import progress of every engine and data files associated with the table. | ||
|
|
||
| Click **TiDB Lightning** on the title bar to go back to the front page. | ||
|
|
||
| ## Task management | ||
|
|
||
| Click the **ⓘ** button on the title bar to manage the current and queued tasks. | ||
|
|
||
|  | ||
|
|
||
| Each task is labeled by the time it was submitted. Clicking the task would show the configuration formatted as JSON. | ||
|
|
||
| Manage tasks by clicking the **⋮** button next to a task. You can stop a task immediately, or reorder queued tasks. | ||
| For new data import workloads, you can also use the [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) statement. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.