Skip to content

docs: clarify binlog deprecation in TLS guide (#3175) - #3180

Open
ti-chi-bot wants to merge 6 commits into
pingcap:release-1.xfrom
ti-chi-bot:cherry-pick-3175-to-release-1.x
Open

ti-chi-bot wants to merge 6 commits into
pingcap:release-1.xfrom
ti-chi-bot:cherry-pick-3175-to-release-1.x

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Sep 20, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #3175

Summary

  • add TiDB Binlog deprecation warnings to the Pump and Drainer sections of the TLS guide
  • clarify that the importer-related certificates are for the TiDB Lightning local backend (TiKV Importer)
  • update both English and Chinese docs on release-1.6

Validation

  • reviewed the scoped git diff
  • ran git diff --check

Summary by CodeRabbit

  • Documentation
    • Clarified that TiKV Importer certificates are required only when restoring data with TiDB Lightning’s local backend.
    • Updated component naming to “TiDB Lightning local backend (TiKV Importer)” in TLS configuration guidance.
    • Added deprecation and removal notices for Pump and Drainer, with TiCDC recommended for incremental data synchronization.
    • Applied these updates to both English and Chinese documentation.

@ti-chi-bot ti-chi-bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-1.x This PR is cherry-picked to release-1.x from a source PR. labels Sep 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

[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 assign icemap for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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

@coderabbitai

coderabbitai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: c0ee09f7-765d-448e-9d53-68881ae89b4e

📥 Commits

Reviewing files that changed from the base of the PR and between 7f66324 and a9d4760.

📒 Files selected for processing (2)
  • en/enable-tls-between-components.md
  • zh/enable-tls-between-components.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The English and Chinese TLS guides clarify that TiKV Importer certificates apply to the TiDB Lightning local backend. They also add TiDB Binlog deprecation warnings for Pump and Drainer sections.

Changes

TLS documentation updates

Layer / File(s) Summary
TiDB Lightning certificate scope
en/enable-tls-between-components.md, zh/enable-tls-between-components.md
The guides rename TiKV Importer references and limit the related certificate requirement to TiDB Lightning’s local backend.
TiDB Binlog deprecation warnings
en/enable-tls-between-components.md, zh/enable-tls-between-components.md
The Pump and Drainer sections state the TiDB Binlog deprecation timeline and recommend TiCDC for incremental replication.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main documentation change: clarification of TiDB Binlog deprecation in the TLS guide.
Description check ✅ Passed The description explains the changes and validation steps. It also states that the updates apply to release-1.6, although it does not select the corresponding template checkbox or provide reference li…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 a new PR

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

A rabbit reads the TLS guide,
Importer names now stand beside
Lightning’s local path,
Binlog warnings mark the past,
TiCDC hops where new streams glide.

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

@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

@coderabbitai[bot]: 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.

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

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-1.x This PR is cherry-picked to release-1.x from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants