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

Jump to bottom

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

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

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

wants to merge 3 commits into from
+27 −8

Conversation

alastori
Copy link
Contributor

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)?

  • Related Issue: FD-2070 (internal)

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
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 24, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-01-24 07:44:14.475859201 +0000 UTC m=+425981.806778605: ☑️ agreed by dveeden.

@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 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.
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 28, 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 oreoxmt, 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

@alastori
Copy link
Contributor Author

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 qiancai and hfxsd January 28, 2025 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dveeden dveeden dveeden approved these changes

@qiancai qiancai Awaiting requested review from qiancai

@hfxsd hfxsd Awaiting requested review from hfxsd

Assignees

@Oreoxmt Oreoxmt

Labels
do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR. v9.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alastori @dveeden @Oreoxmt