Skip to content

docs: fix outdated Region size in multi-AZ deployment doc - #24204

Open
doc-claw-bot wants to merge 1 commit into
pingcap:masterfrom
doc-claw-bot:docs/fix-region-default-multi-az
Open

doc-claw-bot wants to merge 1 commit into
pingcap:masterfrom
doc-claw-bot:docs/fix-region-default-multi-az

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

  • Update multi-data-centers-in-one-city-deployment.md to use the current default Region size (256 MiB) instead of the outdated 96 MB.
  • Keep the change scoped to the stale statement so the deployment guidance stays aligned with the current TiKV default used elsewhere in the docs.

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)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

ti-chi-bot Bot commented Oct 7, 2026

Copy link
Copy Markdown

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

Details Needs approval from an approver in each of these files:

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

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. labels Oct 7, 2026
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 7, 2026
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

📝 Walkthrough

Walkthrough

The deployment documentation changes the documented default TiKV Region size from 96 MB to 256 MiB.

Changes

Region Size Documentation

Layer / File(s) Summary
Update documented Region size
multi-data-centers-in-one-city-deployment.md
The documented default TiKV Region size changes from 96 MB to 256 MiB.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: 🔵 Low · up to 75a0a

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 Summary

Architecture risk: 🔵 Low · up to 75a0a

The change affects 1 system.

Changed systems: multi-data-centers-in-one-city-deployment.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — multi-data-centers-in-one-city-deployment.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in multi-data-centers-in-one-city-deployment.md: The documented default Region size changes from 96 MB to 256 MiB.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the documentation update and the outdated Region size it corrects.
Description check ✅ Passed The description explains the change and its reason, identifies the affected versions, provides a related reference, and completes the applicable template sections.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. area/deploy-upgrade-maintain Indicates that the Issue or PR belongs to the area of deployment, upgrade, and maintenance. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed missing-translation-status This PR does not have translation status info. labels Oct 7, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
📥 Commits

Reviewing files that changed from the base of the PR and between 6ba8576 and 75a0a4a.

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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.md

Repository: 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.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/deploy-upgrade-maintain Indicates that the Issue or PR belongs to the area of deployment, upgrade, and maintenance. contribution This PR is from a community contributor. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant