Create a TiDB Cloud BYOC Instance

This document describes how to create a TiDB Cloud BYOC instance in the TiDB Cloud console.

TiDB Cloud BYOC (Bring Your Own Cloud) keeps the control plane in TiDB Cloud while deploying the data plane in your own cloud account. Before you create a BYOC instance, your organization must complete BYOC onboarding and prepare the target cloud environment.

In TiDB Cloud BYOC, a resource pool provides the underlying physical resources, network, and capacity for BYOC instances. Before you create a BYOC instance, you must have an active resource pool in the target cloud provider and region.

Before you begin

If you do not have a TiDB Cloud account, click here to sign up for an account.

Before you create a BYOC instance, make sure that the following requirements are met:

• You have the required organization or project role to create TiDB Cloud resources.
• Your organization has completed the prerequisite BYOC setup for the target cloud provider and region, including the required cloud account permissions. For AWS, this includes the IAM roles required by TiDB Cloud to deploy and manage BYOC resources in your AWS account.
• An active resource pool exists in the cloud provider and region where you want to deploy the BYOC instance.

If your BYOC environment is not ready, the Bring Your Own Cloud tab is not displayed on the Create Resource page. To enable BYOC for your organization, contact your TiDB Cloud account team or TiDB Cloud Support.

If no suitable resource pool is available, an Organization Owner can create one from BYOC Management > Resource Pools or from the instance creation workflow. Other roles cannot create resource pools. For more information, see Create a Resource Pool.

Steps

If you have the required permissions, you can create a TiDB Cloud BYOC instance as follows:

1. In the TiDB Cloud console, navigate to the My TiDB page, and then click Create Resource in the upper-right corner.

2. On the Create Resource page, click the Bring Your Own Cloud tab.

3. Confirm that BYOC is selected as your plan.

   BYOC is powered by TiDB X and is designed for large-scale production workloads. It lets you run the data plane in your own cloud account while using TiDB Cloud for automated operations, elastic scalability, and enterprise-grade security.

4. In the Basic Settings area, enter a name for your TiDB Cloud BYOC instance, and then choose a cloud provider and a region where you want to host your instance.

5. (Optional) To group this TiDB Cloud BYOC instance in a project for management, select the target project for the instance.

6. In the Resource Pool area, select an active resource pool.

   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.

   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 TiDB Cloud 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 TiDB Cloud 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.

9. Click Create.

   The instance creation process begins. Provisioning time can vary depending on the region, capacity, and cloud provider you select.

What's next

After your BYOC instance is created, you can do the following:

• Set or reset the root password for the instance if it has not been configured.
• Configure network access from your application environment to the instance endpoint.
• Connect to the instance from your application or SQL client.