Skip to content

Commit 3a568f2

Browse files
ran-huangran-huang
authored
*: add summary meta for br, clinic, dashboard, develop, dm docs (#16376)
1 parent 1cf9270 commit 3a568f2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+55
-47
lines changed

Diff for: ‎br/backup-and-restore-design.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview of TiDB Backup & Restore Architecture
3-
summary: Learn about the architecture design of TiDB backup and restore features.
3+
summary: TiDB supports backup and restore for cluster data using Backup & Restore (BR) and TiDB Operator. Tasks can be created to back up data from TiKV nodes and restore data to TiKV nodes. The architecture includes full data backup and restore, data change log backup, and point-in-time recovery (PITR). For details, refer to specific documents for each feature.
44
---
55

66
# Overview of TiDB Backup & Restore Architecture

Diff for: ‎br/backup-and-restore-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Backup & Restore Overview
3-
summary: Learn about the definition and features of TiDB Backup & Restore.
3+
summary: TiDB Backup & Restore (BR) ensures high availability of clusters and data safety. It supports disaster recovery with a short RPO, handles misoperations, and provides history data auditing. It is recommended to perform backup operations during off-peak hours and store backup data to compatible storage systems. BR supports full backup and log backup, as well as restoring data to any point in time. It is important to use BR of the same major version as the TiDB cluster for backup and restoration.
44
aliases: ['/docs/dev/br/backup-and-restore-tool/','/docs/dev/reference/tools/br/br/','/docs/dev/how-to/maintain/backup-and-restore/br/','/tidb/dev/backup-and-restore-tool/','/tidb/dev/point-in-time-recovery/']
55
---
66

Diff for: ‎br/backup-and-restore-storages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Backup Storages
3-
summary: Describes the storage URI format used in TiDB backup and restore.
3+
summary: TiDB supports backup storage to Amazon S3, Google Cloud Storage, Azure Blob Storage, and NFS. You can specify the URI and authentication for different storage services. BR sends credentials to TiKV by default when using S3, GCS, or Azure Blob Storage. You can disable this for cloud environments. The URI format for each storage service is specified, along with authentication methods. Server-side encryption is supported for Amazon S3 and Azure Blob Storage. BR v6.3.0 also supports AWS S3 Object Lock.
44
aliases: ['/docs/dev/br/backup-and-restore-storages/','/tidb/dev/backup-storage-S3/','/tidb/dev/backup-storage-azblob/','/tidb/dev/backup-storage-gcs/','/tidb/dev/external-storage/']
55
---
66

Diff for: ‎br/backup-and-restore-use-cases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Backup and Restore Use Cases
3-
summary: Learn the use cases of backing up and restoring data using br command-line tool.
3+
summary: TiDB provides snapshot and log backup solutions for specific use cases, such as timely data recovery and business audits. To use point-in-time recovery (PITR), deploy a TiDB cluster >= v6.2.0 and update BR to v7.6.0. Configure backup storage on Amazon S3 and set a backup policy to meet data loss and recovery requirements. Run log and snapshot backups, and use PITR to restore data to a specific time point. Clean up outdated data regularly. For detailed steps, refer to TiDB documentation.
44
aliases: ['/docs/dev/br/backup-and-restore-use-cases/','/docs/dev/reference/tools/br/use-cases/','/tidb/dev/backup-and-restore-use-cases-for-maintain/']
55
---
66

Diff for: ‎br/br-auto-tune.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Backup Auto-Tune
3-
summary: Learn about the auto-tune feature of TiDB backup and restore, which automatically limits the resources used by backups to reduce the impact on the cluster in case of high cluster resource usage.
3+
summary: TiDB v5.4.0 introduces the auto-tune feature for backup tasks, which is enabled by default. It limits the resources used by backup tasks to reduce their impact on the cluster. You can enable or disable the feature dynamically without restarting the cluster. However, auto-tune may not completely remove the impact of backup on the cluster due to limitations. Adjusting the number of threads used by backup tasks can help mitigate the impact in certain scenarios.
44
---
55

66
# Backup Auto-Tune <span class="version-mark">New in v5.4.0</span>

Diff for: ‎br/br-batch-create-table.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Batch Create Table
3-
summary: Learn how to use the Batch Create Table feature. When restoring data, BR can create tables in batches to speed up the restore process.
3+
summary: TiDB v6.0.0 introduces the Batch Create Table feature to speed up the table creation process during data restoration. It is enabled by default and creates tables in batches, significantly reducing the time for restoring data with a large number of tables. The feature test shows that the average speed of restoring one TiKV instance is as high as 181.65 MB/s.
44
---
55

66
# Batch Create Table

Diff for: ‎br/br-checkpoint-backup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Checkpoint Backup
3-
summary: Learn about the checkpoint backup feature, including its application scenarios, implementation details, and usage.
3+
summary: TiDB v6.5.0 introduces checkpoint backup feature to continue interrupted backups, reducing the need to start from scratch. It records backed up shards to resume backup progress, but relies on GC mechanism and may require some data to be backed up again. The `br` tool periodically updates `gc-safepoint` to avoid data being garbage collected, and can extend retention period if needed.
44
aliases: ["/tidb/dev/br-checkpoint"]
55
---
66

Diff for: ‎br/br-checkpoint-restore.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Checkpoint Restore
3-
summary: Learn about the checkpoint restore feature, including its application scenarios, implementation details, and usage.
3+
summary: TiDB v7.1.0 introduces checkpoint restore, allowing interrupted snapshot and log restores to continue without starting from scratch. It records restored shards and table IDs, enabling retries to use the progress point close to the interruption. However, it relies on the GC mechanism and may require some data to be restored again. It's important to avoid modifying cluster data during the restore to ensure accuracy.
44
---
55

66
# Checkpoint Restore

Diff for: ‎br/br-incremental-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Incremental Backup and Restore Guide
3-
summary: Learns about how to perform incremental backup and restore in TiDB.
3+
summary: Incremental data is the differentiated data between starting and end snapshots, along with DDLs. It reduces backup volume and requires setting `tidb_gc_life_time` for incremental backup. Use `br backup` with `--lastbackupts` for incremental backup and ensure all previous data is restored before restoring incremental data.
44
---
55

66
# TiDB Incremental Backup and Restore Guide

Diff for: ‎br/br-log-architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Log Backup and PITR Architecture
3-
summary: Learn about the architecture of TiDB log backup and point-in-time recovery.
3+
summary: TiDB log backup and PITR architecture is introduced using a Backup & Restore (BR) tool as an example. The architecture includes log backup process design, system components, and key concepts. The PITR process involves restoring full backup data and log backup data. Log backup generates files such as log data, metadata, and global checkpoint.
44
---
55

66
# TiDB Log Backup and PITR Architecture

Diff for: ‎br/br-monitoring-and-alert.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Monitoring and Alert for Backup and Restore
3-
summary: Learn the monitoring and alert of the backup and restore feature.
3+
summary: This document describes monitoring and alert for backup and restore, including log backup monitoring, configuration, Grafana configuration, monitoring metrics, and log backup alerts. It covers the recommended alert items and their configurations for PITR.
44
---
55

66
# Monitoring and Alert for Backup and Restore

Diff for: ‎br/br-pitr-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Log Backup and PITR Guide
3-
summary: Learns about how to perform log backup and PITR in TiDB.
3+
summary: TiDB Log Backup and PITR Guide explains how to back up and restore data using the br command-line tool. It includes instructions for starting log backup, running full backup regularly, and cleaning up outdated data. The guide also provides information on running PITR and the performance capabilities of PITR.
44
aliases: ['/tidb/dev/pitr-usage']
55
---
66

Diff for: ‎br/br-pitr-manual.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Log Backup and PITR Command Manual
3-
summary: Learn about the commands of TiDB log backup and point-in-time recovery.
3+
summary: TiDB Log Backup and PITR Command Manual describes commands for log backup and point-in-time recovery. Use `br log` command to start, pause, resume, stop, truncate, and query log backup tasks. Specify parameters like `start-ts`, `task-name`, `--storage`, and `--pd` for log backup. Use `br log metadata` to view backup metadata and `br restore point` for PITR. Be cautious when pausing and resuming backup tasks.
44
aliases: ['/tidb/dev/br-log-command-line/']
55
---
66

Diff for: ‎br/br-snapshot-architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Snapshot Backup and Restore Architecture
3-
summary: Learn about the architecture of TiDB snapshot backup and restore.
3+
summary: TiDB Snapshot Backup and Restore Architecture introduces the process using a Backup & Restore (BR) tool. The architecture includes backup and restore processes, types of backup files, naming format, storage format, and structure of backup files. The backup process involves scheduling, data backup, and metadata backup. The restore process includes scheduling, schema restore, Region allocation, data restore, and reporting. The types of backup files include SST, backupmeta, and backup.lock files. The naming format and storage format of SST files are explained in detail. For more information, refer to the TiDB snapshot backup and restore guide.
44
---
55

66
# TiDB Snapshot Backup and Restore Architecture

Diff for: ‎br/br-snapshot-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Snapshot Backup and Restore Guide
3-
summary: Learn about how to back up and restore TiDB snapshots using the br command-line tool.
3+
summary: This document describes how to back up and restore TiDB snapshots using the br command-line tool. It includes instructions for snapshot backup, restoring data of a specified time point, and restoring a database or table. The document also covers the performance and impact of snapshot backup and restore.
44
aliases: ['/tidb/dev/br-usage-backup/','/tidb/dev/br-usage-restore/','/tidb/dev/br-usage-restore-for-maintain/', '/tidb/dev/br-usage-backup-for-maintain/']
55
---
66

Diff for: ‎br/br-snapshot-manual.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Snapshot Backup and Restore Command Manual
3-
summary: Learn about the commands of TiDB snapshot backup and restore.
3+
summary: TiDB Snapshot Backup and Restore Command Manual describes commands for backing up and restoring cluster snapshots, databases, and tables. It also covers encrypting backup data and restoring encrypted snapshots. The BR tool supports self-adapting to GC and introduces the --ignore-stats parameter for backing up and restoring statistics. It also supports encrypting backup data and restoring partial data of specified databases or tables.
44
---
55

66
# TiDB Snapshot Backup and Restore Command Manual

Diff for: ‎br/br-use-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Usage Overview of TiDB Backup and Restore
3-
summary: Learn about how to deploy the backup and restore tool, and how to use it to back up and restore a TiDB cluster.
3+
summary: TiDB Backup and Restore provides best practices for choosing backup methods, managing backup data, and deploying the tool. It recommends using both full and log backups, storing data in recommended storage systems, and setting backup retention periods. The tool can be deployed using the command-line tool, SQL statements, or TiDB Operator on Kubernetes. For detailed usage, refer to the provided documentation.
44
aliases: ['/tidb/dev/br-deployment/']
55
---
66

Diff for: ‎br/rawkv-backup-and-restore.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Back Up and Restore RawKV
3-
summary: Learn how to back up and restore RawKV using BR.
3+
summary: TiKV and PD can form a KV database known as RawKV without TiDB. TiKV-BR supports data backup and restore for RawKV. For more details, visit the TiKV-BR User Docs on the TiKV website.
44
---
55

66
# Back Up and Restore RawKV

Diff for: ‎br/use-br-command-line-tool.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: br Command-line Manual
3-
summary: Learn about the description, options, and usage of the br command-line tool.
3+
summary: The `br` command-line tool is used for snapshot backup, log backup, and point-in-time recovery (PITR) in TiDB clusters. It consists of sub-commands, options, and parameters, with common options like `--pd` for PD service address and `-s` for storage path. Sub-commands include `br backup`, `br log`, and `br restore`, each with specific functionalities. Backup commands include `full`, `db`, and `table` options, while log backup and restore commands have various tasks for managing backup operations.
44
---
55

66
# br Command-line Manual

Diff for: ‎clinic/clinic-data-instruction-for-tiup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: PingCAP Clinic Diagnostic Data
3-
summary: Learn what diagnostic data can be collected by PingCAP Clinic Diagnostic Service from the TiDB and DM clusters deployed using TiUP.
3+
summary: PingCAP Clinic Diagnostic Service collects diagnostic data from TiDB and DM clusters using TiUP. Data types include cluster information, diagnostic data for TiDB, TiKV, PD, TiFlash, TiCDC, Prometheus monitoring, system variables, and node system information. Data is stored in Clinic Server for international and Chinese mainland users. The collected data is only used for troubleshooting cluster problems.
44
---
55

66
# PingCAP Clinic Diagnostic Data

Diff for: ‎clinic/clinic-introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: PingCAP Clinic Overview
3-
summary: Learn about the PingCAP Clinic Diagnostic Service (PingCAP Clinic), including tool components, user scenarios, and implementation principles.
3+
summary: PingCAP Clinic is a diagnostic service for TiDB clusters deployed using TiUP or TiDB Operator. It helps troubleshoot cluster problems remotely, ensures stable operation, and provides quick cluster status checks. The service includes Diag client for data collection and Clinic Server for online diagnostic reports. Users can troubleshoot problems remotely and quickly check cluster status. Diag collects diagnostic data through various methods, and Clinic Server has limitations on clusters, storage, and data size. The service is free until July 14, 2024. Next steps include using PingCAP Clinic in different environments.
44
---
55

66
# PingCAP Clinic Overview

Diff for: ‎clinic/clinic-user-guide-for-tiup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Troubleshoot Clusters Using PingCAP Clinic
3-
summary: Learn how to use the PingCAP Clinic Diagnostic Service to troubleshoot cluster problems remotely and perform a quick check of the cluster status on a TiDB cluster or DM cluster deployed using TiUP.
3+
summary: PingCAP Clinic Diagnostic Service (PingCAP Clinic) helps troubleshoot TiDB and DM clusters deployed using TiUP. It allows remote troubleshooting and local cluster status checks using Diag client and Clinic Server. Prerequisites include installing Diag, setting an access token, and configuring the region. Troubleshooting remotely involves collecting, viewing, and uploading diagnostic data. Performing a quick check on the cluster status locally involves collecting and diagnosing configuration data. Data upload supports breakpoint upload, and uploaded data is kept on the Clinic Server for a maximum of 180 days.
44
---
55

66
# Troubleshoot Clusters Using PingCAP Clinic

Diff for: ‎clinic/quick-start-with-clinic.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Quick Start Guide for PingCAP Clinic
3-
summary: Learn how to use PingCAP Clinic to collect, upload, and view cluster diagnosis data quickly.
3+
summary: PingCAP Clinic is a service for collecting and viewing cluster diagnosis data quickly. It consists of Diag client and Clinic Server. Users can collect diagnostic data with Diag, upload it to Clinic Server, and view the results of Health Report. Before using it, users need to install Diag, log in to Clinic Server, create an organization, get an access token, and set the token and region in Diag. After collecting and uploading data, users can get the data access link and view the Health Report.
44
---
55

66
# Quick Start Guide for PingCAP Clinic

Diff for: ‎dashboard/continuous-profiling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Dashboard Instance Profiling - Continuous Profiling
3-
summary: Learn how to collect performance data from TiDB, TiKV and PD continuously to reduce MTTR.
3+
summary: TiDB Dashboard Continuous Profiling allows experts to collect and analyze performance data continuously from each instance, helping to pinpoint and resolve sophisticated performance problems. It stores more data than Manual Profiling, enabling analysis of both current and historical issues. The feature can be accessed through the dashboard or a browser, and can be enabled and disabled as needed. Performance impact is minimal, making it suitable for production environments.
44
---
55

66
# TiDB Dashboard Instance Profiling - Continuous Profiling

Diff for: ‎dashboard/dashboard-access.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Access TiDB Dashboard
3-
summary: Learn how to access TiDB Dashboard.
3+
summary: To access TiDB Dashboard, visit the specified URL in your browser. For multiple PD instances, replace the address with any PD instance address and port. Use Chrome, Firefox, or Edge browsers of newer versions. Sign in with the TiDB root account or a user-defined SQL user. The session remains valid for 24 hours. Switch between English and Chinese languages. To log out, click the user name and then the Logout button.
44
aliases: ['/docs/dev/dashboard/dashboard-access/']
55
---
66

Diff for: ‎dashboard/dashboard-cluster-info.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Dashboard Cluster Information Page
3-
summary: View the running status of TiDB, TiKV, PD, TiFlash components in the entire cluster and the running status of the host on which these components are located.
3+
summary: The TiDB Dashboard Cluster Information Page allows users to view the running status of TiDB, TiKV, PD, and TiFlash components in the entire cluster, as well as the running status of the host on which these components are located. Users can access the page by logging in to TiDB Dashboard and clicking on Cluster Info in the left navigation menu, or by visiting a specific URL in their browser. The page provides instance, host, and disk lists, showing detailed information about each component and its running status.
44
aliases: ['/docs/dev/dashboard/dashboard-cluster-info/']
55
---
66

Diff for: ‎dashboard/dashboard-diagnostics-access.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Dashboard Cluster Diagnostic Page
3-
summary: Learn how to use the cluster diagnostic page.
3+
summary: TiDB Dashboard Cluster Diagnostics diagnoses cluster problems and summarizes results into a web page. Access the page through the dashboard or browser. Generate diagnostic and comparison reports for specified time ranges. Historical reports are also available.
44
aliases: ['/docs/dev/dashboard/dashboard-diagnostics-access/']
55
---
66

Diff for: ‎dashboard/dashboard-diagnostics-report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Dashboard Diagnostic Report
3-
summary: Learn the TiDB Dashboard diagnostic report.
3+
summary: TiDB Dashboard Diagnostic Report introduces diagnostic report content, including basic, diagnostic, load, overview, monitoring, and configuration information. It also includes comparison report details, DIFF_RATIO explanation, and Maximum Different Item table.
44
aliases: ['/docs/dev/dashboard/dashboard-diagnostics-report/']
55
---
66

Diff for: ‎dashboard/dashboard-diagnostics-usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Locate Problems Using Diagnostic Report of TiDB Dashboard
3-
summary: Learn how to locate problems using diagnostic report of TiDB Dashboard.
3+
summary: TiDB Dashboard's diagnostic report helps locate problems by comparing system performance at different time ranges. It identifies issues like QPS decrease, latency increase, and slow queries, providing detailed analysis and SQL statements for further investigation. This comparison report is essential for quickly identifying and addressing performance issues.
44
aliases: ['/docs/dev/dashboard/dashboard-diagnostics-usage/']
55
---
66

Diff for: ‎dashboard/dashboard-faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Dashboard FAQs
3-
summary: Learn about the frequently asked questions (FAQs) and answers about TiDB Dashboard.
3+
summary: This document summarizes FAQs about TiDB Dashboard. It covers access-related, UI-related, and deployment issues, providing solutions for each problem. If further assistance is needed, support can be obtained from PingCAP or the community.
44
aliases: ['/docs/dev/dashboard/dashboard-faq/']
55
---
66

Diff for: ‎dashboard/dashboard-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TiDB Dashboard Introduction
3-
summary: Introduce TiDB Dashboard.
3+
summary: TiDB Dashboard is a Web UI for monitoring, diagnosing, and managing the TiDB cluster. It shows overall running status, component and host status, traffic distribution, SQL statement execution information, slow queries, cluster diagnostics, log search, resource control, and profiling data collection.
44
aliases: ['/docs/dev/dashboard/dashboard-intro/']
55
---
66

0 commit comments

Comments
 (0)