titan-configuration: remove the unrecommended steps of updating TiKV configuration (#21217) #21221
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
do-not-merge/hold
|
@qiancai This PR has conflicts, I have hold it. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, I'm Gemini Code Assist1! 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 documentation for TiKV's Titan storage engine configuration. The primary goal is to provide more accurate and safer instructions for disabling Titan, specifically by removing unrecommended steps and highlighting potential issues with direct configuration changes in older TiDB versions. It also clarifies the default behavior of the titan.enabled setting across different TiDB versions.
Highlights
- Safer Titan Disabling Guidance: The documentation for disabling TiKV's Titan feature in
storage-engine/titan-configuration.mdhas been updated. It now advises against directly settingrocksdb.titan.enabledtofalsefor TiDB versions earlier than v8.5.0, as this can lead to TiKV crashes. It also clarifies that Step 2 (data compaction) can be optionally skipped, though with potential performance implications. - Removal of Unrecommended Disabling Step: The explicit Step 4, which previously instructed users to update TiKV configuration by setting
rocksdb.titan.enabled = falseto disable Titan, has been removed from thestorage-engine/titan-configuration.mddocument. This aligns with the new warning and recommended approach. - Updated
titan.enabledDefault and Warnings: Thetikv-configuration-file.mdhas been updated to reflect that the default value forrocksdb.titan.enabledis nowtruefor TiDB v7.6.0 and later versions. A warning has been added here as well, reiterating that setting this configuration item tofalseis not recommended for TiDB versions prior to v8.5.0. A note also clarifies the implications of this default change for upgraded clusters.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request removes the unrecommended steps of updating TiKV configuration in the Titan configuration documentation. The changes include updating the documentation to reflect the recommended steps for disabling Titan and adding warnings and notes regarding the impact of disabling Titan on different TiDB versions. The changes also include updating the documentation to reflect the default value change for Titan in TiDB v7.6.0 and later versions.
The review focuses on clarity, simplicity, and technical accuracy, as per the documentation style guide (lines 14, 16).
The style guide was used in the following ways:
- Clarity and Simplicity (lines 14, 21): The review aims to improve the clarity and simplicity of the documentation by suggesting rephrasing using active voice and addressing the user directly.
- Structure and Format (line 33): The review suggests using bullet points for consistency.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #21217
First-time contributors' checklist
What is changed, added or deleted? (Required)
This PR updates release-8.1 docs according to pingcap/docs-cn#20304.
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 (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?