tikv: recorrect the settings of some configs and supplement missing annotations for several configs. (#20871)

[ti-chi-bot]

This is an automated cherry-pick of #20871

First-time contributors' checklist

• I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

As the title mentioned, this PR is used to recorrect the settings for some configurations in TiKV.

Meanwhile, for some newly introduced configurations, it supplements annotations for them.

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).

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 versions)
• v8.4 (TiDB 8.4 versions)
• v8.3 (TiDB 8.3 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: tikv: recorrect the settings of some configs and supplement missing annotations for several configs. docs-cn#20261
• 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]

@qiancai This PR has conflicts, I have hold it.
Please resolve them or ask others to resolve them, then comment /unhold to remove the hold label.

[gemini-code-assist]

Hello @ti-chi-bot, 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!

Summary of Changes

This pull request focuses on updating and correcting configurations within TiKV, as well as adding missing annotations for newly introduced configurations. The changes primarily affect the releases directory, specifically the release notes for versions 7.6.0, 8.0.0, 8.1.0, and 8.1.2, and the tikv-configuration-file.md file. These updates include renaming configuration items, modifying default values, adding new configuration options, and deprecating old ones. The goal is to ensure accurate documentation and proper configuration settings for various TiDB and TiKV components.

Highlights

• Configuration Updates: Several TiKV configuration parameters have been updated, including renaming raftstore.report-min-resolved-ts-interval to raftstore.pd-report-min-resolved-ts-interval and modifying default values for parameters like rocksdb.defaultcf.titan.min-blob-size and rocksdb.titan.max-background-gc.
• New Configuration Options: New configuration options have been added for TiKV, such as cdc.incremental-scan-concurrency-limit, raftstore.periodic-full-compact-start-times, raftstore.periodic-full-compact-start-max-cpu, storage.block-cache.low-pri-pool-ratio, rocksdb.defaultcf.titan.shared-blob-cache, and memory.enable-thread-exclusive-arena.
• Documentation Updates: The release notes for versions 7.6.0, 8.0.0, 8.1.0, and 8.1.2 have been updated to reflect the configuration changes, including new, modified, and deprecated parameters.
• Compatibility Changes: The release notes for 8.1.2 document the addition of the TiKV configuration item server.snap-min-ingest-size, which specifies the minimum threshold for whether TiKV adopts the ingest method when processing snapshots.

Changelog

Click here to see the changelog

• releases/release-7.6.0.md
  • Renamed raftstore.report-min-resolved-ts-interval to raftstore.pd-report-min-resolved-ts-interval.
  • Added new configurations for cdc.incremental-scan-concurrency-limit, gc.num-threads, raftstore.periodic-full-compact-start-times, raftstore.periodic-full-compact-start-max-cpu, and raftstore.pd-report-min-resolved-ts-interval.
  • Modified default compression algorithm for blob-file-compression to zstd.
  • Modified default value for rocksdb.defaultcf.titan.min-blob-size for new clusters.
  • Modified default value for rocksdb.titan.enabled for new clusters.
• releases/release-8.0.0.md
  • Modified log-backup.initial-scan-rate-limit to add a minimum value of 1MiB.
  • Modified raftstore.store-io-pool-size to change the default value from 0 to 1.
  • Modified rocksdb.defaultcf.titan.blob-cache-size to note the introduction of shared-blob-cache.
  • Modified rocksdb.titan.max-background-gc to change the default value from 4 to 1.
  • Added gcp as an available type for security.encryption.master-key.vendor.
  • Added new configurations for storage.block-cache.low-pri-pool-ratio and rocksdb.defaultcf.titan.shared-blob-cache.
  • Added new configuration for security.encryption.master-key.gcp.credential-file-path.
  • Added new configuration for schedule.enable-heartbeat-breakdown-metrics in PD.
• releases/release-8.1.0.md
  • Deprecated enable-telemetry in PD.
  • Modified conflict.max-record-rows and conflict.threshold in TiDB Lightning.
  • Added new configuration memory.enable-thread-exclusive-arena in TiKV.
  • Added new security configurations for TiCDC: security.client-allowed-user, security.client-user-required, and security.mtls.
• releases/release-8.1.2.md
  • Added compatibility changes section.
  • Added TiKV configuration item server.snap-min-ingest-size.
• tikv-configuration-file.md
  • Added documentation for snap-min-ingest-size.
  • Added documentation for low-pri-pool-ratio.
  • Updated documentation for pd-report-min-resolved-ts-interval and noted its renaming from report-min-resolved-ts-interval.
  • Removed documentation for report-min-resolved-ts-interval.
  • Updated documentation for max-background-gc to reflect the default value change in v8.0.0.
  • Added documentation for incremental-scan-concurrency-limit.
  • Added documentation for enable-thread-exclusive-arena.
  • Added documentation for in-memory engine configurations: enable, capacity, gc-run-interval, and mvcc-amplification-threshold.

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

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 aims to improve the configuration settings and annotations for various TiKV configurations. The changes seem well-organized and address the stated goals. However, some descriptions could be more precise, and a few formatting inconsistencies need attention.

Summary of Findings

• Inaccurate Description: The description for cdc.incremental-scan-concurrency-limit could be improved for clarity.
• Inconsistent Terminology: Inconsistent use of 'service provider' vs. 'service' in the description of security.encryption.master-key.vendor.
• Markdown Style: There are a few instances where a blank line is missing after a list, which violates the style guide.
• Markdown Style: There is an instance where a blank line is missing before a heading, which violates the style guide.

Merge Readiness

The pull request is almost ready for merging. Addressing the identified issues related to description accuracy, terminology consistency, and markdown formatting will improve the overall quality and clarity of the documentation. I am unable to approve this pull request, and users should have others review and approve this code before merging.

[qiancai]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [qiancai]

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