Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion TOC-tidb-cloud-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
- [Security Hardening](/tidb-cloud/byoc/security-hardening.md)
- [Multi-Region Deployment](/tidb-cloud/byoc/multi-region-deployment.md)
- Manage Instances
- [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md)
- [Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md)
- Connect to Your {{{ .premium }}} Instance
- [Connection Overview](/tidb-cloud/premium/connect-to-tidb-instance.md)
- [Connect via Public Endpoint](/tidb-cloud/premium/connect-to-premium-via-public-connection.md)
Expand Down
58 changes: 58 additions & 0 deletions tidb-cloud/byoc/create-tidb-instance-byoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Create a {{{ .byoc }}} Instance
summary: Learn how to create a {{{ .byoc }}} instance.
---

# Create a {{{ .byoc }}} Instance
Comment thread
lilin90 marked this conversation as resolved.

This document describes how to create a {{{ .byoc }}} instance in the [TiDB Cloud console](https://tidbcloud.com/).

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.

> **Note:**
>
> To learn how to create a {{{ .premium }}} instance, see [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md).

## Before you begin

If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/signup) to sign up for an account.

Before you create a BYOC instance, make sure that the following requirements are met:
Comment thread
lilin90 marked this conversation as resolved.

- 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.
Comment thread
lilin90 marked this conversation as resolved.
- You know 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](/tidb-cloud/tidb-cloud-support.md).
Comment thread
lilin90 marked this conversation as resolved.

## Steps

If you have the required permissions, you can create a {{{ .byoc }}} instance as follows:

1. In the [TiDB Cloud console](https://tidbcloud.com/tidbs), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) 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 {{{ .byoc }}} instance, and then choose a cloud provider and a region where you want to host your instance.

5. (Optional) To group this {{{ .byoc }}} instance in a project for management, select the target project for the instance.

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

7. For {{{ .byoc }}} instances, the BYOC deployment configuration determines the high availability mode. If you deploy your BYOC environment in Regional mode, the instance uses Regional high availability. If you deploy your BYOC environment in Zonal mode, the instance uses Zonal high availability. You cannot configure the high availability mode when you create an instance. For more information, see [High Availability](/tidb-cloud/serverless-high-availability.md).

8. 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.
Comment thread
lilin90 marked this conversation as resolved.
- Configure network access from your application environment to the instance endpoint.
- Connect to the instance from your application or SQL client.
21 changes: 20 additions & 1 deletion tidb-cloud/manage-projects-and-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can discover, access, a

A TiDB Cloud resource is a deployable unit that you can manage. It can be one of the following:

- A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, or Premium instance
- A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, Premium<CustomContent plan="byoc">, or BYOC</CustomContent> instance
- A {{{ .dedicated }}} cluster

### TiDB Cloud projects
Expand Down Expand Up @@ -45,6 +45,12 @@ For more information, see the following documents:

- [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md)

<CustomContent plan="byoc">

- [Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md)

</CustomContent>

- [Create a {{{ .dedicated }}} Cluster](/tidb-cloud/create-tidb-cluster.md)

### Manage TiDB Cloud resources
Expand Down Expand Up @@ -94,10 +100,23 @@ To create a new project, take the following steps:

- If the project is created for TiDB X instances, click **Confirm**.

<CustomContent plan="starter,essential,premium,dedicated">

> **Note:**
>
> For {{{ .premium }}} instances, encryption is configured per instance rather than per project. After you create the instance, you can enable [Dual-Layer Data Encryption](/tidb-cloud/premium/dual-layer-data-encryption-premium.md) to add a database-layer encryption on top of the default storage-layer encryption.

</CustomContent>

<CustomContent plan="byoc">

> **Note:**
>
> - For {{{ .byoc }}} instances, projects are optional. The data plane runs in your own cloud account, and BYOC environment-level settings are configured during BYOC onboarding.
> - For {{{ .premium }}} instances, encryption is configured per instance rather than per project. After you create the instance, you can enable [Dual-Layer Data Encryption](/tidb-cloud/premium/dual-layer-data-encryption-premium.md) to add a database-layer encryption on top of the default storage-layer encryption.

</CustomContent>

- If the project is created for {{{ .dedicated }}} clusters, select the **Create for Dedicated Cluster** option, configure [Customer-Managed Encryption Keys (CMEK)](/tidb-cloud/tidb-cloud-encrypt-cmek-aws.md) and [maintenance window](/tidb-cloud/configure-maintenance-window.md) for the project, and then click **Confirm**.

### Manage a project
Expand Down
Loading
Loading