byoc: add creating byoc instance and select byoc plan#23300
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
contribution
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for the new TiDB Cloud BYOC (Bring Your Own Cloud) plan, including a new guide on how to create a BYOC instance and updates to existing documents on managing projects and selecting cluster tiers. The feedback focuses on aligning the new content with the repository's style guide, specifically correcting heading capitalization to sentence case and rephrasing multiple passive voice constructions to active voice using the second person ('you').
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
|
||
| 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: |
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.
| Before you create a BYOC instance, make sure that the following requirements are met: | |
| Before you create a BYOC instance, make sure that you meet the following requirements: |
| 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. |
There was a problem hiding this comment.
To avoid passive voice ("required by TiDB Cloud"), rephrase this sentence to use active voice.
| - 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. | |
| - 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 that TiDB Cloud requires to deploy and manage BYOC resources in your AWS account. |
References
- Avoid passive voice overuse. (link)
| - 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. | ||
| - 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). |
There was a problem hiding this comment.
To avoid passive voice ("is not displayed"), rephrase this sentence to use active voice.
| 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). | |
| If your BYOC environment is not ready, TiDB Cloud does not display the **Bring Your Own Cloud** tab 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). |
References
- Avoid passive voice overuse. (link)
|
|
||
| 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). |
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.
| 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). | |
| 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 selected region, capacity, and cloud provider. |
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".
| The instance creation process begins. Provisioning time can vary depending on the selected region, capacity, and cloud provider. | |
| The instance creation process begins. Provisioning time can vary depending on the region, capacity, and cloud provider you select. |
|
|
||
| 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. |
There was a problem hiding this comment.
To avoid passive voice ("has not been configured") and use the second person ("you"), rephrase this sentence.
| - Set or reset the root password for the instance if it has not been configured. | |
| - Set or reset the root password for the instance if you have not configured it. |
| > | ||
| > <CustomContent platform="tidb-cloud" plan="byoc"> | ||
| > | ||
| > 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. |
There was a problem hiding this comment.
To avoid passive voice ("are configured") and address the user directly, rephrase this sentence to use active voice.
| > 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 {{{ .byoc }}} instances, projects are optional. The data plane runs in your own cloud account, and you configure BYOC environment-level settings during BYOC onboarding. |
|
|
||
| ## {{{ .byoc }}} {#byoc} | ||
|
|
||
| {{{ .byoc }}} is designed for enterprise workloads that require stronger control over data location, cloud resources, network boundaries, and compliance posture. With {{{ .byoc }}}, the TiDB Cloud control plane is managed by PingCAP, while the data plane runs in your own cloud account. |
There was a problem hiding this comment.
To avoid passive voice ("is managed by PingCAP"), rephrase this sentence to use active voice.
| {{{ .byoc }}} is designed for enterprise workloads that require stronger control over data location, cloud resources, network boundaries, and compliance posture. With {{{ .byoc }}}, the TiDB Cloud control plane is managed by PingCAP, while the data plane runs in your own cloud account. | |
| {{{ .byoc }}} is designed for enterprise workloads that require stronger control over data location, cloud resources, network boundaries, and compliance posture. With {{{ .byoc }}}, PingCAP manages the TiDB Cloud control plane, while the data plane runs in your own cloud account. |
References
- Avoid passive voice overuse. (link)
ti-chi-bot
Bot
removed
the
missing-translation-status
lilin90
changed the title
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?