Skip to content

resource_control: update tools compatibility - #24449

Open
glorv wants to merge 1 commit into
pingcap:masterfrom
glorv:rg-compatibility
Open

glorv wants to merge 1 commit into
pingcap:masterfrom
glorv:rg-compatibility

Conversation

@glorv

@glorv glorv commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

First-time contributors' checklist

What is changed, added, or deleted? (Required)

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

  • Related code change PR links (if applicable):
  • This PR is translated from:
  • Other reference 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 resource control does not affect regular use of BR, TiDB Lightning, or TiCDC, and these tools do not support resource-control DDL operations.
    • Documented that background-task resource control is generally available starting in TiDB v8.5.6, allowing limits on TiKV CPU and I/O for BR backup and restore, IMPORT INTO, and TiDB Lightning tasks.
    • Noted that TiCDC replication and PITR are unsupported, with configuration details and limitations linked.

Signed-off-by: glorv <glorvs@163.com>
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Oct 13, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 13, 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 breezewish 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

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 13, 2026
@glorv
glorv requested review from JmPotato, nolouch and qiancai October 13, 2026 13:35
@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 0a05d692-0e57-4ef9-8e49-8192e371e779
📥 Commits

Reviewing files that changed from the base of the PR and between a0a22ca and ce65502.

📒 Files selected for processing (1)
  • tidb-resource-control-ru-groups.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

The resource-control compatibility documentation now describes background-task limits for BR backup and restore and data import. It also states that TiCDC replication and PITR are unsupported.

Changes: Resource control documentation

Layer / File(s) Summary
Update tool compatibility details
tidb-resource-control-ru-groups.md
The compatibility text documents background-task resource control availability from TiDB v8.5.6 for BR backup and restore and data import, including IMPORT INTO and TiDB Lightning. It notes that TiCDC replication and PITR are unsupported.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to ce655

No concrete compatibility mismatch is established, so the PR appears ready to merge subject to normal checks.

### Architecture Summary

Architecture risk: 🔵 Low · up to ce655

The change affects 1 system.

Changed systems: tidb-resource-control-ru-groups.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — tidb-resource-control-ru-groups.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in tidb-resource-control-ru-groups.md: The compatibility text removes the claim that BR, TiDB Lightning, and TiCDC resource consumption is not limited. It adds that, starting with TiDB v8.5.6, background-task resource control is GA and can limit TiKV CPU and I/O for BR backup/restore and data import, including IMPORT INTO and TiDB Lightning; TiCDC replication and PITR are unsupported, with configuration details linked.
Pre-merge checks · Passed 4 · Failed 1

Failed Failed checks (1 warning)

Check name Status Explanation Resolution
Description check Warning The description selects the affected versions but leaves the required change summary empty. It does not explain what changed or why. Complete the “What is changed, added, or deleted?” section with a concise summary of the compatibility updates and their rationale.
Passed Passed checks (4 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely identifies the main change: updating resource-control tool compatibility documentation.
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.
  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

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. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant