Skip to content

docs: clarify Syncpoint changefeed configuration scope - #23363

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-syncpoint-changefeed
Jul 28, 2026
Merged

docs: clarify Syncpoint changefeed configuration scope#23363
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-syncpoint-changefeed

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Clarify that enable-sync-point is a changefeed configuration item rather than a TiCDC server configuration item.

Update the related Syncpoint wording in these docs so readers know the setting belongs to the changefeed configuration file:

  • ticdc/ticdc-upstream-downstream-check.md
  • dr-secondary-cluster.md

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.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Clarified that enable-sync-point is a TiCDC changefeed configuration item.
    • Updated the prerequisites/terminology to reference creating a changefeed with Syncpoint.
    • Added/clarified how consistent snapshot points are periodically replicated to the secondary cluster when the changefeed is configured.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 64408024-40be-4810-86b6-aee68fbfd6ec

📥 Commits

Reviewing files that changed from the base of the PR and between 3c2aa57 and d015328.

📒 Files selected for processing (1)
  • ticdc/ticdc-upstream-downstream-check.md

📝 Walkthrough

Walkthrough

The changes clarify that Syncpoint is enabled in the TiCDC changefeed configuration and explain how consistent snapshot timestamps are propagated to the secondary cluster.

Changes

Syncpoint documentation

Layer / File(s) Summary
Clarify Syncpoint configuration and behavior
dr-secondary-cluster.md, ticdc/ticdc-upstream-downstream-check.md
Updates Syncpoint guidance to reference the enable-sync-point changefeed configuration item and documents the periodic tidb_external_ts update on the secondary cluster.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change about Syncpoint scope.
Description check ✅ Passed The description includes the required change summary, affected versions, translation link, and AI involvement.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@doc-claw-bot doc-claw-bot added type/enhancement The issue or PR belongs to an enhancement. area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. labels Jul 28, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 28, 2026
Comment thread ticdc/ticdc-upstream-downstream-check.md Outdated
Co-authored-by: dongmen <20351731+asddongmen@users.noreply.github.com>
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-07-28 02:12:19.796074665 +0000 UTC m=+1889325.832169741: ☑️ agreed by qiancai.

@qiancai qiancai self-assigned this Jul 28, 2026
@qiancai qiancai added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jul 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

@asddongmen: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@qiancai

qiancai commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Jul 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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 Jul 28, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 24494e7 into pingcap:master Jul 28, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

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

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

Labels

approved area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/enhancement The issue or PR belongs to an enhancement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants