-
Notifications
You must be signed in to change notification settings - Fork 717
byoc: add creating byoc instance and select byoc plan #23300
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.
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
Merged
+218
−120
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e59ef0b
selectbyocplan
wildpcww 2fa2707
Update custom content format
lilin90 e86d9c2
Update format
lilin90 f4522e6
Update format
lilin90 5a55ba4
Apply suggestions from code review
lilin90 f22e0e1
Apply suggestions from code review
lilin90 484418c
Update manage-projects-and-resources.md
lilin90 29985cc
Merge branch 'selectplan' of https://github.com/wildpcww/docs into pr…
lilin90 cfa8be1
Update TOC-tidb-cloud-byoc.md
lilin90 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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: | ||
|
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. | ||
|
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). | ||
|
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. | ||
|
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. | ||
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.