titan-configuration: remove the unrecommended steps of updating TiKV configuration (#21217) #21222
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 the TiKV Titan storage engine, primarily focusing on the recommended procedure for disabling Titan. The changes aim to provide safer and more accurate instructions by removing potentially problematic steps for older TiDB versions and clarifying the default behavior and implications of the rocksdb.titan.enabled configuration in newer releases. This is a documentation update specifically for the release-8.1 branch.
Highlights
- Titan Disabling Guidance Update: Updated the documentation for disabling Titan, specifically discouraging direct modification of the
rocksdb.titan.enabledconfiguration item tofalsefor TiDB versions earlier than v8.5.0 due to potential TiKV crashes. The previous Step 4, which instructed users to set this value, has been removed. - TiKV Configuration Clarification: Added a warning and a note to the
rocksdb.titan.enabledconfiguration item's documentation. The warning reiterates the caution against setting it tofalsefor older TiDB versions. The note clarifies that the default value changed fromfalsetotruein TiDB v7.6.0+ to enhance performance for wide table and JSON data, and explains upgrade behavior for existing clusters. - Documentation Alignment: Ensured consistency between the
titan-configuration.mdandtikv-configuration-file.mdregarding the recommended approach for disabling Titan and the behavior of therocksdb.titan.enabledparameter.
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 effectively removes unrecommended steps for disabling Titan and updates the documentation to reflect changes in default configuration values and important warnings for older versions. The changes significantly improve the clarity and safety of the documentation. My review focused on enhancing readability, conciseness, and adherence to the provided style guide, particularly regarding sentence structure and consistent terminology.
Style Guide Elements Referenced:
- Clarity, simplicity, completeness, and readability (SG 14-15): Suggestions were made to break down long sentences for better comprehension.
- Avoid unnecessary words and repetition (SG 24): Feedback aimed at replacing wordy phrases with more direct language.
- Consistent terminology (SG 25): A recommendation was given to use a more common phrasing for consistency.
- Structure and format - Code snippets, command names, options, and paths should be in backticks (SG 35): A suggestion was made to ensure proper formatting of configuration items within sentences.
tikv-configuration-file.md
Outdated
| > **Note:** | ||
| > | ||
| > - To enhance the performance of wide table and JSON data writing and point query, starting from TiDB v7.6.0, the default value changes from `false` to `true`, which means that Titan is enabled by default. |
There was a problem hiding this comment.
This sentence is quite long and could be split for improved readability1. The information about the default value change and its implication ("which means that Titan is enabled by default") could be presented more concisely.
Style Guide References
| > **Note:** | |
| > | |
| > - To enhance the performance of wide table and JSON data writing and point query, starting from TiDB v7.6.0, the default value changes from `false` to `true`, which means that Titan is enabled by default. | |
| - Starting from TiDB v7.6.0, the default value changes from `false` to `true`, enabling Titan by default. This enhances the performance of wide table and JSON data writing and point queries. |
Footnotes
tikv-configuration-file.md
Outdated
| > - Existing clusters upgraded to v7.6.0 or later versions retain the original configuration, which means that if Titan is not explicitly enabled, it still uses RocksDB. | ||
| > - If the cluster has enabled Titan before upgrading to TiDB v7.6.0 or later versions, Titan will be retained after the upgrade, and the [`min-blob-size`](/tikv-configuration-file.md#min-blob-size) configuration before the upgrade will be retained. If you do not explicitly configure the value before the upgrade, the default value of the previous version `1KiB` will be retained to ensure the stability of the cluster configuration after the upgrade. | ||
|
|
There was a problem hiding this comment.
This sentence is very long and contains multiple clauses. Consider breaking it into two or more sentences to improve readability and comprehension1. Also, ensure consistent use of backticks for configuration items like min-blob-size when it's part of a sentence, not just a link2.
Style Guide References
| > - Existing clusters upgraded to v7.6.0 or later versions retain the original configuration, which means that if Titan is not explicitly enabled, it still uses RocksDB. | |
| > - If the cluster has enabled Titan before upgrading to TiDB v7.6.0 or later versions, Titan will be retained after the upgrade, and the [`min-blob-size`](/tikv-configuration-file.md#min-blob-size) configuration before the upgrade will be retained. If you do not explicitly configure the value before the upgrade, the default value of the previous version `1KiB` will be retained to ensure the stability of the cluster configuration after the upgrade. | |
| - If the cluster had Titan enabled before upgrading to TiDB v7.6.0 or later, Titan will be retained after the upgrade, along with the `min-blob-size` configuration. If `min-blob-size` was not explicitly configured before the upgrade, the previous version's default value of `1KiB` will be retained to ensure cluster configuration stability. |
Footnotes
tikv-configuration-file.md
Outdated
| > - To enhance the performance of wide table and JSON data writing and point query, starting from TiDB v7.6.0, the default value changes from `false` to `true`, which means that Titan is enabled by default. | ||
| > - Existing clusters upgraded to v7.6.0 or later versions retain the original configuration, which means that if Titan is not explicitly enabled, it still uses RocksDB. |
There was a problem hiding this comment.
The phrase "which means that" is a bit wordy and can be replaced with a more direct phrasing for conciseness1.
Style Guide References
| > - To enhance the performance of wide table and JSON data writing and point query, starting from TiDB v7.6.0, the default value changes from `false` to `true`, which means that Titan is enabled by default. | |
| > - Existing clusters upgraded to v7.6.0 or later versions retain the original configuration, which means that if Titan is not explicitly enabled, it still uses RocksDB. | |
| - Existing clusters upgraded to v7.6.0 or later versions retain the original configuration; if Titan is not explicitly enabled, it still uses RocksDB. |
Footnotes
|
[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?