diff --git a/tidb-cloud/byoc/create-tidb-instance-byoc.md b/tidb-cloud/byoc/create-tidb-instance-byoc.md new file mode 100644 index 0000000000000..e5add21aa3b3f --- /dev/null +++ b/tidb-cloud/byoc/create-tidb-instance-byoc.md @@ -0,0 +1,58 @@ +--- +title: Create a {{{ .byoc }}} Instance +summary: Learn how to create a {{{ .byoc }}} instance. +--- + +# Create a {{{ .byoc }}} Instance + +This document describes how to create a {{{ .byoc }}} instance in the [TiDB Cloud console](https://tidbcloud.com/). + +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. + +> **Note:** +> +> To learn how to create a {{{ .premium }}} instance, see [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md). + +## Before you begin + +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: + +- 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. + +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). + +## Steps + +If you have the required permissions, you can create a {{{ .byoc }}} instance as follows: + +1. In the [TiDB Cloud console](https://tidbcloud.com/tidbs), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click **Create Resource** in the upper-right corner. + +2. On the **Create Resource** page, click the **Bring Your Own Cloud** tab. + +3. Confirm that **BYOC** is selected as your plan. + + BYOC is powered by TiDB X and is designed for large-scale production workloads. It lets you run the data plane in your own cloud account while using TiDB Cloud for automated operations, elastic scalability, and enterprise-grade security. + +4. In the **Basic Settings** area, enter a name for your {{{ .byoc }}} instance, and then choose a cloud provider and a region where you want to host your instance. + +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. + +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). + +8. Click **Create**. + + The instance creation process begins. Provisioning time can vary depending on the selected region, capacity, and cloud provider. + +## What's next + +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. +- Configure network access from your application environment to the instance endpoint. +- Connect to the instance from your application or SQL client. diff --git a/tidb-cloud/manage-projects-and-resources.md b/tidb-cloud/manage-projects-and-resources.md index 342961e5a89e9..0d7b15e5b8283 100644 --- a/tidb-cloud/manage-projects-and-resources.md +++ b/tidb-cloud/manage-projects-and-resources.md @@ -13,7 +13,7 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can discover, access, a A TiDB Cloud resource is a deployable unit that you can manage. It can be one of the following: -- 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, or Premium instance +- 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 ### TiDB Cloud projects @@ -45,6 +45,12 @@ For more information, see the following documents: - [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) + + +- [Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md) + + + - [Create a {{{ .dedicated }}} Cluster](/tidb-cloud/create-tidb-cluster.md) ### Manage TiDB Cloud resources @@ -97,6 +103,12 @@ To create a new project, take the following steps: > **Note:** > > For {{{ .premium }}} instances, encryption is configured per instance rather than per project. After you create the instance, you can enable [Dual-Layer Data Encryption](/tidb-cloud/premium/dual-layer-data-encryption-premium.md) to add a database-layer encryption on top of the default storage-layer encryption. + > + > + > + > 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. + > + > - If the project is created for {{{ .dedicated }}} clusters, select the **Create for Dedicated Cluster** option, configure [Customer-Managed Encryption Keys (CMEK)](/tidb-cloud/tidb-cloud-encrypt-cmek-aws.md) and [maintenance window](/tidb-cloud/configure-maintenance-window.md) for the project, and then click **Confirm**. diff --git a/tidb-cloud/select-cluster-tier.md b/tidb-cloud/select-cluster-tier.md index 5e14953f81681..5ed2d5a5ae5c0 100644 --- a/tidb-cloud/select-cluster-tier.md +++ b/tidb-cloud/select-cluster-tier.md @@ -1,118 +1,137 @@ ---- -title: Select a Plan -summary: Learn how to select a plan on TiDB Cloud. -aliases: ['/tidbcloud/developer-tier-cluster'] ---- - -# Select Your Plan - -The plan determines the throughput and performance of your TiDB resource. - -TiDB Cloud provides the following options of plans. Whether you are just getting started or scaling to meet the increasing application demands, these service plans provide the flexibility and capability you need. Before creating a TiDB resource, you need to consider which option suits your need better. - -- [TiDB Cloud Starter](#starter) -- [{{{ .essential }}}](#essential) -- [{{{ .premium }}}](#premium) -- [TiDB Cloud Dedicated](#tidb-cloud-dedicated) - -> **Note:** -> -> Some of TiDB Cloud features are partially supported or not supported on {{{ .starter }}} and {{{ .essential }}}. See [{{{ .starter }}} and Essential Limitations](/tidb-cloud/serverless-limitations.md) for details. - -## {{{ .starter }}} {#starter} - -TiDB Cloud Starter is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free quota and consumption based billing once free limits are exceeded. - -The free plan is ideal for those who are getting started with {{{ .starter }}}. It provides developers and small teams with the following essential features: - -- **No cost**: This plan is free when usage is within the [free quota](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). No credit card is required to get started. - -- **Storage**: Provides an initial 5 GiB of row-based storage and 5 GiB of columnar storage. -- **Request Units**: Includes 50 million [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru) for database operations. - -### Usage quota - -For each organization in TiDB Cloud, you can create a maximum of five free {{{ .starter }}} instances by default. To create more {{{ .starter }}} instances, you need to add a credit card and specify a spending limit. - -For the first five {{{ .starter }}} instances in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: - -- Row-based storage: 5 GiB -- Columnar storage: 5 GiB -- Request Units (RUs): 50 million RUs per month - -A Request Unit (RU) is a unit of measure used to represent the amount of resources consumed by a single request to the database. The amount of RUs consumed by a request depends on various factors, such as the operation type or the amount of data being retrieved or modified. - -Once a {{{ .starter }}} instance reaches its usage quota, it immediately denies any new connection attempts until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spending-limit) or the usage is reset upon the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. For example, when the row-based storage of a {{{ .starter }}} instance exceeds 5 GiB for a free {{{ .starter }}} instance, the instance automatically restricts any new connection attempts. - -To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). - -### Instance Capacity Plan - -For each organization in TiDB Cloud, you can create a maximum of five [branches](/tidb-cloud/branch-overview.md) across all {{{ .starter }}} and Essential instances by default. - -For each paid organization in TiDB Cloud, you can create up to 100 {{{ .starter }}} instances and branches in total, with each branch counted as a separate instance. - -For paid organizations building agent platforms or other services that require a large number of instances and branches, TiDB Cloud offers the **Instance Capacity Plan**. With this plan, each paid TiDB Cloud organization can create more than five branches and is not subject to the limit of 100 {{{ .starter }}} instances and branches. To learn more and apply for the Instance Capacity Plan, fill out the [application form](https://www.pingcap.com/programs/agentic-ai-instance-capacity). - -You will receive an email notification once your application for the TiDB Cloud Instance Capacity Plan is approved. - -## {{{ .essential }}} {#essential} - -For applications experiencing growing workloads and needing scalability in real time, the Essential plan provides the flexibility and performance to keep pace with your business growth with the following features: - -- **Enhanced capabilities**: includes all capabilities of the Starter plan, along with the capacity to handle larger and more complex workloads, as well as advanced security features. -- **Automatic scaling**: automatically adjusts storage and computing resources to efficiently meet changing workload demands. -- **High availability**: built-in fault tolerance and redundancy ensure your applications remain available and resilient, even during infrastructure failures. -- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs) of the compute resources, offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. - -## User name prefix - - - -For each {{{ .starter }}} or {{{ .essential }}} instance, TiDB Cloud generates a unique prefix to distinguish it from other instances. - -Whenever you use or set a database user name, you must include the prefix in the user name. For example, assume that the prefix of your {{{ .starter }}} or {{{ .essential }}} instance is `3pTAoNNegb47Uc8`. - -- To connect to your {{{ .starter }}} or {{{ .essential }}} instance: - - ```shell - mysql -u '3pTAoNNegb47Uc8.root' -h -P 4000 -D test --ssl-mode=VERIFY_IDENTITY --ssl-ca= -p - ``` - - > **Note:** - > - > {{{ .starter }}} and {{{ .essential }}} require TLS connection. To find the CA root path on your system, see [Root certificate default path](/tidb-cloud/secure-connections-to-serverless-clusters.md#root-certificate-default-path). - -- To create a database user: - - ```sql - CREATE USER '3pTAoNNegb47Uc8.jeffrey'; - ``` - -To get the prefix for your {{{ .starter }}} or {{{ .essential }}} instance, take the following steps: - -1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. -2. Click the name of your target {{{ .starter }}} or Essential instance to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. -3. In the dialog, get the prefix from the connection string. - -## {{{ .premium }}} {#premium} - -For mission-critical enterprise workloads that require large-scale capacity and consistent high performance, the Premium plan provides a cloud-native experience with the following features: - -- **Instant elasticity**: automatically scales compute resources to absorb sudden traffic spikes and maintain stable performance during peak demand. -- **Unlimited scalability**: expands storage and throughput to keep pace with business growth, without physical infrastructure constraints. -- **Zero-infrastructure management**: offers a fully managed service that eliminates manual scaling, patching, and capacity planning. -- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs), offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. -- **Advanced security and compliance**: supports advanced encryption, customer-managed encryption keys (CMEK), private networking, and compliance certifications to protect sensitive data. - -## TiDB Cloud Dedicated - -TiDB Cloud Dedicated is for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing). - -For TiDB Cloud Dedicated clusters, you can customize the cluster size of TiDB, TiKV, and TiFlash easily according to your business need. For each TiKV node and TiFlash node, the data on the node is replicated and distributed in different availability zones for [high availability](/tidb-cloud/high-availability-with-multi-az.md). - -To create a TiDB Cloud Dedicated cluster, you need to [add a payment method](/tidb-cloud/tidb-cloud-billing.md#payment-method) or [apply for a Proof of Concept (PoC) trial](/tidb-cloud/tidb-cloud-poc.md). - -> **Note:** -> -> You cannot decrease the node storage after your TiDB Cloud Dedicated cluster is created. +--- +title: Select a Plan +summary: Learn how to select a plan on TiDB Cloud. +aliases: ['/tidbcloud/developer-tier-cluster'] +--- + +# Select Your Plan + +The plan determines the throughput and performance of your TiDB resource. + +TiDB Cloud provides the following options of plans. Whether you are just getting started or scaling to meet the increasing application demands, these service plans provide the flexibility and capability you need. Before creating a TiDB resource, you need to consider which option suits your need better. + +- [TiDB Cloud Starter](#starter) +- [{{{ .essential }}}](#essential) +- [{{{ .premium }}}](#premium) + +- [{{{ .byoc }}}](#byoc) + +- [TiDB Cloud Dedicated](#tidb-cloud-dedicated) + +> **Note:** +> +> Some of TiDB Cloud features are partially supported or not supported on {{{ .starter }}} and {{{ .essential }}}. See [{{{ .starter }}} and Essential Limitations](/tidb-cloud/serverless-limitations.md) for details. + +## {{{ .starter }}} {#starter} + +TiDB Cloud Starter is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free quota and consumption based billing once free limits are exceeded. + +The free plan is ideal for those who are getting started with {{{ .starter }}}. It provides developers and small teams with the following essential features: + +- **No cost**: This plan is free when usage is within the [free quota](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). No credit card is required to get started. + +- **Storage**: Provides an initial 5 GiB of row-based storage and 5 GiB of columnar storage. +- **Request Units**: Includes 50 million [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru) for database operations. + +### Usage quota + +For each organization in TiDB Cloud, you can create a maximum of five free {{{ .starter }}} instances by default. To create more {{{ .starter }}} instances, you need to add a credit card and specify a spending limit. + +For the first five {{{ .starter }}} instances in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: + +- Row-based storage: 5 GiB +- Columnar storage: 5 GiB +- Request Units (RUs): 50 million RUs per month + +A Request Unit (RU) is a unit of measure used to represent the amount of resources consumed by a single request to the database. The amount of RUs consumed by a request depends on various factors, such as the operation type or the amount of data being retrieved or modified. + +Once a {{{ .starter }}} instance reaches its usage quota, it immediately denies any new connection attempts until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spending-limit) or the usage is reset upon the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. For example, when the row-based storage of a {{{ .starter }}} instance exceeds 5 GiB for a free {{{ .starter }}} instance, the instance automatically restricts any new connection attempts. + +To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). + +### Instance Capacity Plan + +For each organization in TiDB Cloud, you can create a maximum of five [branches](/tidb-cloud/branch-overview.md) across all {{{ .starter }}} and Essential instances by default. + +For each paid organization in TiDB Cloud, you can create up to 100 {{{ .starter }}} instances and branches in total, with each branch counted as a separate instance. + +For paid organizations building agent platforms or other services that require a large number of instances and branches, TiDB Cloud offers the **Instance Capacity Plan**. With this plan, each paid TiDB Cloud organization can create more than five branches and is not subject to the limit of 100 {{{ .starter }}} instances and branches. To learn more and apply for the Instance Capacity Plan, fill out the [application form](https://www.pingcap.com/programs/agentic-ai-instance-capacity). + +You will receive an email notification once your application for the TiDB Cloud Instance Capacity Plan is approved. + +## {{{ .essential }}} {#essential} + +For applications experiencing growing workloads and needing scalability in real time, the Essential plan provides the flexibility and performance to keep pace with your business growth with the following features: + +- **Enhanced capabilities**: includes all capabilities of the Starter plan, along with the capacity to handle larger and more complex workloads, as well as advanced security features. +- **Automatic scaling**: automatically adjusts storage and computing resources to efficiently meet changing workload demands. +- **High availability**: built-in fault tolerance and redundancy ensure your applications remain available and resilient, even during infrastructure failures. +- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs) of the compute resources, offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. + +## User name prefix + + + +For each {{{ .starter }}} or {{{ .essential }}} instance, TiDB Cloud generates a unique prefix to distinguish it from other instances. + +Whenever you use or set a database user name, you must include the prefix in the user name. For example, assume that the prefix of your {{{ .starter }}} or {{{ .essential }}} instance is `3pTAoNNegb47Uc8`. + +- To connect to your {{{ .starter }}} or {{{ .essential }}} instance: + + ```shell + mysql -u '3pTAoNNegb47Uc8.root' -h -P 4000 -D test --ssl-mode=VERIFY_IDENTITY --ssl-ca= -p + ``` + + > **Note:** + > + > {{{ .starter }}} and {{{ .essential }}} require TLS connection. To find the CA root path on your system, see [Root certificate default path](/tidb-cloud/secure-connections-to-serverless-clusters.md#root-certificate-default-path). + +- To create a database user: + + ```sql + CREATE USER '3pTAoNNegb47Uc8.jeffrey'; + ``` + +To get the prefix for your {{{ .starter }}} or {{{ .essential }}} instance, take the following steps: + +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. Click the name of your target {{{ .starter }}} or Essential instance to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. +3. In the dialog, get the prefix from the connection string. + +## {{{ .premium }}} {#premium} + +For mission-critical enterprise workloads that require large-scale capacity and consistent high performance, the Premium plan provides a cloud-native experience with the following features: + +- **Instant elasticity**: automatically scales compute resources to absorb sudden traffic spikes and maintain stable performance during peak demand. +- **Unlimited scalability**: expands storage and throughput to keep pace with business growth, without physical infrastructure constraints. +- **Zero-infrastructure management**: offers a fully managed service that eliminates manual scaling, patching, and capacity planning. +- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs), offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. +- **Advanced security and compliance**: supports advanced encryption, customer-managed encryption keys (CMEK), private networking, and compliance certifications to protect sensitive data. + + + +## {{{ .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. + +{{{ .byoc }}} provides a managed TiDB Cloud experience with the following features: + +- **Customer-owned data plane**: keeps TiDB service resources, storage, networking, and data in your cloud account. +- **Managed operations**: uses TiDB Cloud for deployment, scaling, monitoring, upgrades, backup and restore, and lifecycle management. +- **Flexible high availability**: supports both Single-AZ and Multi-AZ deployments, enabling you to choose between lower-latency zonal deployment and higher-resilience deployment across multiple availability zones. +- **Cloud-account-level security controls**: lets you apply your own cloud policies, network controls, audit logging, and compliance controls to the BYOC data plane. +- **Private connectivity**: supports private network access patterns such as VPC peering, depending on your BYOC configuration. + + + +## TiDB Cloud Dedicated + +TiDB Cloud Dedicated is for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing). + +For TiDB Cloud Dedicated clusters, you can customize the cluster size of TiDB, TiKV, and TiFlash easily according to your business need. For each TiKV node and TiFlash node, the data on the node is replicated and distributed in different availability zones for [high availability](/tidb-cloud/high-availability-with-multi-az.md). + +To create a TiDB Cloud Dedicated cluster, you need to [add a payment method](/tidb-cloud/tidb-cloud-billing.md#payment-method) or [apply for a Proof of Concept (PoC) trial](/tidb-cloud/tidb-cloud-poc.md). + +> **Note:** +> +> You cannot decrease the node storage after your TiDB Cloud Dedicated cluster is created.