Repository navigation
docs: fix outdated Region size in multi-AZ deployment doc - #24204
doc-claw-bot wants to merge 1 commit into
Conversation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughThe deployment documentation changes the documented default TiKV Region size from 96 MB to 256 MiB. ChangesRegion Size Documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Merge Risk: 🔵 Low · up to The deployment guide may lead readers to treat 256 MiB as a fixed size for every Region. This is a bounded documentation issue and does not change runtime behavior. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
f7ae5166-44a7-45d7-879e-e9c7baa451ed
📒 Files selected for processing (1)
multi-data-centers-in-one-city-deployment.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
| #### TiKV labels | ||
|
|
||
| TiKV is a Multi-Raft system where data is divided into Regions and the size of each Region is 96 MB by default. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas. | ||
| TiKV is a Multi-Raft system where data is divided into Regions and the size of each Region is 256 MiB by default. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
git diff --unified=5 6ba85765e2f9e8d080a7f1789a3b46641a09d960 75a0a4aa8a4b955f6868ef1dadb80159d527cfd8 -- multi-data-centers-in-one-city-deployment.md
sed -n '1235,1252p' tikv-configuration-file.md
find .. -name AGENTS.md -o -name CONTRIBUTING.mdRepository: pingcap/docs
Length of output: 3253
Describe 256 MiB as an estimate for newly split Regions.
The configuration reference describes region-split-size as an estimate for newly split Regions, not a fixed size for every Region. Update this sentence:
Suggested fix
-TiKV is a Multi-Raft system where data is divided into Regions and the size of each Region is 256 MiB by default. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas.
+TiKV is a Multi-Raft system where data is divided into Regions. The default estimated size for newly split Regions is 256 MiB. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| TiKV is a Multi-Raft system where data is divided into Regions and the size of each Region is 256 MiB by default. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas. | |
| TiKV is a Multi-Raft system where data is divided into Regions. The default estimated size for newly split Regions is 256 MiB. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas. |
What is changed, added or deleted? (Required)
multi-data-centers-in-one-city-deployment.mdto use the current default Region size (256 MiB) instead of the outdated96 MB.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.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?