byoc: add resource pool management doc - #23471
Conversation
ti-chi-bot
Bot
added
missing-translation-status
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 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
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
lilin90
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: da3ca881-9804-4cc1-83b6-b4e9ac40344e
📒 Files selected for processing (2)
tidb-cloud/architecture-concepts.mdtidb-cloud/byoc/byoc-features.md
| - **TiKV**: TiKV is required. Select the initial vCPU and RAM configuration, storage size, and node count. The node count must meet the high availability requirement and must be a multiple of three. After the Resource Pool is created, TiKV can automatically scale out based on workload needs. You can also manually scale out TiKV in advance. Currently, TiDB Cloud does not support manual or automatic TiKV scale-in from the console, because scale-in can be risky. To scale in TiKV, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). | ||
| - **TiFlash**: TiFlash is optional. If you do not enable TiFlash when creating the Resource Pool, TiDB Cloud does not deploy TiFlash nodes. You can enable TiFlash later based on your workload needs. If you enable TiFlash, select the vCPU and RAM configuration, storage size, and node count. | ||
|
|
||
| After the Resource Pool is created, you cannot manually change the TiKV machine type from the console. During automatic scale-out, TiDB Cloud might change the TiKV machine type based on workload needs. After TiFlash is provisioned, you cannot disable it from the console. To disable TiFlash, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). |
There was a problem hiding this comment.
We support disable TiFlash in console.
|
|
||
| 7. In the **High Availability** area, review the high availability mode. | ||
|
|
||
| The high availability mode is inherited from the BYOC deployment configuration of the selected region. You cannot change it when creating a Resource Pool. |
There was a problem hiding this comment.
Now the high availability mode is not restricted by the region deployment configuration. The user can select a HA mode in console.
| - TiKV machine type cannot be changed after the Resource Pool is created. | ||
| - TiFlash is optional. If TiFlash is not enabled, no TiFlash nodes are provisioned. | ||
| - You can enable TiFlash later based on workload requirements. | ||
| - After TiFlash is provisioned, you cannot disable it from the TiDB Cloud console. To disable TiFlash, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). |
There was a problem hiding this comment.
The user can disable TiFlash in console.
| When a Resource Pool has an ongoing modification operation, TiDB Cloud refreshes Resource Pool data in real time or near real time. During this period: | ||
|
|
||
| - You can view the Resource Pool overview, metrics, instances, tags, and other details. | ||
| - You can create an instance if the backend validation succeeds. |
There was a problem hiding this comment.
The create-tidb-instance-byoc doc already mentions that the user can only create an instance in the resource pool with Active state.
| * 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.
| * other resource pools that will participate in cross-region replication. | |
| * resource pool CIDRs in other regions if the resource pools will participate in cross-region replication. |
3 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