v8.5.5: add config for graceful shutdown

[hujiatao0]

First-time contributors' checklist

• I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

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)
• v6.1 (TiDB 6.1 versions)
• v5.4 (TiDB 5.4 versions)

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

• This PR is translated from:
• Other reference 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

[ti-chi-bot]

[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 jackysp 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.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @hujiatao0, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the TiKV configuration documentation by adding a new entry for graceful-shutdown-timeout. This addition provides users with clear guidance on how to configure the timeout duration for graceful node shutdowns, ensuring controlled behavior during system maintenance or restarts, particularly concerning leader transfer operations.

Highlights

• New Configuration Parameter: Introduced documentation for the graceful-shutdown-timeout parameter in the TiKV configuration file. This parameter allows users to define the maximum duration for a graceful shutdown, specifying behavior if leader transfer does not complete within the timeout, and providing an option to disable the feature.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds documentation for the graceful-shutdown-timeout configuration parameter in TiKV. My review focuses on improving the clarity and adhering to the documentation style guide. I've suggested a rephrasing of the parameter description to make it a complete sentence, use active voice, and correctly format the value 0s.

[gemini-code-assist]

To improve clarity and adhere to the style guide, I suggest rephrasing this description. The current version starts with a sentence fragment and uses passive voice. The suggested change makes it a complete sentence, uses active voice, and formats the 0s value as code for consistency.

Suggested change

	+ The timeout duration for graceful shutdown. If the timeout is reached and the leader transfer has not completed, the transfer will be skipped and the node will proceed directly to the shutdown process. A value of 0s disables graceful shutdown.
	+ Specifies the timeout for graceful shutdown. If the timeout is reached before the leader transfer completes, TiKV skips the transfer and proceeds directly to the shutdown process. To disable graceful shutdown, set the value to `0s`.

References

1. The style guide recommends correcting grammar and avoiding passive voice. The original description starts with a sentence fragment and uses passive voice ('will be skipped'). ^(link)
2. The style guide requires code snippets, command names, options, and paths to be in backticks. The value '0s' should be formatted as 0s. ^(link)