Skip to content

cloud: update docs for BYOC single AZ support - #23591

Open
wildpcww wants to merge 17 commits into
pingcap:release-8.5from
wildpcww:singleAZ
Open

cloud: update docs for BYOC single AZ support#23591
wildpcww wants to merge 17 commits into
pingcap:release-8.5from
wildpcww:singleAZ

Conversation

@wildpcww

@wildpcww wildpcww commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

First-time contributors' checklist

What is changed, added or deleted? (Required)

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)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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)?

  • This PR is translated from:
  • Other reference 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

Summary by CodeRabbit

  • Documentation
    • Documented Zonal and Regional high-availability options for BYOC resource pools.
    • Clarified availability-zone requirements, including the three-zone requirement for Regional pools.
    • Explained that instances and restored instances inherit their resource pool’s high-availability mode.
    • Noted that high-availability settings and zone placement cannot be changed after pool creation.
    • Added Pool vCPU Limit capacity warnings and updated creation, management, preparation, multi-region deployment, and restore guidance.

@wildpcww
wildpcww requested a review from qiancai August 24, 2026 04:11
@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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 24, 2026
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ae071005-5fd4-4b0b-a47d-3d34a0928a91

📥 Commits

Reviewing files that changed from the base of the PR and between 2c98237 and 275fef3.

📒 Files selected for processing (7)
  • tidb-cloud/architecture-concepts.md
  • tidb-cloud/byoc/byoc-initialize-service.md
  • tidb-cloud/byoc/byoc-prepare-environment-aws.md
  • tidb-cloud/byoc/create-resource-pool-byoc.md
  • tidb-cloud/byoc/create-tidb-instance-byoc.md
  • tidb-cloud/byoc/manage-resource-pools-byoc.md
  • tidb-cloud/premium/backup-and-restore-premium.md

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

BYOC documentation now describes selectable Zonal and Regional high availability modes for resource pools, availability zone requirements, Pool vCPU Limit behavior, mode inheritance, and immutable placement settings.

Changes

BYOC high availability

Layer / File(s) Summary
High availability model and regional requirements
tidb-cloud/architecture-concepts.md, tidb-cloud/byoc/byoc-prepare-environment-aws.md, tidb-cloud/byoc/multi-region-deployment.md
The documentation defines Zonal and Regional placement behavior. Regional pools require at least three eligible availability zones.
Resource pool creation and management
tidb-cloud/byoc/create-resource-pool-byoc.md, tidb-cloud/byoc/byoc-initialize-service.md, tidb-cloud/byoc/create-tidb-instance-byoc.md, tidb-cloud/byoc/manage-resource-pools-byoc.md
Resource pool creation now includes high availability selection. The documentation covers mode inheritance, immutable settings, mode names, and Pool vCPU Limit conditions.
Restore behavior
tidb-cloud/byoc/byoc-initialize-service.md, tidb-cloud/premium/backup-and-restore-premium.md
Restore instructions document resource pool mode inheritance, qualifying Zonal or Regional pools, and Pool vCPU Limit capacity guidance.

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

Merge Risk: 🔵 Low · up to 275fe

The documentation adds single-AZ BYOC guidance, but the restore instructions still omit the requirement that Regional resource pools have at least three eligible availability zones. This could mislead operators during restore planning, so the PR is mergeable with explicit owner follow-up to clarify both notes.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the required template and selects v8.5, but the required change summary is empty. Reference links and other contributor details are also not provided. Add a concise summary explaining the BYOC high-availability, resource-pool, restore, and vCPU-limit documentation changes. Confirm the target branch or version rationale and add relevant reference links if available.
✅ Passed checks (4 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 main documentation change: support for BYOC single-AZ deployments. It is concise and related to the changeset.
Full details: Docstring Coverage

Explanation

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 files. (7 skipped: 7 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@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: 3


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 070ab6e7-407b-4394-8bbc-082a18f07ee0

📥 Commits

Reviewing files that changed from the base of the PR and between 9d45dc5 and a071f31.

📒 Files selected for processing (8)
  • tidb-cloud/architecture-concepts.md
  • tidb-cloud/byoc/byoc-initialize-service.md
  • tidb-cloud/byoc/byoc-prepare-environment-aws.md
  • tidb-cloud/byoc/create-resource-pool-byoc.md
  • tidb-cloud/byoc/create-tidb-instance-byoc.md
  • tidb-cloud/byoc/manage-resource-pools-byoc.md
  • tidb-cloud/byoc/multi-region-deployment.md
  • tidb-cloud/premium/backup-and-restore-premium.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread tidb-cloud/architecture-concepts.md Outdated
Comment thread tidb-cloud/byoc/byoc-prepare-environment-aws.md Outdated
Comment thread tidb-cloud/premium/backup-and-restore-premium.md Outdated
@qiancai qiancai changed the title Single AZ support cloud: update docs for BYOC single AZ support Aug 24, 2026
@qiancai qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Aug 24, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Aug 24, 2026
@qiancai qiancai self-assigned this Aug 24, 2026
Comment thread tidb-cloud/byoc/create-resource-pool-byoc.md Outdated
@ti-chi-bot

ti-chi-bot Bot commented Aug 24, 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 ask for approval from qiancai. 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

Comment thread tidb-cloud/byoc/multi-region-deployment.md Outdated
Comment thread tidb-cloud/architecture-concepts.md Outdated
Comment thread tidb-cloud/byoc/byoc-initialize-service.md Outdated
Once the access keys are configured, you can initiate the restore job from the TiDB Cloud console.

During restore, select an active resource pool in the target cloud provider and region.
During restore, select an active resource pool in the target cloud provider and region. The restored instance inherits the high availability mode of the selected resource pool.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
During restore, select an active resource pool in the target cloud provider and region. The restored instance inherits the high availability mode of the selected resource pool.
During restore, select an active resource pool in the target cloud provider and region. The restored {{{ .byoc }}} instance inherits the high availability mode of the selected resource pool.

Comment thread tidb-cloud/byoc/byoc-prepare-environment-aws.md Outdated
Comment thread tidb-cloud/byoc/manage-resource-pools-byoc.md Outdated
Comment thread tidb-cloud/premium/backup-and-restore-premium.md Outdated
Comment thread tidb-cloud/premium/backup-and-restore-premium.md Outdated
Comment thread tidb-cloud/byoc/byoc-prepare-environment-aws.md Outdated
Comment thread tidb-cloud/byoc/create-resource-pool-byoc.md Outdated
Comment thread tidb-cloud/byoc/create-resource-pool-byoc.md Outdated
Comment thread tidb-cloud/premium/backup-and-restore-premium.md Outdated
wildpcww and others added 12 commits August 25, 2026 14:24
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Comment thread tidb-cloud/premium/backup-and-restore-premium.md Outdated
Comment thread tidb-cloud/premium/backup-and-restore-premium.md Outdated
Co-authored-by: Cheng Weiwei <65707268+wildpcww@users.noreply.github.com>
@ti-chi-bot ti-chi-bot Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 25, 2026
@ti-chi-bot ti-chi-bot Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 25, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 25, 2026

Copy link
Copy Markdown

@wildpcww: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify f11a231 link true /test pull-verify

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. contribution This PR is from a community contributor. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants