resource pool management - #23471
Conversation
ti-chi-bot
Bot
added
missing-translation-status
📝 WalkthroughWalkthroughAdded BYOC Resource Pool documentation, including concepts, creation and management procedures, CIDR planning, instance provisioning requirements, onboarding updates, and restore guidance. ChangesBYOC Resource Pool documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 12748764-dfb3-48d9-bbfa-c14c8600bfb4
📒 Files selected for processing (13)
TOC-tidb-cloud-byoc.mdtidb-cloud/architecture-concepts.mdtidb-cloud/byoc/_index.mdtidb-cloud/byoc/byoc-features.mdtidb-cloud/byoc/byoc-initialize-service.mdtidb-cloud/byoc/byoc-onboarding-overview.mdtidb-cloud/byoc/byoc-prepare-environment-aws.mdtidb-cloud/byoc/create-resource-pool-byoc.mdtidb-cloud/byoc/create-tidb-instance-byoc.mdtidb-cloud/byoc/manage-resource-pools-byoc.mdtidb-cloud/byoc/multi-region-deployment.mdtidb-cloud/manage-projects-and-resources.mdtidb-cloud/premium/backup-and-restore-premium.md
| * Initial setup time: the creation of the **first Resource Pool** in a region might take approximately **1 hour** as the system initializes the Kubernetes environment. | ||
| * Subsequent instances: creating additional instances in an active Resource Pool usually takes only a few minutes. | ||
|
|
||
| 3. Consult with your TiDB Cloud representative to determine the appropriate Request Unit (RU) settings for your initial connectivity and functional tests. They will recommend a configuration based on your specific testing requirements. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use the established Request Capacity Unit (RCU) term.
Line 21 uses “Request Unit (RU)”. The BYOC instance guide uses “Request Capacity Units (RCUs)” for the same setting. Use the established term to avoid ambiguity during initial capacity planning.
Committable replacement
-3. Consult with your TiDB Cloud representative to determine the appropriate Request Unit (RU) settings for your initial connectivity and functional tests. They will recommend a configuration based on your specific testing requirements.
+3. Consult your TiDB Cloud representative to determine the appropriate Request Capacity Unit (RCU) settings for your initial connectivity and functional tests. They will recommend a configuration based on your specific testing requirements.As per path instructions, this Markdown fix uses an exact contiguous replacement and preserves the existing list structure.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 3. Consult with your TiDB Cloud representative to determine the appropriate Request Unit (RU) settings for your initial connectivity and functional tests. They will recommend a configuration based on your specific testing requirements. | |
| 3. Consult your TiDB Cloud representative to determine the appropriate Request Capacity Unit (RCU) settings for your initial connectivity and functional tests. They will recommend a configuration based on your specific testing requirements. |
🧰 Tools
🪛 LanguageTool
[style] ~21-~21: This phrase is redundant. Consider writing “Consult”.
Context: ...l usually takes only a few minutes. 3. Consult with your TiDB Cloud representative to deter...
(CONSULT_WITH)
Source: Path instructions
| ## What's next | ||
|
|
||
| After you create your first {{{ .byoc }}} instance and configure secure administrative access, continue with [TiDB Cloud BYOC Joint Validation](/tidb-cloud/byoc/joint-validation.md) to validate connectivity, observability, security, and alerting. | ||
| After you create your first Resource Pool and {{{ .byoc }}} instance and configure secure administrative access, continue with [TiDB Cloud BYOC Joint Validation](/tidb-cloud/byoc/joint-validation.md) to validate connectivity, observability, security, and alerting. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Do not make secure access a prerequisite.
Lines 45-48 state that secure administrative access is optional. Line 54 uses “and configure secure administrative access” as a prerequisite for joint validation. Make the optional condition explicit.
Committable replacement
-After you create your first Resource Pool and {{{ .byoc }}} instance and configure secure administrative access, continue with [TiDB Cloud BYOC Joint Validation](/tidb-cloud/byoc/joint-validation.md) to validate connectivity, observability, security, and alerting.
+After you create your first Resource Pool and {{{ .byoc }}} instance and, if needed, configure secure administrative access, continue with [TiDB Cloud BYOC Joint Validation](/tidb-cloud/byoc/joint-validation.md) to validate connectivity, observability, security, and alerting.As per path instructions, this Markdown fix uses an exact contiguous replacement and preserves the existing paragraph structure.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| After you create your first Resource Pool and {{{ .byoc }}} instance and configure secure administrative access, continue with [TiDB Cloud BYOC Joint Validation](/tidb-cloud/byoc/joint-validation.md) to validate connectivity, observability, security, and alerting. | |
| After you create your first Resource Pool and {{{ .byoc }}} instance and, if needed, configure secure administrative access, continue with [TiDB Cloud BYOC Joint Validation](/tidb-cloud/byoc/joint-validation.md) to validate connectivity, observability, security, and alerting. |
Source: Path instructions
| 6. In the **Resource Pool** area, select an active Resource Pool. | ||
|
|
||
| Only Resource Pools that match the selected cloud provider and region and are in the **Active** status are displayed. If no suitable Resource Pool is available and you are an `Organization Owner`, click **Create Resource Pool** to create one. After the Resource Pool is created, it is automatically selected for the new instance. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Wait for the Resource Pool to become Active.
The Resource Pool lifecycle documentation states that a newly created pool is initially Creating and cannot host instances until it becomes Active. Line 50 says that the pool is automatically selected immediately after creation. State the Active requirement explicitly.
Committable replacement
- Only Resource Pools that match the selected cloud provider and region and are in the **Active** status are displayed. If no suitable Resource Pool is available and you are an `Organization Owner`, click **Create Resource Pool** to create one. After the Resource Pool is created, it is automatically selected for the new instance.
+ Only Resource Pools that match the selected cloud provider and region and are in the **Active** status are displayed. If no suitable Resource Pool is available and you are an `Organization Owner`, click **Create Resource Pool** to create one. After the Resource Pool becomes **Active**, select it for the new instance.As per path instructions, this Markdown fix uses an exact contiguous replacement and preserves the existing paragraph structure.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 6. In the **Resource Pool** area, select an active Resource Pool. | |
| Only Resource Pools that match the selected cloud provider and region and are in the **Active** status are displayed. If no suitable Resource Pool is available and you are an `Organization Owner`, click **Create Resource Pool** to create one. After the Resource Pool is created, it is automatically selected for the new instance. | |
| 6. In the **Resource Pool** area, select an active Resource Pool. | |
| Only Resource Pools that match the selected cloud provider and region and are in the **Active** status are displayed. If no suitable Resource Pool is available and you are an `Organization Owner`, click **Create Resource Pool** to create one. After the Resource Pool becomes **Active**, select it for the new instance. |
Source: Path instructions
| For each new region, the O11Y CIDR and Resource Pool CIDRs must not overlap with: | ||
|
|
||
| * the TiDB Cluster CIDR and O11Y CIDR within the same region; | ||
| * the O11Y CIDR in the same region; | ||
| * any existing Resource Pool CIDR in the same region; | ||
| * existing application VPCs, on-premises networks, or VPN networks that will be connected through VPC Peering or VPN; or | ||
| * other TiDB clusters that will participate in cross-region replication. | ||
| * other Resource Pools that will participate in cross-region replication. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Remove the self-overlap condition.
Line 140 says that the O11Y CIDR must not overlap with “the O11Y CIDR in the same region.” Each region has one O11Y CIDR, so this condition overlaps the CIDR with itself. State that the O11Y CIDR and Resource Pool CIDRs must not overlap with one another in the same region.
Committable replacement
-For each new region, the O11Y CIDR and Resource Pool CIDRs must not overlap with:
-
-* the O11Y CIDR in the same region;
-* any existing Resource Pool CIDR in the same region;
-* existing application VPCs, on-premises networks, or VPN networks that will be connected through VPC Peering or VPN; or
-* other Resource Pools that will participate in cross-region replication.
+For each new region, the O11Y CIDR and each Resource Pool CIDR must not overlap with one another or with:
+
+* any existing Resource Pool CIDR in the same region;
+* existing application VPCs, on-premises networks, or VPN networks that will be connected through VPC Peering or VPN; or
+* other Resource Pools that require cross-region connectivity or replication.As per path instructions, this Markdown fix uses an exact contiguous replacement and preserves the existing list structure.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For each new region, the O11Y CIDR and Resource Pool CIDRs must not overlap with: | |
| * the TiDB Cluster CIDR and O11Y CIDR within the same region; | |
| * the O11Y CIDR in the same region; | |
| * any existing Resource Pool CIDR in the same region; | |
| * existing application VPCs, on-premises networks, or VPN networks that will be connected through VPC Peering or VPN; or | |
| * other TiDB clusters that will participate in cross-region replication. | |
| * other Resource Pools that will participate in cross-region replication. | |
| For each new region, the O11Y CIDR and each Resource Pool CIDR must not overlap with one another or with: | |
| * any existing Resource Pool CIDR in the same region; | |
| * existing application VPCs, on-premises networks, or VPN networks that will be connected through VPC Peering or VPN; or | |
| * other Resource Pools that require cross-region connectivity or replication. |
🧰 Tools
🪛 LanguageTool
[style] ~144-~144: This phrase is redundant (‘N’ stands for ‘network’). Use simply “VPNs”.
Context: ...lication VPCs, on-premises networks, or VPN networks that will be connected through VPC Peer...
(ACRONYM_TAUTOLOGY)
Source: Path instructions
ti-chi-bot
Bot
removed
the
missing-translation-status
lilin90
added
area/tidb-cloud
|
[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 |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
tidb-cloud/byoc/byoc-prepare-environment-aws.md (1)
93-95: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winConfigure and verify the 20-year subordinate CA validity.
The steps list
Subordinate CAas the CA type, but omit the validity duration and the parent-root validity requirement, while AWS Private CA defaults subordinate CA validity to three years and requires child CA certificates not to exceed their parent CA’s validity. Specify setting subordinate CA validity to at least 20 years, set the signing root CA to at least 20 years, and include an explicit check, such asopenssl x509 -in subordinate-ca.crt -noout -datesor the AWS console validity dates.Source: Path instructions
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 04b60e8f-5f64-40ab-8c93-7a75fbab9b3d
📒 Files selected for processing (5)
TOC-tidb-cloud-byoc.mdtidb-cloud/byoc/_index.mdtidb-cloud/byoc/byoc-onboarding-overview.mdtidb-cloud/byoc/byoc-prepare-environment-aws.mdtidb-cloud/premium/backup-and-restore-premium.md
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?
Summary by CodeRabbit