byoc: add creating byoc instance and select byoc plan #23300
+208
−119
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||||||
|
|
||||||
| 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: | ||||||
|
Contributor
There was a problem hiding this comment. To avoid passive voice ("are met") and adhere to the style guide's principle of writing in the second person ("you"), rephrase this sentence to be active.
Suggested change
|
||||||
|
|
||||||
| - 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. | ||||||
|
Contributor
There was a problem hiding this comment. To avoid passive voice ("required by TiDB Cloud"), rephrase this sentence to use active voice.
Suggested change
References
|
||||||
| - 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). | ||||||
|
Contributor
There was a problem hiding this comment. To avoid passive voice ("is not displayed"), rephrase this sentence to use active voice.
Suggested change
References
|
||||||
|
|
||||||
| ## 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 high availability mode is determined by the BYOC deployment configuration. If your BYOC environment is deployed in Regional mode, the instance uses Regional high availability. If your BYOC environment is deployed in Zonal mode, the instance uses Zonal high availability. The high availability mode is not configurable when you create an instance. For more information, see [High Availability](/tidb-cloud/serverless-high-availability.md). | ||||||
|
Contributor
There was a problem hiding this comment. This step contains multiple passive voice constructions ("is determined", "is deployed", "is not configurable"). Rephrasing to active voice and using the second person ("you") improves clarity and readability.
Suggested change
|
||||||
|
|
||||||
| 8. Click **Create**. | ||||||
|
|
||||||
| The instance creation process begins. Provisioning time can vary depending on the selected region, capacity, and cloud provider. | ||||||
|
Contributor
There was a problem hiding this comment. To make the sentence more active and address the user directly, rephrase "the selected region" to "the region... you select".
Suggested change
|
||||||
|
|
||||||
| ## 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. | ||||||
|
Contributor
There was a problem hiding this comment. To avoid passive voice ("has not been configured") and use the second person ("you"), rephrase this sentence.
Suggested change
|
||||||
| - Configure network access from your application environment to the instance endpoint. | ||||||
| - Connect to the instance from your application or SQL client. | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.