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.

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

tools: update DM TOC and refine content #869

Merged
merged 2 commits into from
Jan 28, 2019
Merged

tools: update DM TOC and refine content #869

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c1d45c
tools: update DM TOC and refine content
lilin90 Jan 24, 2019
ec6c974
readme: update DM Deploy link
lilin90 Jan 28, 2019
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
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,19 +123,26 @@
- [mydumper](tools/mydumper.md)
- [Loader](tools/loader.md)
+ Data Migration
+ Overview
- [Architecture](tools/data-migration-overview.md#architecture)
- [Features](tools/data-migration-overview.md#data-synchronization-introduction)
- [Restrictions](tools/data-migration-overview.md#usage-restrictions)
- [Overview](tools/data-migration-overview.md)
- [Restrictions](tools/data-migration-overview.md#usage-restrictions)
+ Features
- [Table Routing](tools/dm-data-synchronization-features.md#table-routing)
- [Black and White Lists](tools/dm-data-synchronization-features.md#black-and-white-table-lists)
- [Binlog Event Filtering](tools/dm-data-synchronization-features.md#binlog-event-filtering)
- [Column Mapping](tools/dm-data-synchronization-features.md#column-mapping)
- [Synchronization Delay Monitoring](tools/dm-data-synchronization-features.md#synchronization-delay-monitoring)
+ Sharding Support
- [Introduction](tools/dm-sharding-solution.md)
- [Restrictions](tools/dm-sharding-solution.md#sharding-ddl-usage-restrictions)
- [Troubleshoot](tools/troubleshooting-sharding-ddl-locks.md)
+ Usage Scenarios
- [Simple Scenario](tools/dm-simple-synchronization-scenario.md)
- [Shard Merge Scenario](tools/dm-shard-merge-scenario.md)
- [Deploy](tools/data-migration-deployment.md)
- [Synchronize Data](tools/data-migration-practice.md)
- [Synchronize](tools/data-migration-practice.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a more meaningful name?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@csuzhangxc Do you have any suggestions on this? :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get Started? 😂

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha~ Thanks for your suggestion, but I think it might be a little bit weird to use "Get Started" in this position. @GregoryIan What's your opinion and suggestion?

Copy link
Contributor

@IANTHEREAL IANTHEREAL Jan 25, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a step by step instructions using dm-ansible. it should belong to Get Started

Copy link
Contributor

@IANTHEREAL IANTHEREAL Jan 25, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this file contains deoployment and how to synchroniza data, Get Started may be better

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to add a step by step instrucation that contains deploy dm manually and create a simple task, like this file do

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GregoryIan Perhaps just leave a Deploy in the TOC that points to the tools/data-migration-practice.md file? That file about deploying the DM cluster using DM-Ansible is also mentioned in this file.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about

[get started](tools/data-migration-practice.md)
Deploy
- [ansible](tools/data-migration-deployment.md)
- [binary](xxxxx)

What I can confirm is that we have to need a get started. If the content of tools/data-migration-practice.md is not a good enough, we can modify it.

+ Configure
- [Configuration Overview](tools/dm-configuration-file-overview.md)
- [Task Configuration File](tools/dm-task-configuration-file-intro.md)
+ Sharding Data Solution
- [Overview and Design Details](tools/dm-sharding-solution.md)
- [Sharding DDL Usage Restrictions](tools/dm-sharding-solution.md#sharding-ddl-usage-restrictions)
- [Troubleshoot Sharding DDL Locks](tools/troubleshooting-sharding-ddl-locks.md)
- [Overview](tools/dm-configuration-file-overview.md)
- [Task Configuration](tools/dm-task-configuration-file-intro.md)
- [Monitor](tools/dm-monitor.md)
- [Manage the Task](tools/data-migration-manage-task.md)
- [Cluster Operations](tools/data-migration-cluster-operations.md)
Expand Down
7 changes: 6 additions & 1 deletion tools/data-migration-manage-task.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ To detect possible errors of data synchronization configuration in advance, DM p

The user of the upstream and downstream databases must have the corresponding read and write privileges. DM checks the following privileges and configuration automatically while starting the data synchronization task:

+ Database version

- 5.5 < MySQL version < 5.8
- MariaDB version >= 10.1.2

+ MySQL binlog configuration

- Whether the binlog is enabled (DM requires that the binlog must be enabled)
Expand Down Expand Up @@ -193,7 +198,7 @@ start-task [ -w "172.16.30.15:10081"] ./task.yaml

### Check the data synchronization task status

You can use the task management command to check the status of the data synchronization task.
You can use the `query-status` task management command to check the status of the data synchronization task. For details about the query result and subtask status, see [Query Status](../tools/dm-query-status.md).

```bash
» help query-status
Expand Down
2 changes: 1 addition & 1 deletion tools/data-migration-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ DM-worker executes specific data synchronization tasks.
- Orchestrating the operation of the data synchronization subtasks
- Monitoring the running state of the data synchronization subtasks

For details about DM-worker, see [DM-worker Introduction](../tools/dm-worker-intro.md).
After DM-worker is started, it automatically synchronizes the upstream binlog to the local configuration directory (the default synchronization directory is `<deploy_dir>/relay_log` if DM is deployed using `DM-Ansible`). For details about DM-worker, see [DM-worker Introduction](../tools/dm-worker-intro.md). For details about the relay log, see [Relay Log](../tools/dm-relay-log.md).

### dmctl

Expand Down
4 changes: 4 additions & 0 deletions tools/data-migration-practice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ mydumpers:

## Step 4: Start the data synchronization task

> **Note:**
>
> To detect possible errors of data synchronization configuration in advance, DM provides the precheck feature. DM automatically checks the corresponding privileges and configuration while starting the data synchronization task. You can also use the `check-task` command to manually precheck whether the upstream MySQL instance configuration satisfies the DM requirements. For details about the precheck feature, see [Precheck the upstream MySQL instance configuration](../tools/data-migration-manage-task.md#precheck-the-upstream-mysql-instance-configuration).

1. Come to the dmctl directory `/home/tidb/dm-ansible/resource/bin/`.

2. Run the following command to start dmctl.
Expand Down