Skip to content

config: reword primary lease descriptions for clarity - #23132

Open
yahonda wants to merge 3 commits into
pingcap:release-8.5from
yahonda:fix-lease-description
Open

config: reword primary lease descriptions for clarity#23132
yahonda wants to merge 3 commits into
pingcap:release-8.5from
yahonda:fix-lease-description

Conversation

@yahonda

@yahonda yahonda commented Jun 24, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Reword the lease\> description in scheduling-configuration-file.mdandtso-configuration-file.mdto avoid confusion with databasePRIMARY KEY` terminology.

Before:

The timeout of the Scheduling Primary Key lease. After the timeout, the system re-elects a Primary.

After:

The timeout of the scheduling service's primary lease. After the timeout, the system re-elects a primary.

Similarly for the TSO configuration file.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)
  • v5.3 (TiDB 5.3 versions)

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

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 lease descriptions for the Scheduling and TSO services.
    • Updated terminology for primary leases and re-election behavior.
    • Updated the default lease timeout from 3 to 5 seconds.

@ti-chi-bot

ti-chi-bot Bot commented Jun 24, 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 oreoxmt 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 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 Jun 24, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation for the scheduling and TSO configuration files, rephrasing the description of the lease timeout to refer to the service's primary lease. Feedback suggests capitalizing "Scheduling" in the scheduling configuration file to maintain consistency with "TSO" and other occurrences in the document.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread scheduling-configuration-file.md Outdated
@qiancai

qiancai commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

@bufferflies would you please take a look at this PR? Thanks.

@yahonda
yahonda force-pushed the fix-lease-description branch from 59e198c to 1df8ff1 Compare August 3, 2026 00:16
@coderabbitai

coderabbitai Bot commented Aug 3, 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: 1edf8485-abf4-4f74-a4a9-21e0057e2caf

📥 Commits

Reviewing files that changed from the base of the PR and between 1df8ff1 and 0449164.

📒 Files selected for processing (2)
  • scheduling-configuration-file.md
  • tso-configuration-file.md

📝 Walkthrough

Walkthrough

The changes update lease descriptions for the Scheduling and TSO services. The descriptions identify each service’s primary lease, use lowercase re-election terminology where applicable, and change the default timeout from 3 to 5 seconds.

Changes

Lease description updates

Layer / File(s) Summary
Update service lease descriptions
scheduling-configuration-file.md, tso-configuration-file.md
The lease descriptions identify the Scheduling and TSO services’ primary leases. Both default timeouts change from 3 to 5 seconds.

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 summarizes the main change: rewording primary lease descriptions for clarity.
Description check ✅ Passed The description explains the changes, affected TiDB version, related files, and applicable change categories.
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.

@ti-chi-bot

ti-chi-bot Bot commented Aug 3, 2026

Copy link
Copy Markdown

@bufferflies: 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.

Comment thread scheduling-configuration-file.md Outdated
Comment thread tso-configuration-file.md Outdated
The Scheduling and TSO microservices use PD's DefaultLeaderLease, which is 5
seconds, not 3. Verified against tikv/pd release-8.5:
pkg/mcs/utils/constant/constant.go (DefaultLeaderLease = int64(5)).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.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. 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.

3 participants