diff --git a/TOC-tidb-cloud-byoc.md b/TOC-tidb-cloud-byoc.md index 8b46bb611a46f..7eae2d873df04 100644 --- a/TOC-tidb-cloud-byoc.md +++ b/TOC-tidb-cloud-byoc.md @@ -40,6 +40,10 @@ - [Joint Validation](/tidb-cloud/byoc/joint-validation.md) - [Security Hardening](/tidb-cloud/byoc/security-hardening.md) - [Multi-Region Deployment](/tidb-cloud/byoc/multi-region-deployment.md) +- Manage Resources + - Resource Pools + - [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md) + - [Manage Resource Pools](/tidb-cloud/byoc/manage-resource-pools-byoc.md) - Manage Instances - [Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md) - Connect to Your {{{ .byoc }}} Instance diff --git a/tidb-cloud/architecture-concepts.md b/tidb-cloud/architecture-concepts.md index f6afa7b289b94..c7fedf403795d 100644 --- a/tidb-cloud/architecture-concepts.md +++ b/tidb-cloud/architecture-concepts.md @@ -110,6 +110,7 @@ A TiDB Cloud BYOC deployment includes the following major components: - **TiDB Cloud control plane**: provides the TiDB Cloud console, organization and project management, billing, lifecycle orchestration, monitoring views, alerting, and maintenance workflows. - **BYOC data plane**: runs the TiDB service and related infrastructure in your cloud account. TiDB Cloud operates this environment based on the permissions granted during BYOC onboarding. +- **Resource Pool**: defines the underlying physical resource, network, and capacity boundary for one or more {{{ .byoc }}} instances. Each Resource Pool has its own capacity configuration, Resource Pool CIDR, high availability mode, and AWS resource tags. - **TiDB service VPC**: hosts TiDB service components that serve application traffic. - **Observability service VPC**: hosts observability components used to collect metrics, logs, and operational data for the BYOC deployment. - **Application VPC**: hosts your applications. You manage this VPC and configure network connectivity to access the BYOC TiDB service. diff --git a/tidb-cloud/byoc/_index.md b/tidb-cloud/byoc/_index.md index 8e797840cbf5a..3a2140c370a06 100644 --- a/tidb-cloud/byoc/_index.md +++ b/tidb-cloud/byoc/_index.md @@ -53,7 +53,11 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings -[Create a {{{ .byoc }}} Instance](https://docs.tidb.io/tidbcloud/create-tidb-instance-premium/?plan=byoc) +[Create a Resource Pool](https://docs.tidb.io/tidbcloud/create-resource-pool-byoc/?plan=byoc) + +[Manage Resource Pools](https://docs.tidb.io/tidbcloud/manage-resource-pools-byoc/?plan=byoc) + +[Create a {{{ .byoc }}} Instance](https://docs.tidb.io/tidbcloud/create-tidb-instance-byoc/?plan=byoc) [Connect to a {{{ .byoc }}} Instance](https://docs.tidb.io/tidbcloud/connect-to-tidb-instance/?plan=byoc) diff --git a/tidb-cloud/byoc/byoc-features.md b/tidb-cloud/byoc/byoc-features.md index 5c8817b0acff3..0d8fe2ab353c2 100644 --- a/tidb-cloud/byoc/byoc-features.md +++ b/tidb-cloud/byoc/byoc-features.md @@ -46,10 +46,14 @@ This document lists the feature support status for TiDB Cloud BYOC. 🚧 - Resource management + Resource management Pay as you use ❌ + + Resource Pool management + 🔒 + Automatic scaling based on workload 🔒 diff --git a/tidb-cloud/byoc/byoc-initialize-service.md b/tidb-cloud/byoc/byoc-initialize-service.md index 8bec1bf153fdd..e2a44efd5e6ee 100644 --- a/tidb-cloud/byoc/byoc-initialize-service.md +++ b/tidb-cloud/byoc/byoc-initialize-service.md @@ -5,24 +5,24 @@ summary: This document outlines the process for creating a TiDB Cloud BYOC insta # Create Your First TiDB Cloud BYOC Instance -After deploying your BYOC infrastructure, create your first {{{ .byoc }}} instance and configure secure administrative access. +After deploying your BYOC infrastructure, create a Resource Pool, create your first {{{ .byoc }}} instance in the Resource Pool, and configure secure administrative access. ## Create a BYOC instance -You can now provision TiDB instances directly via the TiDB Cloud console. +You can now provision Resource Pools and TiDB instances directly via the TiDB Cloud console. -1. Initiate instance creation. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and follow the [BYOC instance creation workflow](/tidb-cloud/byoc/create-tidb-instance-byoc.md) to create a new instance. +1. Create a Resource Pool. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and follow [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md) to create a Resource Pool in the target cloud provider and region. -2. Select the region and specifications that match your workload requirements. +2. After the Resource Pool becomes **Active**, follow the [BYOC instance creation workflow](/tidb-cloud/byoc/create-tidb-instance-byoc.md) to create a new instance in the Resource Pool. - * Initial Setup Time: The creation of the **first instance** typically takes approximately **1 hour** as the system initializes the Kubernetes environment. - * Subsequent instances: Creating additional instances in the same region will only take a few minutes. + * 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. -## Restore data from Amazon S3 to your new instance +## Restore data from Amazon S3 to a new BYOC instance -After preparing your backup file in Amazon S3, you can proceed to restore the data to your newly created TiDB Cloud BYOC instance. +After preparing your backup file in Amazon S3, you can restore the data to a new {{{ .byoc }}} instance in an active Resource Pool. 1. Configure Amazon S3 Access (AK/SK). @@ -34,6 +34,8 @@ After preparing your backup file in Amazon S3, you can proceed to restore the da Once the access keys are configured, you can initiate the restore job from the TiDB Cloud console. + During restore, select an active Resource Pool in the target cloud provider and region. + For step-by-step restoration procedures, see [Restore backups from cloud storage](/tidb-cloud/premium/backup-and-restore-premium.md#restore-backups-from-cloud-storage). ## Configure secure administrative access @@ -49,4 +51,4 @@ For deployment and verification steps, see [Configure a Bastion Host for {{{ .by ## 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. diff --git a/tidb-cloud/byoc/byoc-onboarding-overview.md b/tidb-cloud/byoc/byoc-onboarding-overview.md index e6106e9f3ea4a..9c0644ed2f672 100644 --- a/tidb-cloud/byoc/byoc-onboarding-overview.md +++ b/tidb-cloud/byoc/byoc-onboarding-overview.md @@ -18,7 +18,7 @@ The TiDB Cloud BYOC deployment process is a collaborative effort between your or | [Phase 1: Environment preparation](/tidb-cloud/byoc/byoc-prepare-environment-aws.md) | Customer | Prepare the AWS foundation required for deployment. This includes creating a dedicated AWS account, configuring Route 53 hosted zones, and setting up the private certificate authority (PCA). | | [Phase 2: IAM bootstrapping](/tidb-cloud/byoc/byoc-configure-iam-permissions.md) | Customer | Execute the provided bootstrapping scripts to install the necessary IAM roles and policies. This authorizes the TiDB Cloud Control Plane to securely manage resources within your AWS account. | | [Phase 3: Automated region deployment](/tidb-cloud/byoc/byoc-automated-deployment.md) | TiDB Cloud | Once IAM permissions are verified, TiDB Cloud automatically provisions the VPC, EKS clusters, and control plane resources. Note: This process is **fully automated** and requires no customer intervention. | -| [Phase 4: Service initialization](/tidb-cloud/byoc/byoc-initialize-service.md) | Customer | Create your TiDB instance via the console. Subsequently, [configure a Bastion Host](/tidb-cloud/byoc/byoc-configure-bastion-host.md) and authentication scripts to establish secure maintenance channels (Tailscale) and observability pipelines. Note: You may also choose to establish maintenance channels using your own custom methods. | +| [Phase 4: Service initialization](/tidb-cloud/byoc/byoc-initialize-service.md) | Customer | Create a Resource Pool and then create your TiDB instance in the Resource Pool via the console. Subsequently, [configure a Bastion Host](/tidb-cloud/byoc/byoc-configure-bastion-host.md) and authentication scripts to establish secure maintenance channels (Tailscale) and observability pipelines. Note: You may also choose to establish maintenance channels using your own custom methods. | | [Phase 5: Validation](/tidb-cloud/byoc/joint-validation.md) | Joint | Both teams collaborate to validate connectivity, verify metric collection, and confirm system health to ensure the BYOC environment is ready for use. | > **Note:** diff --git a/tidb-cloud/byoc/byoc-prepare-environment-aws.md b/tidb-cloud/byoc/byoc-prepare-environment-aws.md index 7d7be31ed64a2..97ab7e90f3fc3 100644 --- a/tidb-cloud/byoc/byoc-prepare-environment-aws.md +++ b/tidb-cloud/byoc/byoc-prepare-environment-aws.md @@ -117,29 +117,29 @@ Perform the following steps: ## Step 6. Plan network CIDR ranges -Before starting the BYOC deployment, plan dedicated CIDR ranges for the TiDB cluster and observability (O11Y) infrastructure. This planning must be evaluated on a **per-region** basis. +Before starting the BYOC deployment, plan dedicated private CIDR ranges for observability (O11Y) infrastructure and Resource Pools. Use a prefix length between `/16` and `/22`. -The CIDR ranges will be used by TiDB Cloud to provision the required AWS networking resources for the BYOC environment. +Each BYOC deployment region has one O11Y CIDR. Resource Pool CIDR is configured for each Resource Pool when you create it. Plan these CIDR ranges before deployment so that the BYOC environment and future Resource Pools can be provisioned without network conflicts. Prepare the following information: | Item | Description | Example | | ----- | ----- | ----- | -| TiDB Cluster CIDR | CIDR range reserved for TiDB cluster and dataplane resources. | `10.10.0.0/16` | -| O11Y CIDR | CIDR range reserved for observability infrastructure and related services. | `10.20.0.0/16` | - -When planning the CIDR ranges, ensure that: +| O11Y CIDR | CIDR range reserved for observability infrastructure and related services in the deployment region. | `10.1.0.0/22` | +| Resource Pool CIDR | CIDR range reserved for a Resource Pool. Each Resource Pool has its own CIDR, which cannot be modified after the Resource Pool is created. | `10.10.0.0/16` | **CIDR Planning Rules & Constraints:** When planning the CIDR ranges, ensure you strictly follow these connectivity rules: -1. **Internal Isolation:** The TiDB Cluster CIDR and O11Y CIDR within the same environment must not overlap with each other. +1. **Internal Isolation:** In the same region, Resource Pool CIDRs must not overlap with the O11Y CIDR or with one another. 2. **VPC Peering Rule:** - * **Cannot Overlap:** Anything that will be peered *cannot* overlap. If you plan to establish VPC Peering between the TiDB Cluster VPC and your existing application VPCs, on-premises networks, or VPNs, the CIDR ranges must be strictly de-conflicted. - * **Can Overlap:** Things that will *never* be peered can safely overlap with the TiDB Cloud BYOC environment. + * **Cannot Overlap:** The O11Y CIDR and any Resource Pool CIDR must not overlap with your existing application VPCs, on-premises networks, or VPN networks. + * **Customer responsibility:** TiDB Cloud cannot detect conflicts with customer-managed networks. You are responsible for planning and verifying these CIDR ranges before deployment or before creating a Resource Pool. + +3. **Cross-region CIDR planning:** Resource Pool CIDRs in different regions can overlap. However, use non-overlapping CIDRs for Resource Pools that require cross-region connectivity or replication. -3. **Cross-Cluster Replication (Critical):** If you plan to deploy multiple TiDB clusters (whether in the same region or across different regions) and eventually want to **replicate data between them** (for example, using TiCDC for Disaster Recovery or data consolidation), their respective TiDB Cluster CIDR ranges **must be de-conflicted**. +4. **Cross-Resource Pool Replication (Critical):** If you plan to deploy multiple Resource Pools and eventually want to **replicate data between instances in different Resource Pools** (for example, using TiCDC for Disaster Recovery or data consolidation), their respective Resource Pool CIDR ranges **must be de-conflicted**. Provide the planned CIDR ranges to your TiDB Cloud representative before the automated region deployment starts. @@ -157,7 +157,7 @@ Fill out the table below with the information gathered in steps above and share | **Availability Zones** | 3 AZs or single AZ per region (specify names and ID) | **Us-east-1:** `us-east-1a`, `use1-az1`, `us-east-1b`, `use1-az2`, `us-east-1c`, `use1-az4`; **Us-east-2:** `us-east-2a`, `use2-az1`, `us-east-2b`, `use2-az2`, `us-east-2c`, `use2-az3`; **Us-west-2:** `us-west-2a`, `usw2-az1` | Step 3. Note to meet the AZ quantity requirement for **each** selected region. | | **Subordinate CA ARN** | AWS ACM Private CA ARN | `arn:aws:acm-pca:us-west-2:123456789012:ca/abcd-1234` | Step 5. The ARN can be shared across multiple regions. | | **Hosted Zone Names & Host Zone ID** | TiDB Cluster Zone, Observability (O11Y) Zone | **Hosted TiDB cluster zone name:** `clusters.byoc-0929.pingcap.net`; **Hosted TiDB cluster zone ID:** `Z1039122VAY4T8UNWR8E`. **Hosted O11Y zone name:** `o11y.byoc-0929.pingcap.net`; **Hosted O11Y zone ID:** `Z10389823CTXFNM7VG79P`. | Step 4. The zone names and IDs can be shared across multiple regions. | -| **CIDR** | Customer-planned CIDR range for the TiDB cluster, Customer-planned CIDR range for the O11Y cluster | **TiDB cluster CIDR:** `10.10.0.0/16`; **O11Y cluster CIDR:** `10.20.0.0/16` | Step 6 | +| **CIDR** | Customer-planned CIDR ranges for O11Y infrastructure and Resource Pools | **O11Y CIDR:** `10.1.0.0/22`; **Resource Pool CIDR:** `10.10.0.0/16` | Step 6 | | **Image Sync Region** | Region ID chosen for image synchronization | `us-west-2` | Refer to [image synchronization](/tidb-cloud/byoc/byoc-automated-deployment.md#step-1-image-synchronization) for details. | ## Review and increase AWS service quotas diff --git a/tidb-cloud/byoc/create-resource-pool-byoc.md b/tidb-cloud/byoc/create-resource-pool-byoc.md new file mode 100644 index 0000000000000..4aaee04ae3365 --- /dev/null +++ b/tidb-cloud/byoc/create-resource-pool-byoc.md @@ -0,0 +1,94 @@ +--- +title: Create a Resource Pool +summary: Learn how to create a Resource Pool for TiDB Cloud BYOC. +--- + +# Create a Resource Pool + +A Resource Pool is the management unit for the underlying physical resources, network, and capacity in a TiDB Cloud BYOC deployment. A Resource Pool can host one or more BYOC instances, and each BYOC instance belongs to one Resource Pool. + +This document describes how to create a Resource Pool in the TiDB Cloud console. + +## Before you begin + +Before you create a Resource Pool, make sure that the following requirements are met: + +- BYOC is enabled for your organization. +- The target cloud provider and region have completed BYOC deployment. +- You have the `Organization Owner` role. Only Organization Owners can create and manage Resource Pools. +- You have planned a dedicated CIDR range for the Resource Pool. +- Your cloud account has sufficient service quota for the Resource Pool capacity that you want to provision. + +## Create a Resource Pool + +To create a Resource Pool, take the following steps: + +1. In the [TiDB Cloud console](https://tidbcloud.com/), click **BYOC Management** > **Resource Pools** in the left navigation pane. + +2. On the **Resource Pools** page, click **Create Resource Pool**. + +3. In the **Basic Settings** area, configure the following fields: + + - **Resource Pool Name**: enter a name for the Resource Pool. The name must be valid and unique. + - **Cloud Provider**: select the cloud provider where the Resource Pool is created. + - **Region**: select the region where the Resource Pool is created. + + You can create a Resource Pool only in a cloud provider and region where BYOC deployment has been completed. If the target region is not available, complete the BYOC deployment for that region first, and then create the Resource Pool. After the Resource Pool is created, you cannot change the cloud provider or region. + +4. In the **Pool vCPU Limit** area, optionally enable and set a Pool vCPU Limit. + + The Pool vCPU Limit is the maximum total provisioned TiDB vCPU capacity allowed for all database-related resources in the Resource Pool, including but not limited to TiDB, TiKV, TiFlash, and PD. It does not include vCPUs used by Observability (O11Y) Nodes or Admin Nodes. If you do not set a limit, resource usage is unrestricted and billed based on consumption. + +5. In the **Pool Capacity** area, configure the initial TiKV resources and optionally configure TiFlash resources: + + - **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). + + If you set a Pool vCPU Limit, make sure that the total vCPUs of the initial TiKV and TiFlash resources do not exceed 50% of the Pool vCPU Limit. This helps reserve capacity for future instance creation and automatic scale-out. + +6. In the **Pool CIDR** area, review or enter the CIDR range for the Resource Pool. + + The Resource Pool CIDR is used as the network address range for resources in the Resource Pool and cannot be modified after the Resource Pool is created. + + The Resource Pool CIDR must meet the following requirements: + + - It must be within one of the supported private network address ranges: `10.0.0.0/8`, `172.16.0.0/12`, or `192.168.0.0/16`. + - The prefix length must be between `/16` and `/22`. + - It must not overlap with the O11Y CIDR or any existing Resource Pool CIDR in the same region. + - It must not overlap with your application VPC CIDR or any other customer-managed network that needs to connect to this Resource Pool. + + TiDB Cloud validates CIDR overlap with known TiDB Cloud managed network ranges in the target region. TiDB Cloud cannot detect overlap with your application VPCs, on-premises networks, or VPN networks. You must verify these customer-managed network ranges before creating the Resource Pool. + +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. + +8. In the **AWS Resource Tags** area, optionally add tags. + + Tags are applied to all taggable AWS resources within the Resource Pool. + + The following rules apply: + + - Tag keys are required. + - Tag values are optional. + - Tag keys and values are case-sensitive. + - Tag keys must be unique and are checked in a case-sensitive manner. + - Tag key length must be from 1 to 128 UTF-8 characters. + - Tag value length must not exceed 256 UTF-8 characters. + - User-defined tag keys cannot start with `aws:`. + - System-reserved AWS tags cannot be overwritten or edited. + - Empty rows are ignored and not submitted. + - Tags must comply with AWS tagging restrictions. + +9. Review the summary on the right side, and then click **Create**. + +After you submit the request, TiDB Cloud validates the configuration and starts an asynchronous provisioning operation. The new Resource Pool is displayed on the **Resource Pools** page with the **Creating** status. After provisioning succeeds, the status changes to **Active**. + +## What's next + +After the Resource Pool becomes **Active**, you can do the following: + +- [Create a BYOC instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md) in the Resource Pool. +- [Manage the Resource Pool](/tidb-cloud/byoc/manage-resource-pools-byoc.md), including updating capacity, updating the Pool vCPU Limit, and managing AWS resource tags. diff --git a/tidb-cloud/byoc/create-tidb-instance-byoc.md b/tidb-cloud/byoc/create-tidb-instance-byoc.md index f1e81b163ba62..bbf03bff92d33 100644 --- a/tidb-cloud/byoc/create-tidb-instance-byoc.md +++ b/tidb-cloud/byoc/create-tidb-instance-byoc.md @@ -9,6 +9,8 @@ This document describes how to create a {{{ .byoc }}} instance in the [TiDB Clou 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. +In TiDB Cloud BYOC, a Resource Pool provides the underlying physical resources, network, and capacity for BYOC instances. Before you create a BYOC instance, you must have an active Resource Pool in the target cloud provider and region. + > **Note:** > > To learn how to create a {{{ .premium }}} instance, see [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md). @@ -21,10 +23,12 @@ Before you create a BYOC instance, make sure that the following requirements are - 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. -- You know the cloud provider and region where you want to deploy the BYOC instance. +- An active Resource Pool exists in 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). +If no suitable Resource Pool is available, an `Organization Owner` can create one from **BYOC Management** > **Resource Pools** or from the instance creation workflow. Other roles cannot create Resource Pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md). + ## Steps If you have the required permissions, you can create a {{{ .byoc }}} instance as follows: @@ -41,11 +45,15 @@ If you have the required permissions, you can create a {{{ .byoc }}} instance as 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. +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. + +7. 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. For {{{ .byoc }}} instances, the high availability mode is inherited from the selected Resource Pool. If the Resource Pool uses Regional high availability, the instance uses Regional high availability. If the Resource Pool uses Zonal high availability, 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**. +9. Click **Create**. The instance creation process begins. Provisioning time can vary depending on the region, capacity, and cloud provider you select. diff --git a/tidb-cloud/byoc/manage-resource-pools-byoc.md b/tidb-cloud/byoc/manage-resource-pools-byoc.md new file mode 100644 index 0000000000000..2a9084257457e --- /dev/null +++ b/tidb-cloud/byoc/manage-resource-pools-byoc.md @@ -0,0 +1,178 @@ +--- +title: Manage Resource Pools +summary: Learn how to view and manage Resource Pools for TiDB Cloud BYOC. +--- + +# Manage Resource Pools + +A Resource Pool represents the underlying physical resources, network, and capacity used by TiDB Cloud BYOC instances. You can use Resource Pool management to view resource usage, manage capacity, update AWS resource tags, and delete unused Resource Pools. + +Resource Pools are organization-level BYOC resources. They are not associated with projects. + +## Required role + +Only users with the `Organization Owner` role can manage Resource Pools. + +Other roles might have read-only access to Resource Pools, but they cannot create, edit, delete, or modify Resource Pools. + +## View Resource Pools + +To view Resource Pools, take the following steps: + +1. In the [TiDB Cloud console](https://tidbcloud.com/), click **BYOC Management** > **Resource Pools** in the left navigation pane. + +2. On the **Resource Pools** page, view the Resource Pool list. + + The list displays information such as the Resource Pool name, status, cloud provider, region, instance count, and creation time. + +3. To filter Resource Pools, use the search box and filters at the top of the page. + +4. To refresh the list, click the refresh icon. + +## Resource Pool statuses + +The following statuses are displayed for Resource Pools: + +- **Creating**: the Resource Pool is being provisioned. You can view basic information, but you cannot create instances or make configuration changes. +- **Active**: the Resource Pool is available. Normal management operations are available. +- **Modifying**: the Resource Pool is being modified. You can view the overview, metrics, instances, tags, and other details, but you cannot update capacity or update the Pool vCPU Limit. + +## View Resource Pool details + +To view Resource Pool details, click the name of a Resource Pool on the **Resource Pools** page. + +The Resource Pool details page includes the following information: + +- **Pool vCPU Usage**: shows the current provisioned TiDB vCPU and additional vCPU provision. +- **Instances in This Pool**: lists the BYOC instances that run in this Resource Pool. +- **Metrics**: shows vCPU usage and physical storage usage trends. +- **Pool Capacity**: shows TiKV and TiFlash capacity information. +- **AWS Resource Tags**: shows AWS tags applied to supported resources in this Resource Pool. + +## View metrics + +The **Metrics** area on the Resource Pool details page provides the following charts: + +- **vCPU Usage Trend**: shows the provisioned TiDB vCPU usage trend for the Resource Pool. The chart also displays the current vCPU value. +- **Physical Storage Usage Trend**: shows the actual physical storage usage trend for the Resource Pool. The chart also displays the current storage value. + +You can select a time range to view historical metrics. By default, metrics for the past 30 days are displayed. + +To refresh the metric data, click **Refresh**. + +If metric data is not available yet, the chart displays **No Data Available Yet**. + +## Update the Pool vCPU Limit + +The Pool vCPU Limit is an optional customer-defined limit for the maximum provisioned TiDB vCPU capacity allowed for a Resource Pool. Additional vCPU provision, such as Admin Nodes and Observability Nodes, is not counted toward this limit. + +To update the Pool vCPU Limit, take the following steps: + +1. Go to the Resource Pool details page. +2. In the **Pool vCPU Usage** area, click **Update vCPU Limit**. +3. In the displayed dialog, turn on or turn off **Setup Limit**. +4. If you turn on **Setup Limit**, enter a new Pool vCPU Limit. +5. If you turn off **Setup Limit**, no customer-defined vCPU limit applies to the Resource Pool, and billing remains based on actual usage. +6. Confirm the update. + +When you set a new Pool vCPU Limit, the value must be greater than or equal to `100` vCPU and the current provisioned TiDB vCPU. Otherwise, the update is rejected. + +If the Resource Pool is in the **Modifying** status, **Update vCPU Limit** is disabled. + +## Update capacity + +You can update the TiKV and TiFlash capacity of a Resource Pool. + +To update capacity, take the following steps: + +1. Go to the Resource Pool details page. +2. In the **Pool Capacity** area, click **Update Capacity**. +3. In the **Update _resource-pool-name_ Capacity** dialog, update TiKV or TiFlash capacity. +4. If a Pool vCPU Limit is configured, review the capacity evaluation. +5. Click **Save**. + +If a Pool vCPU Limit is configured, the dialog displays the following capacity evaluation information: + +- **Current vCPU Usage**: the current provisioned TiDB vCPU usage of the Resource Pool. +- **Scaling vCPU Preview**: the estimated provisioned TiDB vCPU usage after the capacity update. +- **Max vCPU Limit**: the current Pool vCPU Limit. +- **Scale Evaluation**: whether the capacity update is allowed under the current Pool vCPU Limit. + +If no Pool vCPU Limit is configured, the capacity evaluation information is not displayed. + +The following rules apply: + +- Only scale-out operations are supported in the TiDB Cloud console. If you have additional node or size requirements, or if you need to scale in, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). +- TiKV node count must be adjusted in increments of three. +- TiKV storage can only be increased. +- 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). +- TiFlash machine type can be changed online. +- TiFlash storage can only be increased. +- TiFlash node count can only be increased. +- If a Pool vCPU Limit is configured, the **Scaling vCPU Preview** must not exceed the **Max vCPU Limit**. + +If the Resource Pool is in the **Modifying** status, **Update Capacity** is disabled. + +## Manage AWS resource tags + +AWS resource tags are applied to supported AWS resources in the Resource Pool. + +To manage AWS resource tags, take the following steps: + +1. Go to the Resource Pool details page. +2. In the **AWS Resource Tags** area, click **Edit Tags**. +3. Add, edit, or delete tags. +4. Save the changes. + +The following rules apply: + +- Tags are applied to all taggable AWS resources within the Resource Pool. +- Tag keys are required. +- Tag values are optional. +- Tag keys and values are case-sensitive. +- Tag keys must be unique and are checked in a case-sensitive manner. +- Tag key length must be from 1 to 128 UTF-8 characters. +- Tag value length must not exceed 256 UTF-8 characters. +- User-defined tag keys cannot start with `aws:`. +- System-reserved AWS tags cannot be overwritten or edited. +- Empty rows are ignored and not submitted. +- Tags must comply with AWS tagging restrictions. + +## Rename a Resource Pool + +To rename a Resource Pool, take the following steps: + +1. Go to the Resource Pool details page or the **Resource Pools** page. +2. Click **...**. +3. Click **Rename**. +4. Enter a new name and confirm the change. + +Renaming a Resource Pool changes only its display name. It does not modify underlying cloud resource IDs. + +## Delete a Resource Pool + +You can delete a Resource Pool only when it contains no BYOC instances. + +To delete a Resource Pool, take the following steps: + +1. Go to the **Resource Pools** page. +2. Locate the Resource Pool that you want to delete. +3. Click **...** > **Delete**. +4. Enter the Resource Pool name to confirm the deletion. + +Deleting a Resource Pool does not delete historical instance backups. Backup retention and Recycle Bin behavior follow the existing BYOC backup and restore rules. + +## Operation restrictions + +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. +- You can delete an instance if the instance is in a deletable state. +- You cannot update the Pool vCPU Limit. +- You cannot update capacity. + +The backend performs final validation when you submit an operation. If the Resource Pool state changes during the operation, the request might be rejected. diff --git a/tidb-cloud/byoc/multi-region-deployment.md b/tidb-cloud/byoc/multi-region-deployment.md index 4d06b5a4c3933..3ceb3e347a0a1 100644 --- a/tidb-cloud/byoc/multi-region-deployment.md +++ b/tidb-cloud/byoc/multi-region-deployment.md @@ -130,18 +130,21 @@ Before running the update script: 1. Confirm the AWS Regions to be added. 2. Select the Availability Zones for the new regions. -3. Plan the TiDB Cluster CIDR and O11Y CIDR for each new region. +3. Plan the O11Y CIDR for each new region and the Resource Pool CIDRs for Resource Pools that you plan to create. Different regions can use the same O11Y CIDR unless you use Metric Integration to connect Grafana to multiple regions. In that case, use non-overlapping O11Y CIDRs for those regions. 4. Confirm whether each new region will: * share the existing PCA and hosted zones, or * use dedicated PCA and hosted zones. 5. Review and increase AWS service quotas in each new region. 6. Share the information for the new regions with your TiDB Cloud representative. -The CIDR ranges for the new regions must not overlap with: +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. + +Resource Pool CIDRs in different regions can overlap. However, use non-overlapping CIDRs for Resource Pools that require cross-region connectivity or replication. ### Share existing PCA and hosted zones diff --git a/tidb-cloud/manage-projects-and-resources.md b/tidb-cloud/manage-projects-and-resources.md index f6d672d2792c2..b68de60de3ada 100644 --- a/tidb-cloud/manage-projects-and-resources.md +++ b/tidb-cloud/manage-projects-and-resources.md @@ -16,6 +16,12 @@ A TiDB Cloud resource is a deployable unit that you can manage. It can be one of - A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, Premium, or BYOC instance - A {{{ .dedicated }}} cluster + + +In {{{ .byoc }}}, a Resource Pool is an organization-level BYOC resource that provides the underlying physical resources, network, and capacity for BYOC instances. Resource Pools are managed from **BYOC Management** > **Resource Pools** and are not associated with projects. For more information, see [Manage Resource Pools](/tidb-cloud/byoc/manage-resource-pools-byoc.md). + + + ### TiDB Cloud projects In TiDB Cloud, you can use [projects](/tidb-cloud/tidb-cloud-glossary.md#project) to organize and manage your TiDB Cloud resources. diff --git a/tidb-cloud/premium/backup-and-restore-premium.md b/tidb-cloud/premium/backup-and-restore-premium.md index 73a906edcf130..84b342f6ab18a 100644 --- a/tidb-cloud/premium/backup-and-restore-premium.md +++ b/tidb-cloud/premium/backup-and-restore-premium.md @@ -238,7 +238,13 @@ To restore your data to a new {{{ .premium }}} or {{{ 4. Click **Next** to proceed to the **Restore to a New Instance** page. -5. Configure your new {{{ .premium }}} or {{{ .byoc }}} instance for restoration. The steps are the same as [creating a {{{ .premium }}} or {{{ .byoc }}} instance](/tidb-cloud/premium/create-tidb-instance-premium.md). +5. Configure your new {{{ .premium }}} or {{{ .byoc }}} instance for restoration. The steps are the same as [creating a {{{ .premium }}} instance](/tidb-cloud/premium/create-tidb-instance-premium.md)[creating a {{{ .byoc }}} instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md). + + + + For {{{ .byoc }}}, select an active Resource Pool in the same cloud provider and region as the backup. If no suitable Resource Pool is available, an `Organization Owner` can create one before restoring the instance. Other roles cannot create Resource Pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md). + + > **Note:** > @@ -356,7 +362,13 @@ To restore backups from cloud storage, do the following: 3. Click **Verify Backup and Next**. -4. If the verification is successful, the **Restore to a New Instance** page appears. Review the backup information displayed at the top of the page, and then follow the steps in [Create a {{{ .premium }}} or {{{ .byoc }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) to restore the backup to a new instance. +4. If the verification is successful, the **Restore to a New Instance** page appears. Review the backup information displayed at the top of the page, and then follow the steps in [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md)[Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md) to restore the backup to a new instance. + + + + For {{{ .byoc }}}, select an active Resource Pool that matches the target cloud provider and region. If no suitable Resource Pool is available, an `Organization Owner` can create one before restoring the instance. Other roles cannot create Resource Pools. For more information, see [Create a Resource Pool](/tidb-cloud/byoc/create-resource-pool-byoc.md). + + If the backup information is incorrect, click **Previous** to return to the previous page, and then enter the correct information.