Skip to content

pd: note that the scheduling microservice does not support label-property - #24593

Open
lhy1024 wants to merge 3 commits into
pingcap:masterfrom
lhy1024:pd-microservices-label-property
Open

lhy1024 wants to merge 3 commits into
pingcap:masterfrom
lhy1024:pd-microservices-label-property

Conversation

@lhy1024

@lhy1024 lhy1024 commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

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

Clarify that the scheduling microservice does not support the deprecated label-property configuration. Add this restriction to the PD microservices page and add a note to the label-property section recommending Placement Rules or evict-leader-scheduler to keep leaders off specific stores.

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.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 the scheduling microservice does not support the deprecated label-property configuration in PD microservice mode, so reject-leader label properties have no effect while it is enabled.
    • Added guidance to use Placement Rules or evict-leader-scheduler to keep leaders off specific stores.
    • Clarified that label-property takes effect again when PD schedules through enable-scheduling-fallback because no scheduling microservice is available.

Signed-off-by: lhy1024 <19542290+lhy1024@users.noreply.github.com>
@ti-chi-bot

ti-chi-bot Bot commented Oct 29, 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 kissmydb 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 missing-translation-status This PR does not have translation status info. label Oct 29, 2026
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 29, 2026
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: pingcap/docs
  • Branch: master
  • File: .coderabbit.yaml
  • Commit: e5e80ae
  • Layers: Repository YAML
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 48dd1510-6633-49f3-baf4-607fb3da55a7
Commits

Reviewing files that changed from the base of the PR and between f489d07 and cf4d1e3.

Files selected for processing: 1
  • pd-microservices.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 PD configuration and microservices documentation describe the label-property limitation when the scheduling microservice is enabled. They name Placement Rules and evict-leader-scheduler as alternatives and state that label-property takes effect when PD uses scheduling fallback.

Changes: PD configuration documentation

Layer / File(s) Summary
Document label-property support and alternatives
pd-configuration-file.md, pd-microservices.md
The pages state that scheduling does not support label-property and identify Placement Rules or evict-leader-scheduler as alternatives. The microservices page also describes the effect of reject-leader label properties and when label-property takes effect through enable-scheduling-fallback.

Priority: Low

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: Minimal · up to cf4d1

The documentation accurately describes the currently evidenced scheduling behavior and available alternatives; no merge-blocking risk remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title names the main change: the scheduling microservice does not support label-property. It is specific, concise, and matches the raw summary and PR objectives.
Description check Passed The description states what changed, which versions are affected, and links related PRs and issues. It also fills the AI agent involvement section. The 'What is changed' section is complete. The templ…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Description check

Explanation

The description states what changed, which versions are affected, and links related PRs and issues. It also fills the AI agent involvement section. The 'What is changed' section is complete. The template's 'Required' sections are filled. The first-time contributor checklist is omitted, which is acceptable because it applies only to first-time contributors.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


Review info
Run configuration
  • Source mode: Auto
  • Repository: pingcap/docs
  • Branch: master
  • File: .coderabbit.yaml
  • Commit: e5e80ae
  • Layers: Repository YAML
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 95f456ba-cfc9-436f-be51-0f85f43d7270
Commits

Reviewing files that changed from the base of the PR and between e5e80ae and a8978f7.

Files selected for processing: 2
  • pd-configuration-file.md
  • pd-microservices.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.

Comment thread pd-microservices.md Resolved
Signed-off-by: lhy1024 <19542290+lhy1024@users.noreply.github.com>
Signed-off-by: lhy1024 <19542290+lhy1024@users.noreply.github.com>
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. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant