Skip to content

cloud: update docs for BYOC single AZ support #23591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wildpcww wants to merge 2 commits into
base: release-8.5
Choose a base branch
from
Open

cloud: update docs for BYOC single AZ support #23591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a071f31
Single AZ support
wildpcww Aug 24, 2026
2c98237
update create instance with limit content
wildpcww Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tidb-cloud/architecture-concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ BYOC provides the following features:

To meet different workload requirements, TiDB Cloud BYOC supports both Single-AZ and Multi-AZ deployments, enabling you to choose between lower-latency zonal deployment and higher-resilience deployment across multiple availability zones.

High availability is configured for each resource pool. A Zonal resource pool is deployed in a single availability zone, while a Regional resource pool is deployed across multiple availability zones. TiDB Cloud determines the availability zone placement based on the BYOC region configuration and available cloud resources. Instances created or restored in a resource pool inherit its high availability mode. After a resource pool is created, you cannot change its high availability mode or availability zone placement.
Comment thread
qiancai marked this conversation as resolved.

@qiancai qiancai Aug 24, 2026

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
High availability is configured for each resource pool. A Zonal resource pool is deployed in a single availability zone, while a Regional resource pool is deployed across multiple availability zones. TiDB Cloud determines the availability zone placement based on the BYOC region configuration and available cloud resources. Instances created or restored in a resource pool inherit its high availability mode. After a resource pool is created, you cannot change its high availability mode or availability zone placement.
You can configure high availability mode for each resource pool as **Zonal** or **Regional** when you [create the pool](/tidb-cloud/byoc/create-resource-pool-byoc.md). A zonal resource pool is deployed in a single availability zone, while a regional resource pool is deployed across multiple availability zones. TiDB Cloud determines the availability zone placement based on the BYOC region configuration and available cloud resources. TiDB Cloud BYOC instances created or restored in a resource pool inherit the high availability mode of the pool. After a resource pool is created, you cannot change its high availability mode or availability zone placement.


![TiDB Cloud BYOC Architecture](/media/tidb-cloud/byoc-architecture.png)

A TiDB Cloud BYOC deployment includes the following major components:
Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/byoc/byoc-initialize-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

You can now provision resource pools and TiDB instances directly via the TiDB Cloud console.

1. Create a resource pool. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and follow the instructions in [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md) to create a resource pool in the target cloud provider and region.
1. Create a resource pool. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and follow the instructions in [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md) to create a resource pool in the target cloud provider and region. When creating the resource pool, select Zonal or Regional high availability based on your workload requirements. Instances created or restored in the resource pool inherit its high availability mode.

@qiancai qiancai Aug 24, 2026

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
1. Create a resource pool. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and follow the instructions in [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md) to create a resource pool in the target cloud provider and region. When creating the resource pool, select Zonal or Regional high availability based on your workload requirements. Instances created or restored in the resource pool inherit its high availability mode.
1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then follow the instructions in [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md) to create a resource pool in the target cloud provider and region.
>**Note:**
>
> When creating the resource pool, select **Zonal** or **Regional** high availability based on your workload requirements. {{{ .byoc }}} instances created or restored in the resource pool inherit the high availability mode of the pool.


2. After the resource pool becomes **Active**, follow the instructions in [Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md) to create a new instance in the resource pool.

Expand All @@ -34,7 +34,7 @@

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. Make sure that the resource pool has sufficient vCPU capacity, because restoring an instance might cause the total provisioned vCPU to exceed the Pool vCPU Limit and degrade the performance of all instances in the resource pool. If the resource pool has reached its Pool vCPU Limit, increase or turn off the limit, or select another resource pool before continuing.

Check warning on line 37 in tidb-cloud/byoc/byoc-initialize-service.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.Ambiguous] Consider using a clearer word than 'sufficient' because it may cause confusion.

Raw Output:
{"message":"[PingCAP.Ambiguous] Consider using a clearer word than 'sufficient' because it may cause confusion.","location":{"path":"tidb-cloud/byoc/byoc-initialize-service.md","range":{"start":{"line":37,"column":219},"end":{"line":37,"column":229}}},"severity":"INFO","code":{"value":"PingCAP.Ambiguous"}}

@qiancai qiancai Aug 24, 2026 •
edited
Loading

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. Make sure that the resource pool has sufficient vCPU capacity, because restoring an instance might cause the total provisioned vCPU to exceed the Pool vCPU Limit and degrade the performance of all instances in the resource pool. If the resource pool has reached its Pool vCPU Limit, increase or turn off the limit, or select another resource pool before continuing.
During restore, select an active resource pool with sufficient vCPU capacity in the target cloud provider and region. The restored instance inherits the high availability mode of the selected resource pool.
If the selected resource pool has reached its Pool vCPU Limit, increase or turn off the limit, or select another resource pool before continuing. This is because restoring to a new {{{ .byoc }}} instance might cause the total provisioned vCPUs to exceed the Pool vCPU Limit and affect the performance of all {{{ .byoc }}} instances in the same pool.

@qiancai qiancai Aug 24, 2026

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.

reason: To make the content user friendly, tells user what to do first, and then why to do that.


For step-by-step restoration procedures, see [Restore backups from cloud storage](/tidb-cloud/premium/backup-and-restore-premium.md#restore-backups-from-cloud-storage).

Expand Down
6 changes: 3 additions & 3 deletions tidb-cloud/byoc/byoc-prepare-environment-aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ TiDB is a distributed database that requires specific infrastructure for high av

- **Option B: POC / Cost Optimization (Single-AZ).** Select exactly **1 AZ**. For example, `us-west-2a`.

> **Note:**
>
> Multi-AZ deployment functionality is disabled for this configuration.
The availability zones prepared for the BYOC region determine where TiDB Cloud can place resource pools. When creating a resource pool, you select either Zonal or Regional high availability. A Zonal resource pool is placed in one availability zone. A Regional resource pool requires at least three eligible availability zones in the region.

@qiancai qiancai Aug 24, 2026

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
The availability zones prepared for the BYOC region determine where TiDB Cloud can place resource pools. When creating a resource pool, you select either Zonal or Regional high availability. A Zonal resource pool is placed in one availability zone. A Regional resource pool requires at least three eligible availability zones in the region.
The availability zones prepared for the BYOC region determine where TiDB Cloud places resource pools. When creating a resource pool, you select either **Zonal** or **Regional** high availability. A zonal resource pool is placed in one availability zone. A regional resource pool requires at least three eligible availability zones in the region.


If the BYOC region is initially prepared with a single availability zone, TiDB Cloud uses that availability zone for Zonal resource pools. You can create a Regional resource pool only when two additional eligible availability zones are available. If you plan to use Regional resource pools, confirm during environment preparation that the region can provide at least three eligible availability zones.

@coderabbitai coderabbitai Bot Aug 24, 2026

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -eu

printf '%s\n' '--- target document context ---'
sed -n '1,100p' tidb-cloud/byoc/byoc-prepare-environment-aws.md

printf '%s\n' '--- related Regional resource-pool and availability-zone guidance ---'
rg -n -i -C 3 'Regional resource pool|Zonal resource pool|availability zone|availability zones|eligible' \
  tidb-cloud resources 2>/dev/null || true

printf '%s\n' '--- repository references to changing BYOC preparation or availability zones ---'
rg -n -i -C 3 'BYOC.*(update|redeploy|re-?prepare)|availability zone.*(add|change|update)|resource pool.*(enable|available)' \
  . --glob '*.md' --glob '*.mdx' 2>/dev/null || true

Repository: pingcap/docs

Length of output: 50371

🏁 Script executed:

#!/bin/bash
set -eu

printf '%s\n' '--- BYOC documentation references ---'
rg -n -i -C 4 'availability zone|availability zones|AZs|region configuration|BYOC region|resource pool' \
  tidb-cloud/byoc --glob '*.md' --glob '*.mdx' | head -n 500

printf '%s\n' '--- procedures for updating, recreating, or adding BYOC regions ---'
rg -n -i -C 5 'update.*(region|availability)|modify.*(region|availability)|add.*(availability|AZ)|re-?deploy|redeploy|delete.*region|create.*region|BYOC region' \
  tidb-cloud/byoc --glob '*.md' --glob '*.mdx' | head -n 500

printf '%s\n' '--- links and headings in BYOC management documents ---'
for f in $(git ls-files 'tidb-cloud/byoc/*.md'); do
  case "$f" in
    *manage*|*resource*|*deploy*|*region*) printf '\n### %s\n' "$f"; rg -n '^(#|.*\]\(/tidb-cloud/byoc/)' "$f" | head -n 120 ;;
  esac
done

Repository: pingcap/docs

Length of output: 50368

🏁 Script executed:

#!/bin/bash
set -eu

printf '%s\n' '--- multi-region update procedure ---'
sed -n '1,190p' tidb-cloud/byoc/multi-region-deployment.md

printf '%s\n' '--- BYOC setup/update script references and availability-zone parameters ---'
rg -n -i -C 5 'tidbcloud-byoc-(setup|update)\.sh|availability|AZ|region' \
  tidb-cloud/byoc/multi-region-deployment.md \
  tidb-cloud/byoc/byoc-automated-deployment.md \
  tidb-cloud/byoc/byoc-configure-iam-permissions.md 2>/dev/null

printf '%s\n' '--- exact region and AZ lifecycle statements in BYOC docs ---'
rg -n -i -C 4 'cannot.*(change|modify|update)|must.*(prepare|select|provide).*3|single.*AZ|additional.*(AZ|availability)|existing.*region' \
  tidb-cloud/byoc --glob '*.md' --glob '*.mdx' | head -n 400

Repository: pingcap/docs

Length of output: 50370

🌐 Web query:

site:github.com/tidbcloud/byoc-account-setup "tidbcloud-byoc-update.sh" availability zones

💡 Result:

The script is located at:

iam_roles/tidbcloud-byoc-update.sh

It does not explicitly handle availability zones. It retrieves existing CloudFormation parameters and redeploys the selected stack while preserving those parameter values. [1]

Supported stacks: deploy, dataplane, o11y, or all. [1]

[1] (raw.githubusercontent.com)

Citations:

Clarify how users can enable Regional resource pools after single-AZ preparation.

The documented tidbcloud-byoc-update.sh flow adds regions, reuses existing CloudFormation parameters, and does not provide a path to change availability zones in an existing region. State whether users must prepare three availability zones before deployment or provide the supported migration procedure.

@qiancai qiancai Aug 24, 2026

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
If the BYOC region is initially prepared with a single availability zone, TiDB Cloud uses that availability zone for Zonal resource pools. You can create a Regional resource pool only when two additional eligible availability zones are available. If you plan to use Regional resource pools, confirm during environment preparation that the region can provide at least three eligible availability zones.
If a BYOC region is initially prepared with a single availability zone, TiDB Cloud uses that availability zone for zonal resource pools. You can create a regional resource pool only when two additional eligible availability zones are available. If you plan to use regional resource pools, confirm during environment preparation that the region provides at least three eligible availability zones.


## Step 4. Create a hosted zone for TiDB

Expand Down
17 changes: 12 additions & 5 deletions tidb-cloud/byoc/create-resource-pool-byoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,18 @@ To create a resource pool, take the following steps:

If you set a Pool vCPU Limit, make sure that the total vCPUs of the initial TiKV and TiFlash resources do not exceed 50% of the Pool vCPU Limit. This helps reserve capacity for future instance creation and automatic scale-out.

6. In the **Pool CIDR** area, review or enter the CIDR range for the resource pool.
6. In the **High Availability** area, select a high availability mode for the resource pool.

- **Zonal**: deploys the resource pool in a single availability zone for lower network latency.
- **Regional**: deploys the resource pool across multiple availability zones for higher availability and resilience against an availability-zone-level outage.

@qiancai qiancai Aug 24, 2026 •
edited
Loading

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
- **Regional**: deploys the resource pool across multiple availability zones for higher availability and resilience against an availability-zone-level outage.
- **Regional**: deploys the resource pool across multiple availability zones for higher availability and resilience to outages at the availability zone level.


You must select a high availability mode before creating the resource pool. You cannot select the specific availability zones. TiDB Cloud determines the availability zones based on the BYOC region configuration and available cloud resources.

@qiancai qiancai Aug 24, 2026 •
edited
Loading

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
You must select a high availability mode before creating the resource pool. You cannot select the specific availability zones. TiDB Cloud determines the availability zones based on the BYOC region configuration and available cloud resources.
>**Note:**
>
> - If you select the **Regional** mode, make sure that the region for this pool contains at least three eligible availability zones. If this requirement is not met, the process of creating the regional resource pool might get stuck.
> - TiDB Cloud determines the availability zones based on the [BYOC region configuration](/tidb-cloud/byoc/byoc-prepare-environment-aws.md#step-3-select-region-and-availability-zones-azs) and available cloud resources.

@qiancai qiancai Aug 24, 2026 •
edited
Loading

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.

reason: "You must select a high availability mode before creating the resource pool." can be deleted because each step here is mandatory by default.


To create a Regional resource pool, at least three eligible availability zones must be available in the region. If this requirement is not met, you cannot create the Regional resource pool.

Comment on lines +58 to +59

@qiancai qiancai Aug 24, 2026

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
To create a Regional resource pool, at least three eligible availability zones must be available in the region. If this requirement is not met, you cannot create the Regional resource pool.

After the resource pool is created, you cannot change its high availability mode or availability zone placement.

7. In the **Pool CIDR** area, review or enter the CIDR range for the resource pool.

The resource pool CIDR is used as the network address range for resources in the resource pool and cannot be modified after the resource pool is created.

Expand All @@ -61,10 +72,6 @@ To create a resource pool, take the following steps:

TiDB Cloud validates CIDR overlap with known TiDB Cloud managed network ranges in the target region. TiDB Cloud cannot detect overlap with your application VPCs, on-premises networks, or VPN networks. You must verify these customer-managed network ranges before creating the resource pool.

7. In the **High Availability** area, review the high availability mode.

The high availability mode is inherited from the BYOC deployment configuration of the selected region. You cannot change it when creating a Resource Pool.

8. (Optional) In the **AWS Resource Tags** area, add tags.

Tags are applied to all taggable AWS resources within the resource pool.
Expand Down
8 changes: 7 additions & 1 deletion tidb-cloud/byoc/create-tidb-instance-byoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,15 @@ If you have the required permissions, you can create a {{{ .byoc }}} instance as

Only resource pools that match the selected cloud provider and region and are in the **Active** status are displayed. If no suitable resource pool is available and you are an `Organization Owner`, click **Create Resource Pool** to create one. After the resource pool becomes active, it is automatically selected for the new instance.

If the selected resource pool has a Pool vCPU Limit and its current provisioned vCPU is greater than or equal to the limit, TiDB Cloud displays a warning and you cannot create the instance in that resource pool. To continue, go to the Resource Pool details page to increase or turn off the Pool vCPU Limit, or select another resource pool.

> **Important:**
>
> Even if the current provisioned vCPU is below the Pool vCPU Limit, creating a new instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before creating the instance, make sure that the resource pool has sufficient vCPU capacity. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.
Comment on lines +52 to +56

@qiancai qiancai Aug 24, 2026 •
edited
Loading

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
If the selected resource pool has a Pool vCPU Limit and its current provisioned vCPU is greater than or equal to the limit, TiDB Cloud displays a warning and you cannot create the instance in that resource pool. To continue, go to the Resource Pool details page to increase or turn off the Pool vCPU Limit, or select another resource pool.
> **Important:**
>
> Even if the current provisioned vCPU is below the Pool vCPU Limit, creating a new instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before creating the instance, make sure that the resource pool has sufficient vCPU capacity. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.
Make sure to select a resource pool with sufficient vCPU capacity. Otherwise, the following issues can occur.
- If the selected resource pool has a Pool vCPU Limit and its current provisioned vCPU is greater than or equal to the limit, TiDB Cloud displays a warning, and you cannot create the {{{ .byoc }}} instance in that resource pool. To continue, go to the **Resource Pool** details page of the pool to increase or turn off the Pool vCPU Limit, or select another resource pool.
- Even if the current provisioned vCPUs are below the Pool vCPU Limit, creating a new instance might cause the total provisioned vCPUs to exceed the limit. This might restrict resource scaling and affect the performance of all instances in the resource pool. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.


7. In the **Capacity** area, set the maximum number of Request Capacity Units (RCUs) for your instance. RCUs represent the compute resources provisioned for your workload. TiDB Cloud automatically scales your instance within this range based on demand.

8. For {{{ .byoc }}} instances, the high availability mode is inherited from the selected resource pool. If the resource pool uses regional high availability, the instance uses regional high availability. If the resource pool uses zonal high availability, the instance uses zonal high availability. You cannot configure the high availability mode when you create a BYOC instance. For more information, see [High Availability](/tidb-cloud/serverless-high-availability.md).
8. For {{{ .byoc }}} instances, the high availability mode is inherited from the selected resource pool. If the resource pool uses Regional high availability, the instance uses Regional high availability. If the resource pool uses Zonal high availability, the instance uses Zonal high availability. You cannot configure the high availability mode when you create a BYOC instance. For more information, see [TiDB Cloud BYOC architecture](/tidb-cloud/architecture-concepts.md#tidb-cloud-byoc).

@qiancai qiancai Aug 24, 2026

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
8. For {{{ .byoc }}} instances, the high availability mode is inherited from the selected resource pool. If the resource pool uses Regional high availability, the instance uses Regional high availability. If the resource pool uses Zonal high availability, the instance uses Zonal high availability. You cannot configure the high availability mode when you create a BYOC instance. For more information, see [TiDB Cloud BYOC architecture](/tidb-cloud/architecture-concepts.md#tidb-cloud-byoc).
8. For {{{ .byoc }}} instances, the high availability mode is inherited from the selected resource pool. If the resource pool uses regional high availability, the instance uses regional high availability. If the resource pool uses zonal high availability, the instance uses zonal high availability. You cannot configure the high availability mode when you create a BYOC instance. For more information, see [TiDB Cloud BYOC architecture](/tidb-cloud/architecture-concepts.md#tidb-cloud-byoc).


9. Click **Create**.

Expand Down
7 changes: 7 additions & 0 deletions tidb-cloud/byoc/manage-resource-pools-byoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ To view resource pool details, click the name of a resource pool on the **Resour

The resource pool details page includes the following information:

- **High Availability**: shows whether the resource pool uses Zonal or Regional high availability. This value is read-only. You cannot change the high availability mode or availability zone placement after the resource pool is created.

@qiancai qiancai Aug 24, 2026

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
- **High Availability**: shows whether the resource pool uses Zonal or Regional high availability. This value is read-only. You cannot change the high availability mode or availability zone placement after the resource pool is created.
- **High Availability**: shows whether the resource pool uses zonal or regional high availability. This value is read-only. You cannot change the high availability mode or availability zone placement after the resource pool is created.

- **Pool vCPU Usage**: shows the current provisioned TiDB vCPU and additional vCPU provision.
- **Instances in This Pool**: lists the BYOC instances that run in this resource pool.
- **Metrics**: shows vCPU usage and physical storage usage trends.
Expand Down Expand Up @@ -79,6 +80,12 @@ To update the Pool vCPU Limit, take the following steps:

When you set a new Pool vCPU Limit, the value must be greater than or equal to `100` vCPU and the current provisioned TiDB vCPU. Otherwise, the update is rejected.

> **Important:**

@qiancai qiancai Aug 24, 2026

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
> **Important:**
> **Note:**

>
> Even when the current provisioned vCPU is below the Pool vCPU Limit, creating or restoring an instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before creating or restoring an instance, make sure that the resource pool has sufficient vCPU capacity.

@qiancai qiancai Aug 24, 2026

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
> Even when the current provisioned vCPU is below the Pool vCPU Limit, creating or restoring an instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before creating or restoring an instance, make sure that the resource pool has sufficient vCPU capacity.
> Even when the current provisioned vCPU is below the Pool vCPU Limit, creating or restoring an instance might cause the total provisioned vCPU to exceed the limit. This might restrict resource scaling and degrade the performance of all instances in the resource pool. Before creating or restoring an instance, make sure that the resource pool has sufficient vCPU capacity.


If the current provisioned vCPU of a resource pool is greater than or equal to its Pool vCPU Limit, you cannot create or restore an instance in that resource pool. To create or restore an instance, increase or turn off the Pool vCPU Limit, or select another resource pool.

If the resource pool is in the **Modifying** status, **Update vCPU Limit** is disabled.

## Update capacity
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/byoc/multi-region-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Use `tidbcloud-byoc-update.sh` to update the existing CloudFormation stacks. The
Before running the update script:

1. Confirm the AWS Regions to be added.
2. Select the Availability Zones for the new regions.
2. Select the Availability Zones for the new regions. A Regional resource pool requires at least three eligible availability zones. If you plan to create Regional resource pools in a new region, confirm that the region can provide at least three eligible availability zones.

@qiancai qiancai Aug 24, 2026 •
edited
Loading

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
2. Select the Availability Zones for the new regions. A Regional resource pool requires at least three eligible availability zones. If you plan to create Regional resource pools in a new region, confirm that the region can provide at least three eligible availability zones.
2. Select the Availability Zones for the new regions. A regional resource pool requires at least three eligible availability zones. If you plan to create regional resource pools in a new region, select at least three eligible availability zones for that region.

3. Plan the O11Y CIDR for each new region and the resource pool CIDRs for the resource pools you plan to create. Different regions can use the same O11Y CIDR. However, if you use metric integration to connect Grafana to multiple regions, use non-overlapping O11Y CIDRs for those regions.
4. Confirm whether each new region will:
* share the existing PCA and TiDB hosted zone, or
Expand Down
16 changes: 14 additions & 2 deletions tidb-cloud/premium/backup-and-restore-premium.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,13 @@ To restore your data to a new {{{ .premium }}}<CustomContent plan="byoc"> or {{{

<CustomContent plan="byoc">

For {{{ .byoc }}}, select an active resource pool in the same cloud provider and region as the backup. If no suitable resource pool is available, an `Organization Owner` can create one before restoring the instance. Other roles cannot create resource pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md).
For {{{ .byoc }}}, select an active resource pool in the same cloud provider and region as the backup. The restored instance inherits the high availability mode of the selected resource pool. You can restore the same backup to a Zonal or Regional resource pool if the resource pool meets the restore requirements. If no suitable resource pool is available, an `Organization Owner` can create one before restoring the instance. Other roles cannot create resource pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md).

@coderabbitai coderabbitai Bot Aug 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Define the Regional resource-pool eligibility requirement in both restore workflows.

Both changed lines use the undefined phrase restore requirements. State that a Regional resource pool requires at least three eligible availability zones in the applicable region.

  • tidb-cloud/premium/backup-and-restore-premium.md#L245-L245: add the requirement for the backup's region.
  • tidb-cloud/premium/backup-and-restore-premium.md#L369-L369: add the requirement for the target region.

As per path instructions, the contiguous Markdown fixes use committable suggestions. The Regional prerequisite follows the resource-pool contract.

📍 Affects 1 file
  • tidb-cloud/premium/backup-and-restore-premium.md#L245-L245 (this comment)
  • tidb-cloud/premium/backup-and-restore-premium.md#L369-L369

Source: Path instructions


If the selected resource pool has a Pool vCPU Limit and its current provisioned vCPU is greater than or equal to the limit, TiDB Cloud displays a warning and you cannot restore the instance to that resource pool. To continue, go to the Resource Pool details page to increase or turn off the Pool vCPU Limit, or select another resource pool.

> **Important:**

@qiancai qiancai Aug 24, 2026

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
> **Important:**
> **Note:**

@qiancai qiancai Aug 24, 2026

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.

Important: is not supported in our doc site

>
> Even if the current provisioned vCPU is below the Pool vCPU Limit, restoring an instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before restoring the instance, make sure that the resource pool has sufficient vCPU capacity. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.
</CustomContent>

Expand Down Expand Up @@ -366,7 +372,13 @@ To restore backups from cloud storage, do the following:

<CustomContent plan="byoc">

For {{{ .byoc }}}, select an active resource pool that matches the target cloud provider and region. If no suitable resource pool is available, an `Organization Owner` can create one before restoring the instance. Other roles cannot create resource pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md).
For {{{ .byoc }}}, select an active resource pool that matches the target cloud provider and region. The restored instance inherits the high availability mode of the selected resource pool. You can restore the same backup to a Zonal or Regional resource pool if the resource pool meets the restore requirements. If no suitable resource pool is available, an `Organization Owner` can create one before restoring the instance. Other roles cannot create resource pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md).

If the selected resource pool has a Pool vCPU Limit and its current provisioned vCPU is greater than or equal to the limit, TiDB Cloud displays a warning and you cannot restore the instance to that resource pool. To continue, go to the Resource Pool details page to increase or turn off the Pool vCPU Limit, or select another resource pool.

> **Important:**

@qiancai qiancai Aug 24, 2026

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
> **Important:**
> **Note:**

>
> Even if the current provisioned vCPU is below the Pool vCPU Limit, restoring an instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before restoring the instance, make sure that the resource pool has sufficient vCPU capacity. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.

@qiancai qiancai Aug 24, 2026

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
> Even if the current provisioned vCPU is below the Pool vCPU Limit, restoring an instance might cause the total provisioned vCPU to exceed the limit. This might constrain resource scaling and degrade the performance of all instances in the resource pool. Before restoring the instance, make sure that the resource pool has sufficient vCPU capacity. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.
> Even if the current provisioned vCPU is below the Pool vCPU Limit, restoring an instance might cause the total provisioned vCPU to exceed the limit. This might restrict resource scaling and affect the performance of all instances in the resource pool. Before restoring the instance, make sure that the resource pool has sufficient vCPU capacity. If necessary, increase or turn off the Pool vCPU Limit, or select another resource pool.

</CustomContent>

Expand Down
Loading