Skip to content

docs: clarify Raft leader lease timing#23287

Open
wenxiaojie1 wants to merge 2 commits into
pingcap:masterfrom
wenxiaojie1:docs/clarify-raft-timing-constraint
Open

docs: clarify Raft leader lease timing#23287
wenxiaojie1 wants to merge 2 commits into
pingcap:masterfrom
wenxiaojie1:docs/clarify-raft-timing-constraint

Conversation

@wenxiaojie1

Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

Document the startup constraint for raft-store-max-leader-lease: its value must leave one raft-base-tick-interval before the Raft election timeout. This reflects the TiKV configuration validation and helps prevent invalid timing configurations from causing startup failures.

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

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Jul 15, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 15, 2026

Copy link
Copy Markdown

Hi @wenxiaojie1. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

@ti-chi-bot

ti-chi-bot Bot commented Jul 15, 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

@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 Jul 15, 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 tikv-configuration-file.md documentation to add a constraint for the raft-store-max-leader-lease configuration option. The review feedback suggests rewriting the added sentence in the second person ("you") to align with the repository style guide and removing unnecessary backticks around the numeric literal 1.

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 tikv-configuration-file.md Outdated
### `raft-store-max-leader-lease`

+ The longest trusted period of a Raft leader
+ To start TiKV successfully, set this value to no more than `raft-base-tick-interval` * (`raft-election-timeout-ticks` - `1`).

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.

low

According to the repository style guide, we should write in the second person ("you") when addressing users. Additionally, the number 1 in the formula does not need to be in backticks as it is a numeric literal rather than a configuration option or command.

Suggested change
+ To start TiKV successfully, set this value to no more than `raft-base-tick-interval` * (`raft-election-timeout-ticks` - `1`).
+ To start TiKV successfully, you must set this value to no more than `raft-base-tick-interval` * (`raft-election-timeout-ticks` - 1).
References
  1. Write in second person ("you") when addressing users. (link)

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. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. 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