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

Quick start dm playground #19925

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

alastori
Copy link
Contributor

@alastori alastori commented Jan 7, 2025

What is changed, added or deleted? (Required)

This PR updates the TiDB Data Migration Quick Start guide. Changes include:

  • Replacing binary-based deployment instructions with TiUP Playground to simplify setup.
  • Adding detailed steps for preparing source databases on Docker, macOS, CentOS, and Ubuntu.
  • Simplifying and clarifying the steps for DM configuration and task creation.
  • Adding explicit cleanup instructions and actionable examples to improve usability.

These changes aim to make the guide more accurate, complete, and easier to follow for users setting up a local data migration environment.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 7, 2025
@lilin90 lilin90 self-assigned this Jan 8, 2025
@lilin90 lilin90 added the translation/doing This PR's assignee is translating this PR. label Jan 8, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 8, 2025
@lilin90 lilin90 added type/enhancement The issue or PR belongs to an enhancement. missing-translation-status This PR does not have translation status info. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Jan 8, 2025
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved
dm/quick-start-with-dm.md Outdated Show resolved Hide resolved

{{< copyable "shell-regular" >}}
```shell
tiup playground --dm-master 1 --dm-worker 1 --tiflash 0 --without-monitor
Copy link
Collaborator

Choose a reason for hiding this comment

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

The --dm-master and --dm-worker flags require TiUP v1.16.1 or later.

To help users with older TiUP versions understand the requirement and provide clear upgrade instructions, please add a note in the document.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I’ve addressed this in this commit adding a note to Step 1.1.

Co-authored-by: Aolin <aolinz@outlook.com>
Copy link

ti-chi-bot bot commented Jan 9, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
missing-translation-status This PR does not have translation status info. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants