Skip to content

docs: update sync-diff-inspector docs for move to tiflow repo#20140

Merged
ti-chi-bot[bot] merged 9 commits intopingcap:masterfrom
alastori:update-sync-diff-inspector-repo
Mar 27, 2025
Merged

docs: update sync-diff-inspector docs for move to tiflow repo#20140
ti-chi-bot[bot] merged 9 commits intopingcap:masterfrom
alastori:update-sync-diff-inspector-repo

Conversation

@alastori
Copy link
Collaborator

@alastori alastori commented Jan 24, 2025 •
edited by Oreoxmt
Loading

What is changed, added or deleted? (Required)

This PR updates the documentation to reflect the move of sync_diff_inspector from tidb-tools to tiflow repository for TiDB 9.0.0 and later versions. The changes include:

  • Update GitHub repository links from tidb-tools to tiflow
  • Add TiUP installation method for v9.0.0+
  • Update Docker image references
  • Add version-specific installation instructions
  • Update download-ecosystem-tools.md with new package information

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

  • 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

@alastori
docs: update sync-diff-inspector docs for move to tiflow repo
8317102 
- Update GitHub repository links from tidb-tools to tiflow

- Add TiUP installation method for v9.0.0+

- Update Docker image references

- Add version-specific installation instructions

- Update download-ecosystem-tools.md with new package information
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 24, 2025
@ti-chi-bot ti-chi-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 24, 2025
dveeden
dveeden approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@dveeden dveeden left a comment

Choose a reason for hiding this comment

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

docker pull pingcap/tiflow:latest doesn't yet seem to work for me. Is this an issue on my side, is this not published yet or is there something else?

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 24, 2025
@Oreoxmt Oreoxmt self-assigned this Jan 26, 2025
@Oreoxmt Oreoxmt added translation/doing This PR's assignee is translating this PR. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. v9.0-beta.1 This PR/issue applies to TiDB v9.0-beta.1. labels Jan 26, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 26, 2025
@alastori
Update sync-diff-inspector-overview.md
8032c47 
Update Docker image for sync-diff-inspector

The previous `docker pull pingcap/tiflow:latest` command was incorrect. After confirming with Flare Zuo (R&D Group - Engineering Productivity - Efficiency & Ops team), we should use `docker pull pingcap/sync-diff-inspector:latest` to align with TiCDC and DM, ensuring consistency across TiFlow-managed images.

This update reflects the correct image name for better usability.
@alastori
Copy link
Collaborator Author

alastori commented Jan 28, 2025

docker pull pingcap/tiflow:latest doesn't yet seem to work for me. Is this an issue on my side, is this not published yet or is there something else?

@dveeden Thanks for catching this!

I initially assumed docker pull pingcap/tiflow:latest, but after verifying with R&D Engineering Productivity, the correct image will be pingcap/sync-diff-inspector:latest. This aligns with how we handle TiCDC and DM images under TiFlow.

I’ve updated the docs accordingly in commit 8032c47. Let me know if you have any concerns!

@dveeden dveeden requested review from hfxsd and qiancai January 28, 2025 19:53
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Feb 26, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 26, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-01-24 07:44:14.475859201 +0000 UTC m=+425981.806778605: ☑️ agreed by dveeden.
  • 2025-02-26 08:19:01.479654292 +0000 UTC m=+430289.432812578: ☑️ agreed by Oreoxmt.

@Oreoxmt Oreoxmt mentioned this pull request Mar 6, 2025
Merged
15 tasks
@Oreoxmt Oreoxmt added area/sync-diff-inspector Indicates that the Issue or PR belongs to the area of sync-diff-inspector. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Mar 6, 2025
@Oreoxmt Oreoxmt removed the request for review from hfxsd March 6, 2025 07:31
@Oreoxmt Oreoxmt added the type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. label Mar 6, 2025
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Mar 6, 2025

/cc @qiancai

qiancai
qiancai reviewed Mar 7, 2025
View reviewed changes
@alastori @qiancai
Update download-ecosystem-tools.md
b288bc9 
Co-authored-by: Grace Cai <qqzczy@126.com>
qiancai
qiancai reviewed Mar 14, 2025
View reviewed changes
alastori and others added 2 commits March 17, 2025 12:55
@Oreoxmt Oreoxmt requested a review from qiancai March 25, 2025 02:57
qiancai
qiancai reviewed Mar 26, 2025
View reviewed changes
qiancai
qiancai approved these changes Mar 26, 2025
View reviewed changes
Copy link
Collaborator

@qiancai qiancai left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Oreoxmt
Oreoxmt reviewed Mar 26, 2025
View reviewed changes
@alastori @Oreoxmt
Update sync-diff-inspector/sync-diff-inspector-overview.md
c8580cb 
Co-authored-by: Aolin <aolinz@outlook.com>
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Mar 27, 2025

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 27, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Oreoxmt

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

The pull request process is described here

Details 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

@ti-chi-bot ti-chi-bot bot added the approved label Mar 27, 2025
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Mar 27, 2025

/unhold

@ti-chi-bot ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 27, 2025
@ti-chi-bot ti-chi-bot bot merged commit 5793566 into pingcap:master Mar 27, 2025
9 checks passed
@hfxsd hfxsd added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Mar 6, 2026
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Mar 6, 2026

In response to a cherrypick label: new pull request created to branch release-8.5: #22540.

This was referenced Mar 6, 2026
Open
Open
joechenrh

This comment was marked as resolved.

Sign in to view

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Oreoxmt Oreoxmt Oreoxmt approved these changes

@dveeden dveeden dveeden approved these changes

@qiancai qiancai qiancai approved these changes

+1 more reviewer

@joechenrh joechenrh joechenrh left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@Oreoxmt Oreoxmt

Labels

approved area/sync-diff-inspector Indicates that the Issue or PR belongs to the area of sync-diff-inspector. lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.1 This PR/issue applies to TiDB v9.0-beta.1.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@alastori @Oreoxmt @ti-chi-bot @dveeden @joechenrh @qiancai @hfxsd