Skip to content
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

add the prefix dm- to the filenames for some DM dev docs #869

Closed
wants to merge 12 commits into from
68 changes: 34 additions & 34 deletions en/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<!-- markdownlint-disable MD041 -->

- About DM
- [DM Overview](overview.md)
- [DM Overview](dm-overview.md)
- [DM 5.3 Release Notes](releases/5.3.0.md)
- Basic Features
- [Table Routing](key-features.md#table-routing)
- [Block and Allow Lists](key-features.md#block-and-allow-table-lists)
- [Binlog Event Filter](key-features.md#binlog-event-filter)
- [Table Routing](dm-key-features.md#table-routing)
- [Block and Allow Lists](dm-key-features.md#block-and-allow-table-lists)
- [Binlog Event Filter](dm-key-features.md#binlog-event-filter)
- Advanced Features
- Merge and Migrate Data from Sharded Tables
- [Overview](feature-shard-merge.md)
Expand All @@ -16,7 +16,7 @@
- [Migrate from MySQL Databases that Use GH-ost/PT-osc](feature-online-ddl.md)
- [Filter Certain Row Changes Using SQL Expressions](feature-expression-filter.md)
- [DM Architecture](dm-arch.md)
- [Benchmarks](benchmark-v5.3.0.md)
- [Benchmarks](dm-benchmark-v5.3.0.md)
- Quick Start
- [Quick Start](quick-start-with-dm.md)
- [Deploy a DM cluster Using TiUP](deploy-a-dm-cluster-using-tiup.md)
Expand All @@ -28,64 +28,64 @@
- [Migrate Incremental Data to TiDB](usage-scenario-incremental-migration.md)
- [Migrate Tables when There Are More Columns Downstream](usage-scenario-downstream-more-columns.md)
- Deploy
- [Software and Hardware Requirements](hardware-and-software-requirements.md)
- [Software and Hardware Requirements](dm-hardware-and-software-requirements.md)
- Deploy a DM Cluster
- [Use TiUP (Recommended)](deploy-a-dm-cluster-using-tiup.md)
- [Use TiUP Offline](deploy-a-dm-cluster-using-tiup-offline.md)
- [Use Binary](deploy-a-dm-cluster-using-binary.md)
- [Use Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/dev/deploy-tidb-dm)
- [Migrate Data Using DM](migrate-data-using-dm.md)
- [Test DM Performance](performance-test.md)
- [Test DM Performance](dm-performance-test.md)
- Maintain
- Tools
- [Maintain DM Clusters Using TiUP (Recommended)](maintain-dm-using-tiup.md)
- [Maintain DM Clusters Using dmctl](dmctl-introduction.md)
- [Maintain DM Clusters Using OpenAPI](open-api.md)
- [Maintain DM Clusters Using OpenAPI](dm-open-api.md)
- Cluster Upgrade
- [Manually Upgrade from v1.0.x to v2.0+](manually-upgrade-dm-1.0-to-2.0.md)
- [Manage Data Source](manage-source.md)
- [Manage Data Source](dm-manage-source.md)
- Manage a Data Migration Task
- [Task Configuration Guide](task-configuration-guide.md)
- [Precheck a Task](precheck.md)
- [Create a Task](create-task.md)
- [Query Status](query-status.md)
- [Pause a Task](pause-task.md)
- [Resume a Task](resume-task.md)
- [Stop a Task](stop-task.md)
- [Export and Import Data Sources and Task Configuration of Clusters](export-import-config.md)
- [Task Configuration Guide](dm-task-configuration-guide.md)
- [Precheck a Task](dm-precheck.md)
- [Create a Task](dm-create-task.md)
- [Query Status](dm-query-status.md)
- [Pause a Task](dm-pause-task.md)
- [Resume a Task](dm-resume-task.md)
- [Stop a Task](dm-stop-task.md)
- [Export and Import Data Sources and Task Configuration of Clusters](dm-export-import-config.md)
- [Handle Failed DDL Statements](handle-failed-ddl-statements.md)
- [Manually Handle Sharding DDL Lock](manually-handling-sharding-ddl-locks.md)
- [Manage Schemas of Tables to be Migrated](manage-schema.md)
- [Handle Alerts](handle-alerts.md)
- [Daily Check](daily-check.md)
- [Manage Schemas of Tables to be Migrated](dm-manage-schema.md)
- [Handle Alerts](dm-handle-alerts.md)
- [Daily Check](dm-daily-check.md)
- Usage Scenarios
- [Migrate from Aurora to TiDB](migrate-from-mysql-aurora.md)
- [Migrate when TiDB Tables Have More Columns](usage-scenario-downstream-more-columns.md)
- [Switch the MySQL Instance to Be Migrated](usage-scenario-master-slave-switch.md)
- Troubleshoot
- [Handle Errors](error-handling.md)
- [Handle Performance Issues](handle-performance-issues.md)
- [Handle Errors](dm-error-handling.md)
- [Handle Performance Issues](dm-handle-performance-issues.md)
- Performance Tuning
- [Optimize Configuration](tune-configuration.md)
- [Optimize Configuration](dm-tune-configuration.md)
- Reference
- Architecture
- [DM Architecture Overview](overview.md)
- [DM Architecture Overview](dm-overview.md)
- [DM-worker](dm-worker-intro.md)
- [Command-line Flags](command-line-flags.md)
- [Command-line Flags](dm-command-line-flags.md)
- Configuration
- [Overview](config-overview.md)
- [Overview](dm-config-overview.md)
- [DM-master Configuration](dm-master-configuration-file.md)
- [DM-worker Configuration](dm-worker-configuration-file.md)
- [Upstream Database Configuration](source-configuration-file.md)
- [Data Migration Task Configuration](task-configuration-guide.md)
- [Upstream Database Configuration](dm-source-configuration-file.md)
- [Data Migration Task Configuration](dm-task-configuration-guide.md)
- Secure
- [Enable TLS for DM Connections](enable-tls.md)
- [Generate Self-signed Certificates](generate-self-signed-certificates.md)
- [Enable TLS for DM Connections](dm-enable-tls.md)
- [Generate Self-signed Certificates](dm-generate-self-signed-certificates.md)
- [Monitoring Metrics](monitor-a-dm-cluster.md)
- [Alert Rules](alert-rules.md)
- [Error Codes](error-handling.md#handle-common-errors)
- [FAQ](faq.md)
- [Glossary](glossary.md)
- [Alert Rules](dm-alert-rules.md)
- [Error Codes](dm-error-handling.md#handle-common-errors)
- [FAQ](dm-faq.md)
- [Glossary](dm-glossary.md)
- Release Notes
- v5.3
- [5.3.0](releases/5.3.0.md)
Expand Down
14 changes: 7 additions & 7 deletions en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ aliases: ['/docs/tidb-data-migration/dev/']
<NavColumn>
<ColumnTitle>About TiDB Data Migration</ColumnTitle>

- [What is DM?](overview.md)
- [What is DM?](dm-overview.md)
- [DM Architecture](dm-arch.md)
- [Performance](benchmark-v2.0-ga.md)

Expand All @@ -36,12 +36,12 @@ aliases: ['/docs/tidb-data-migration/dev/']
<NavColumn>
<ColumnTitle>Deploy and Use</ColumnTitle>

- [Software and Hardware Requirements](hardware-and-software-requirements.md)
- [Software and Hardware Requirements](dm-hardware-and-software-requirements.md)
- [Deploy DM Using TiUP (Recommended)](deploy-a-dm-cluster-using-tiup.md)
- [Deploy DM Using TiUP Offline](deploy-a-dm-cluster-using-tiup-offline.md)
- [Deploy DM Using Binary](deploy-a-dm-cluster-using-binary.md)
- [Use DM to Migrate Data](migrate-data-using-dm.md)
- [DM Performance Test](performance-test.md)
- [DM Performance Test](dm-performance-test.md)

</NavColumn>

Expand All @@ -52,8 +52,8 @@ aliases: ['/docs/tidb-data-migration/dev/']
- [Maintain DM Clusters Using dmctl](dmctl-introduction.md)
- [Upgrade DM](manually-upgrade-dm-1.0-to-2.0.md)
- [Manually Handle Sharding DDL Locks](manually-handling-sharding-ddl-locks.md)
- [Handle Alerts](handle-alerts.md)
- [Daily Check](daily-check.md)
- [Handle Alerts](dm-handle-alerts.md)
- [Daily Check](dm-daily-check.md)

</NavColumn>

Expand All @@ -69,9 +69,9 @@ aliases: ['/docs/tidb-data-migration/dev/']
<ColumnTitle>Reference</ColumnTitle>

- [DM Architecture](dm-arch.md)
- [Configuration File Overview](config-overview.md)
- [Configuration File Overview](dm-config-overview.md)
- [Monitoring Metrics and Alerts](monitor-a-dm-cluster.md)
- [Error Handling](error-handling.md)
- [Error Handling](dm-error-handling.md)

</NavColumn>

Expand Down
6 changes: 3 additions & 3 deletions en/benchmark-v1.0-ga.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Others:

## Test scenario

You can use a simple data migration flow, that is, MySQL1 (172.16.4.40) -> DM-worker -> TiDB (172.16.4.41), to do the test. For detailed test scenario description, see [performance test](performance-test.md).
You can use a simple data migration flow, that is, MySQL1 (172.16.4.40) -> DM-worker -> TiDB (172.16.4.41), to do the test. For detailed test scenario description, see [performance test](dm-performance-test.md).

### Full import benchmark case

For details, see [Full Import Benchmark Case](performance-test.md#full-import-benchmark-case).
For details, see [Full Import Benchmark Case](dm-performance-test.md#full-import-benchmark-case).

#### Full import benchmark result

Expand Down Expand Up @@ -105,7 +105,7 @@ Full import data size in this benchmark case is 3.78 GB, load unit pool size use

### Incremental replication benchmark case

For details about the test method, see [Incremental Replication Benchmark Case](performance-test.md#incremental-replication-benchmark-case).
For details about the test method, see [Incremental Replication Benchmark Case](dm-performance-test.md#incremental-replication-benchmark-case).

#### Benchmark result for incremental replication

Expand Down
6 changes: 3 additions & 3 deletions en/benchmark-v2.0-ga.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ Others:

## Test scenario

You can use a simple data migration flow, that is, MySQL1 (172.16.5.33) -> DM-worker(172.16.5.32) -> TiDB (172.16.5.34), to do the test. For detailed test scenario description, see [performance test](performance-test.md).
You can use a simple data migration flow, that is, MySQL1 (172.16.5.33) -> DM-worker(172.16.5.32) -> TiDB (172.16.5.34), to do the test. For detailed test scenario description, see [performance test](dm-performance-test.md).

### Full import benchmark case

For detailed full import test method, see [Full Import Benchmark Case](performance-test.md#full-import-benchmark-case).
For detailed full import test method, see [Full Import Benchmark Case](dm-performance-test.md#full-import-benchmark-case).

#### Full import benchmark results

Expand Down Expand Up @@ -105,7 +105,7 @@ In this test, the full amount of imported data is 3.78 GB and the `pool-size` of

### Incremental replication benchmark case

For detailed incremental replication test method, see [Incremental Replication Benchmark Case](performance-test.md#incremental-replication-benchmark-case).
For detailed incremental replication test method, see [Incremental Replication Benchmark Case](dm-performance-test.md#incremental-replication-benchmark-case).

#### Incremental replication benchmark result

Expand Down
2 changes: 1 addition & 1 deletion en/deploy-a-dm-cluster-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ TiUP supports deploying DM v2.0 or later DM versions. This document introduces h

When DM performs a full data replication task, the DM-worker is bound with only one upstream database. The DM-worker first exports the full amount of data locally, and then imports the data into the downstream database. Therefore, the worker's host needs sufficient storage space (The storage path is specified later when you create the task).

In addition, you need to meet the [hardware and software requirements](hardware-and-software-requirements.md) when deploying a DM cluster.
In addition, you need to meet the [hardware and software requirements](dm-hardware-and-software-requirements.md) when deploying a DM cluster.

## Step 1: Install TiUP on the control machine

Expand Down
25 changes: 13 additions & 12 deletions en/alert-rules.md → en/dm-alert-rules.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: DM Alert Information
summary: Introduce the alert information of DM.
---

# DM Alert Information

The [alert system](migrate-data-using-dm.md#step-8-monitor-the-task-and-check-logs) is deployed by default when you deploy a DM cluster using TiUP.

For more information about DM alert rules and the solutions, refer to [handle alerts](handle-alerts.md).

Both DM alert information and monitoring metrics are based on Prometheus. For more information about their relationship, refer to [DM monitoring metrics](monitor-a-dm-cluster.md).
---
title: DM Alert Information
summary: Introduce the alert information of DM.
aliases: ['/tidb-data-migration/dev/alert-rules/']
---

# DM Alert Information

The [alert system](migrate-data-using-dm.md#step-8-monitor-the-task-and-check-logs) is deployed by default when you deploy a DM cluster using TiUP.

For more information about DM alert rules and the solutions, refer to [handle alerts](dm-handle-alerts.md).

Both DM alert information and monitoring metrics are based on Prometheus. For more information about their relationship, refer to [DM monitoring metrics](monitor-a-dm-cluster.md).
7 changes: 4 additions & 3 deletions en/benchmark-v5.3.0.md → en/dm-benchmark-v5.3.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: DM 5.3.0 Benchmark Report
summary: Learn about the performance of 5.3.0.
aliases: ['/tidb-data-migration/dev/benchmark-v5.3.0/']
---

# DM 5.3.0 Benchmark Report
Expand Down Expand Up @@ -53,11 +54,11 @@ Others:

## Test scenario

You can use a simple data migration flow, that is, MySQL1 (172.16.6.1) -> DM-worker(172.16.6.2) -> TiDB(load balance) (172.16.6.4), to do the test. For detailed test scenario description, see [performance test](performance-test.md).
You can use a simple data migration flow, that is, MySQL1 (172.16.6.1) -> DM-worker(172.16.6.2) -> TiDB(load balance) (172.16.6.4), to do the test. For detailed test scenario description, see [performance test](dm-performance-test.md).

### Full import benchmark case

For detailed full import test method, see [Full Import Benchmark Case](performance-test.md#full-import-benchmark-case).
For detailed full import test method, see [Full Import Benchmark Case](dm-performance-test.md#full-import-benchmark-case).

#### Full import benchmark results

Expand Down Expand Up @@ -99,7 +100,7 @@ In this test, the full amount of imported data is 3.78 GB and the `pool-size` of

### Incremental replication benchmark case

For detailed incremental replication test method, see [Incremental Replication Benchmark Case](performance-test.md#incremental-replication-benchmark-case).
For detailed incremental replication test method, see [Incremental Replication Benchmark Case](dm-performance-test.md#incremental-replication-benchmark-case).

#### Incremental replication benchmark result

Expand Down
1 change: 1 addition & 0 deletions en/command-line-flags.md → en/dm-command-line-flags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Command-line Flags
summary: Learn about the command-line flags in DM.
aliases: ['/tidb-data-migration/dev/command-line-flags/']
---

# Command-line Flags
Expand Down
10 changes: 5 additions & 5 deletions en/config-overview.md → en/dm-config-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Data Migration Configuration File Overview
summary: This document gives an overview of Data Migration configuration files.
aliases: ['/docs/tidb-data-migration/dev/config-overview/']
aliases: ['/docs/tidb-data-migration/dev/config-overview/','/tidb-data-migration/dev/config-overview/']
---

# Data Migration Configuration File Overview
Expand All @@ -12,17 +12,17 @@ This document gives an overview of configuration files of DM (Data Migration).

- `dm-master.toml`: The configuration file of running the DM-master process, including the topology information and the logs of the DM-master. For more details, refer to [DM-master Configuration File](dm-master-configuration-file.md).
- `dm-worker.toml`: The configuration file of running the DM-worker process, including the topology information and the logs of the DM-worker. For more details, refer to [DM-worker Configuration File](dm-worker-configuration-file.md).
- `source.yaml`: The configuration of the upstream database such as MySQL and MariaDB. For more details, refer to [Upstream Database Configuration File](source-configuration-file.md).
- `source.yaml`: The configuration of the upstream database such as MySQL and MariaDB. For more details, refer to [Upstream Database Configuration File](dm-source-configuration-file.md).

## DM migration task configuration

### Data migration task creation

You can take the following steps to create a data migration task:

1. [Load the data source configuration into the DM cluster using dmctl](manage-source.md#operate-data-source).
2. Refer to the description in the [Task Configuration Guide](task-configuration-guide.md) and create the configuration file `your_task.yaml`.
3. [Create the data migration task using dmctl](create-task.md).
1. [Load the data source configuration into the DM cluster using dmctl](dm-manage-source.md#operate-data-source).
2. Refer to the description in the [Task Configuration Guide](dm-task-configuration-guide.md) and create the configuration file `your_task.yaml`.
3. [Create the data migration task using dmctl](dm-create-task.md).

### Important concepts

Expand Down
3 changes: 2 additions & 1 deletion en/create-task.md → en/dm-create-task.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Create a Data Migration Task
summary: Learn how to create a data migration task in TiDB Data Migration.
aliases: ['/tidb-data-migration/dev/create-task/']
---

# Create a Data Migration Task

You can use the `start-task` command to create a data migration task. When the data migration task is started, DM [prechecks privileges and configurations](precheck.md).
You can use the `start-task` command to create a data migration task. When the data migration task is started, DM [prechecks privileges and configurations](dm-precheck.md).

{{< copyable "" >}}

Expand Down
4 changes: 2 additions & 2 deletions en/daily-check.md → en/dm-daily-check.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Daily Check
summary: Learn about the daily check of TiDB Data Migration (DM).
aliases: ['/docs/tidb-data-migration/dev/daily-check/']
aliases: ['/docs/tidb-data-migration/dev/daily-check/','/tidb-data-migration/dev/daily-check/']
---

# Daily Check

This document summarizes how to perform a daily check on TiDB Data Migration (DM).

+ Method 1: Execute the `query-status` command to check the running status of the task and the error output (if any). For details, see [Query Status](query-status.md).
+ Method 1: Execute the `query-status` command to check the running status of the task and the error output (if any). For details, see [Query Status](dm-query-status.md).

+ Method 2: If Prometheus and Grafana are correctly deployed when you deploy the DM cluster using TiUP, you can view DM monitoring metrics in Grafana. For example, suppose that the Grafana's address is `172.16.10.71`, go to <http://172.16.10.71:3000>, enter the Grafana dashboard, and select the DM Dashboard to check monitoring metrics of DM. For more information of these metrics, see [DM Monitoring Metrics](monitor-a-dm-cluster.md).

Expand Down
3 changes: 2 additions & 1 deletion en/enable-tls.md → en/dm-enable-tls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Enable TLS for DM Connections
summary: Learn how to enable TLS for DM connections.
aliases: ['/tidb-data-migration/dev/enable-tls/']
---

# Enable TLS for DM Connections
Expand All @@ -19,7 +20,7 @@ This section introduces how to enable encrypted data transmission between DM-mas

To generate self-signed certificates, you can use `openssl`, `cfssl` and other tools based on `openssl`, such as `easy-rsa`.

If you choose `openssl`, you can refer to [generating self-signed certificates](generate-self-signed-certificates.md).
If you choose `openssl`, you can refer to [generating self-signed certificates](dm-generate-self-signed-certificates.md).

2. Configure certificates.

Expand Down
Loading