byoc: add onboarding docs and diagram#23256
Conversation
lilin90
added
translation/no-need
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
Bot
added
the
do-not-merge/work-in-progress
|
[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
the
size/XXL
![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 comprehensive documentation for the TiDB Cloud BYOC (Bring Your Own Cloud) onboarding and deployment process on AWS, covering prerequisites, IAM setup, instance creation, joint validation, multi-region deployment, and security hardening. The reviewer's feedback focuses on improving readability and ensuring strict adherence to the style guide. Key recommendations include converting headings to sentence case, correcting typos and broken backticks, replacing full-width punctuation with standard half-width characters, fixing incorrect step/section references, and formatting tables and code blocks for better clarity.
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.
|
|
||
| **Note:** This phase is fully managed by TiDB Cloud. No customer action is required until you receive the completion notification. | ||
|
|
||
| ## **3.1 Deployment Timeline** |
There was a problem hiding this comment.
According to the style guide, headings should use sentence case and avoid unnecessary bold formatting.
| ## **3.1 Deployment Timeline** | |
| ## 3.1 Deployment timeline |
References
- Use sentence case for headings (e.g., ## Configure the cluster). (link)
|
|
||
| * Deploy Data Plane Management Nodes: Hosts components (such as the TiDB Operator) to provide the runtime environment for the subsequent creation of TiDB compute and storage nodes. | ||
|
|
||
| ## **3.2 Deployment completion** |
There was a problem hiding this comment.
According to the style guide, headings should use sentence case and avoid unnecessary bold formatting.
| ## **3.2 Deployment completion** | |
| ## 3.2 Deployment completion |
References
- Use sentence case for headings (e.g., ## Configure the cluster). (link)
|
|
||
| Once the automation completes: | ||
|
|
||
| 1. **Notification: You will be notified by the TiDB Cloud Team that the BYOC Region is ready.** |
There was a problem hiding this comment.
Avoid passive voice and unnecessary bolding of the entire list item. Also, 'team' and 'region' should be lowercase.
| 1. **Notification: You will be notified by the TiDB Cloud Team that the BYOC Region is ready.** | |
| 1. **Notification:** The TiDB Cloud team will notify you when the BYOC region is ready. |
References
- Avoid passive voice and use consistent lowercase terminology for non-proper nouns. (link)
| | Note: Each phase requires timely coordination between teams. We recommend assigning dedicated resources from both organizations to ensure smooth progression through all stages. | | ||
| | :---- | | ||
|
|
||
| ## **Architecture Overview** |
There was a problem hiding this comment.
According to the style guide, headings should use sentence case and avoid unnecessary bold formatting.
| ## **Architecture Overview** | |
| ## Architecture overview |
References
- Use sentence case for headings (e.g., ## Configure the cluster). (link)
|
|
||
| 1. Log in to the [TiDB Cloud Console](https://tidbcloud.com/). | ||
|
|
||
| If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up.* *You may sign up with an email/password to manage TiDB Cloud credentials, or use single sign-on (SSO) via google, Github, or Microsoft accounts. |
There was a problem hiding this comment.
Fix the typo '* *', use 'can' instead of 'may' per the style guide, and capitalize 'Google' and 'GitHub'.
| If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up.* *You may sign up with an email/password to manage TiDB Cloud credentials, or use single sign-on (SSO) via google, Github, or Microsoft accounts. | |
| If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up. You can sign up with an email/password to manage TiDB Cloud credentials, or use single sign-on (SSO) via Google, GitHub, or Microsoft accounts. |
References
- Correct English grammar, spelling, and punctuation mistakes. (link)
|
|
||
| * *Initial Setup Time:* The creation of the **first instance** typically takes approximately **1 hour** as the system initializes the Kubernetes environment. | ||
|
|
||
| * *Subsequentinstances:* Creating additional instances in the same region will only take a few minutes. |
There was a problem hiding this comment.
Fix the typo 'Subsequentinstances' by adding a space.
| * *Subsequentinstances:* Creating additional instances in the same region will only take a few minutes. | |
| * *Subsequent instances:* Creating additional instances in the same region will only take a few minutes. |
References
- Correct English grammar, spelling, and punctuation mistakes. (link)
| | Category | Validation Item | Owner | | ||
| | :---- | :---- | :---- | | ||
| | **Connectivity** | SQL Endpoint: verify connectivity to both private and public SQL endpoints from your application servers. | Customer | | ||
| | | Secure Tunnel（Optional）: Confirm stable VPN links via the Bastion Host. | TiDB Cloud | |
There was a problem hiding this comment.
Replace full-width parentheses with standard half-width parentheses, and use lowercase for 'bastion host'.
| | | Secure Tunnel（Optional）: Confirm stable VPN links via the Bastion Host. | TiDB Cloud | | |
| | | Secure Tunnel (Optional): Confirm stable VPN links via the bastion host. | TiDB Cloud | |
Rename and reorganize the BYOC onboarding guide into clearer phase-based pages, update links in the overview, and rewrite deployment, IAM, service initialization, validation, multi-region, and security hardening content for consistency.
ti-chi-bot
Bot
removed
the
do-not-merge/work-in-progress
1 participant
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)?
Do your changes match any of the following descriptions?