From 0eb7308c39532497928dfd83b9dd11b883602388 Mon Sep 17 00:00:00 2001 From: Cheng Weiwei <65707268+wildpcww@users.noreply.github.com> Date: Wed, 22 Jul 2026 15:07:20 +0800 Subject: [PATCH] update doc titles --- TOC-tidb-cloud-byoc.md | 8 +- tidb-cloud/byoc/byoc-onboarding-overview.md | 10 +- .../premium/backup-and-restore-premium.md | 115 +++++++++++++++--- ...ect-to-premium-via-aws-private-endpoint.md | 32 ++--- ...onnect-to-premium-via-public-connection.md | 20 ++- .../premium/connect-to-tidb-instance.md | 12 +- tidb-cloud/premium/delete-tidb-instance.md | 10 +- tidb-cloud/premium/premium-export.md | 26 ++-- tidb-cloud/tidb-cloud-billing.md | 8 ++ tidb-cloud/tidb-cloud-support.md | 12 ++ 10 files changed, 179 insertions(+), 74 deletions(-) diff --git a/TOC-tidb-cloud-byoc.md b/TOC-tidb-cloud-byoc.md index 5d61a9a90c6eb..3adec18632b9f 100644 --- a/TOC-tidb-cloud-byoc.md +++ b/TOC-tidb-cloud-byoc.md @@ -41,13 +41,12 @@ - [Multi-Region Deployment](/tidb-cloud/byoc/multi-region-deployment.md) - Manage Instances - [Create a {{{ .byoc }}} Instance](/tidb-cloud/byoc/create-tidb-instance-byoc.md) - - Connect to Your {{{ .premium }}} Instance + - Connect to Your {{{ .byoc }}} Instance - [Connection Overview](/tidb-cloud/premium/connect-to-tidb-instance.md) - [Connect via Public Endpoint](/tidb-cloud/premium/connect-to-premium-via-public-connection.md) - [Connect via Private Endpoint with AWS](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md) - - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md) - [Back Up and Restore TiDB Cloud Data](/tidb-cloud/premium/backup-and-restore-premium.md) - - [Export Data from {{{ .premium }}}](/tidb-cloud/premium/premium-export.md) + - [Export Data from {{{ .byoc }}}](/tidb-cloud/premium/premium-export.md) - Use TiFlash for HTAP - [TiFlash Overview](/tiflash/tiflash-overview.md) - [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md) @@ -62,9 +61,7 @@ - Monitor and Alert - [Overview](/tidb-cloud/monitor-tidb-cluster.md) - [Built-in Metrics](/tidb-cloud/premium/built-in-monitoring-premium.md) - - [Top RU](/tidb-cloud/top-ru.md) - [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md) - - [Integrate TiDB Cloud with Prometheus and Grafana](/tidb-cloud/prometheus-grafana-integration.md) - Subscribe to Alert Notifications - [Subscribe via Email](/tidb-cloud/monitor-alert-email.md) - [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md) @@ -161,7 +158,6 @@ - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md) - [TLS Connections to TiDB Cloud](/tidb-cloud/premium/tidb-cloud-tls-connect-to-premium.md) - Data Access Control - - [Dual-Layer Data Encryption](/tidb-cloud/premium/dual-layer-data-encryption-premium.md) - [User-Controlled Log Redaction](/tidb-cloud/tidb-cloud-log-redaction.md) - Audit Management - [Database Audit Logging](/tidb-cloud/premium/tidb-cloud-auditing-premium.md) diff --git a/tidb-cloud/byoc/byoc-onboarding-overview.md b/tidb-cloud/byoc/byoc-onboarding-overview.md index 6443b6dc89c1c..b4c4d038401b4 100644 --- a/tidb-cloud/byoc/byoc-onboarding-overview.md +++ b/tidb-cloud/byoc/byoc-onboarding-overview.md @@ -15,11 +15,11 @@ The TiDB Cloud BYOC deployment process is a collaborative effort between your or | Phase | Responsibility | Description | | :---- | :---- | :---- | -| [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-iam-configuration.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 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-service-initialization.md) | **Customer** | Create your TiDB instance via the console. Subsequently, deploy the Bastion Host 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. | +| [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-iam-configuration.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 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-service-initialization.md) | Customer | Create your TiDB instance via the console. Subsequently, deploy the Bastion Host 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/premium/backup-and-restore-premium.md b/tidb-cloud/premium/backup-and-restore-premium.md index 088314a18a203..e918a3cbc6a99 100644 --- a/tidb-cloud/premium/backup-and-restore-premium.md +++ b/tidb-cloud/premium/backup-and-restore-premium.md @@ -4,20 +4,24 @@ summary: Learn how to back up and restore your {{{ .premium }}} instances. aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] --- -# Back Up and Restore {{{ .premium }}} Data +# Back Up and Restore {{{ .premium }}} or {{{ .byoc }}} Data + + This document describes how to back up and restore your data on {{{ .premium }}} instances. {{{ .premium }}} supports both automatic backups and manual backups, and lets you restore backup data to a new instance as needed. + + -This document also applies to {{{ .byoc }}}. Backup and restore capabilities for {{{ .byoc }}} are currently consistent with {{{ .premium }}}. +This document describes how to back up and restore your data on {{{ .premium }}} or {{{ .byoc }}} instances. {{{ .premium }}} and {{{ .byoc }}} support both automatic backups and manual backups, and let you restore backup data to a new instance as needed. Backup files can originate from the following sources: -- Active {{{ .premium }}} instances -- The Recycle Bin for backups from deleted {{{ .premium }}} instances +- Active {{{ .premium }}} or {{{ .byoc }}} instances +- The Recycle Bin for backups from deleted {{{ .premium }}} or {{{ .byoc }}} instances > **Tip:** > @@ -26,7 +30,7 @@ Backup files can originate from the following sources: ## View the Backup page -1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .premium }}} instance to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page. > **Tip:** > @@ -36,11 +40,21 @@ Backup files can originate from the following sources: ## Automatic backups + + {{{ .premium }}} provides enhanced automatic backup capabilities for production environments. It combines high-frequency snapshots with log backups to ensure data reliability. + + + + +{{{ .premium }}} and {{{ .byoc }}} provide enhanced automatic backup capabilities for production environments. They combine high-frequency snapshots with log backups to ensure data reliability. + + + ### Automatic backup policies -{{{ .premium }}} instances use a multi-layer backup architecture to protect your data, as described in the following table: +{{{ .premium }}} or {{{ .byoc }}} instances use a multi-layer backup architecture to protect your data, as described in the following table: | Backup type | Retention period | Restore granularity | | --- | --- | --- | @@ -50,7 +64,7 @@ Backup files can originate from the following sources: ### Backup execution rules -- **Backup cycle**: {{{ .premium }}} instances perform both hourly and daily automatic backups. +- **Backup cycle**: {{{ .premium }}} or {{{ .byoc }}} instances perform both hourly and daily automatic backups. - **Backup schedule**: @@ -67,7 +81,7 @@ Backup files can originate from the following sources: ### Delete backup files -To delete an existing backup file for your {{{ .premium }}} instance, perform the following steps: +To delete an existing backup file for your {{{ .premium }}} or {{{ .byoc }}} instance, perform the following steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your instance. @@ -75,8 +89,18 @@ To delete an existing backup file for your {{{ .premium }}} instance, perform th ## Manual backups + + In addition to automatic backups, {{{ .premium }}} supports manual backups. A manual backup provides a controlled, guaranteed restore point. It is highly recommended that you create a manual backup before you perform high-risk operations such as system upgrades, critical data deletion, or irreversible schema or configuration changes. + + + + +In addition to automatic backups, {{{ .premium }}} and {{{ .byoc }}} support manual backups. A manual backup provides a controlled, guaranteed restore point. It is highly recommended that you create a manual backup before you perform high-risk operations such as system upgrades, critical data deletion, or irreversible schema or configuration changes. + + + ### Key characteristics - **Retention and deletion**: unlike automatic backups, manual backups are not automatically deleted based on retention policies. They are retained until you explicitly delete them. If you delete the instance, its manual backups move to the recycle bin and remain there until you manually delete them. @@ -111,15 +135,15 @@ TiDB Cloud supports snapshot restore and point-in-time restore for your instance - **Point-in-Time Restore**: restores your instance to a specific point in time. - - Premium instances: can be restored to any time within the last 7 days, but not earlier than the instance creation time or later than one minute before the current time. Note that PITR is not supported for manual backups. + - Premium or BYOC instances: can be restored to any time within the last 7 days, but not earlier than the instance creation time or later than one minute before the current time. Note that PITR is not supported for manual backups. ### Restore destination TiDB Cloud supports restoring data to a new instance. -### Restore to a new {{{ .premium }}} instance {#restore-to-a-new-instance} +### Restore to a new {{{ .premium }}} or {{{ .byoc }}} instance {#restore-to-a-new-instance} -To restore your data to a new {{{ .premium }}} instance, take the following steps: +To restore your data to a new {{{ .premium }}} or {{{ .byoc }}} instance, take the following steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your instance. @@ -138,7 +162,7 @@ To restore your data to a new {{{ .premium }}} instance, take the following step
- To restore to a specific point in time for a Premium instance, take the following steps: + To restore to a specific point in time for a Premium or BYOC instance, take the following steps: 1. Click **Point-in-Time Restore**. 2. Select the date and time you want to restore to. @@ -148,7 +172,7 @@ To restore your data to a new {{{ .premium }}} instance, take the following step 4. Click **Next** to proceed to the **Restore to a New Instance** page. -5. Configure your new {{{ .premium }}} instance for restoration. The steps are the same as [creating a {{{ .premium }}} 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 }}} or {{{ .byoc }}} instance](/tidb-cloud/premium/create-tidb-instance-premium.md). > **Note:** > @@ -160,7 +184,7 @@ To restore your data to a new {{{ .premium }}} instance, take the following step ### Restore from Recycle Bin -To restore a deleted {{{ .premium }}} instance from the Recycle Bin, take the following steps: +To restore a deleted {{{ .premium }}} or {{{ .byoc }}} instance from the Recycle Bin, take the following steps: 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page of your organization, click **...** in the upper-right corner, and then click **Recycle Bin**. @@ -199,7 +223,19 @@ To restore a backup generated by a {{{ .dedicated }}} cluster, follow these step ### Restore backups from cloud storage -{{{ .premium }}}{{{ .byoc }}} supports restoring backups from cloud storage (such as Amazon S3 and Alibaba Cloud Object Storage Service (OSS)) to a new instance. This feature is compatible with backups generated from {{{ .dedicated }}} clusters or TiDB Self-Managed clusters. + + +{{{ .premium }}} supports restoring backups from cloud storage (such as Amazon S3 and Alibaba Cloud Object Storage Service (OSS)) to a new instance. This feature is compatible with backups generated from {{{ .dedicated }}} clusters or TiDB Self-Managed clusters. + + + + + +{{{ .premium }}} or {{{ .byoc }}} support restoring backups from cloud storage (such as Amazon S3) to a new instance. This feature is compatible with backups generated from {{{ .dedicated }}} clusters or TiDB Self-Managed clusters. + + + + >**Note:** > @@ -207,6 +243,18 @@ To restore a backup generated by a {{{ .dedicated }}} cluster, follow these step > - You can restore backups only to a new instance hosted by the same cloud provider as your storage bucket. > - If the instance and the storage bucket are located in different regions, additional cross-region data transfer fees might apply. + + + + +>**Note:** +> +> - Currently, only backups located in **Amazon S3** are supported for restore. +> - You can restore backups only to a new instance hosted by the same cloud provider as your storage bucket. +> - If the instance and the storage bucket are located in different regions, additional cross-region data transfer fees might apply. + + + #### Steps Before you begin, ensure that you have an access key and secret key with sufficient permissions to access the backup files. @@ -218,18 +266,35 @@ To restore backups from cloud storage, do the following: 2. On the **Select Backup Storage Location** page, provide the following information: - **Cloud Provider**: select the cloud provider where your backup files are stored. + + - **Region**: if your cloud provider is Alibaba Cloud OSS, select a region. + + + - **Backup Files URI**: enter the URI of the top-level folder that contains your backup files. - **Access Key ID**: enter your access key ID. - **Access Key Secret**: enter your access key secret. + + > **Tip:** > > To create an access key for your storage bucket, see [Configure Amazon S3 access using an AWS access key](#configure-amazon-s3-access-using-an-aws-access-key) and [Configure Alibaba Cloud OSS access](#configure-alibaba-cloud-oss-access). + + + + + > **Tip:** + > + > To create an access key for your storage bucket, see [Configure Amazon S3 access using an AWS access key](#configure-amazon-s3-access-using-an-aws-access-key). + + + 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 }}} 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 }}} or {{{ .byoc }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) to restore the backup to a new instance. If the backup information is incorrect, click **Previous** to return to the previous page, and then enter the correct information. @@ -237,8 +302,18 @@ To restore backups from cloud storage, do the following: ## References + + This section describes how to configure access for Amazon S3 and Alibaba Cloud OSS. + + + + +This section describes how to configure access for Amazon S3. + + + ### Configure Amazon S3 access using an AWS access key It is recommended that you use an IAM user, rather than the AWS account root user, to create an access key. @@ -253,7 +328,7 @@ Take the following steps to configure an access key: 2. Grant permissions to the IAM user. - Create a policy with only the permissions required for your task and attach it to the IAM user. To restore data to a {{{ .premium }}} instance, grant the `s3:GetObject`, `s3:GetBucketLocation`, and `s3:ListBucket` permissions. + Create a policy with only the permissions required for your task and attach it to the IAM user. To restore data to a {{{ .premium }}} or {{{ .byoc }}} instance, grant the `s3:GetObject`, `s3:GetBucketLocation`, and `s3:ListBucket` permissions. The following is an example policy that allows TiDB Cloud to restore data from a specific folder in your Amazon S3 bucket. @@ -294,6 +369,8 @@ Take the following steps to configure an access key: > > TiDB Cloud does not store your access keys. To maintain security, [delete the access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) after the import or export task is complete. + + ### Configure Alibaba Cloud OSS access To grant TiDB Cloud access to your Alibaba Cloud OSS bucket, you need to create an AccessKey pair for the bucket. @@ -312,7 +389,7 @@ Take the following steps to configure an AccessKey pair: > **Tip:** > - > To enhance security for restore operations, you can restrict access to the specific folder (`oss:Prefix`) where your backup files are stored rather than granting access to the entire bucket. + > To enhance security for restore operations, you can restrict access to the specific folder (`oss:Prefix`) where your backup files are stored rather than granting access to the entire bucket. The following JSON example shows a policy for a restore task. This policy restricts access to a specific bucket and backup folder. @@ -344,3 +421,5 @@ Take the following steps to configure an AccessKey pair: 3. Attach the custom policies to the RAM user. For more information, see [Grant permissions to a RAM user](https://www.alibabacloud.com/help/en/ram/user-guide/grant-permissions-to-the-ram-user). + + diff --git a/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md b/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md index 461d913ab14c0..1e3ca818752a1 100644 --- a/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md +++ b/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md @@ -3,9 +3,9 @@ title: Connect to {{{ .premium }}} via AWS PrivateLink summary: Learn how to connect to your {{{ .premium }}} instance via private endpoint with AWS. --- -# Connect to {{{ .premium }}} via AWS PrivateLink +# Connect to {{{ .premium }}} or {{{ .byoc }}} via AWS PrivateLink -This document describes how to connect to your {{{ .premium }}} instance via [AWS PrivateLink](https://aws.amazon.com/privatelink). +This document describes how to connect to your {{{ .premium }}} or {{{ .byoc }}} instance via [AWS PrivateLink](https://aws.amazon.com/privatelink). > **Tip:** > @@ -27,7 +27,7 @@ For more detailed definitions of the private endpoint and endpoint service, see ## Restrictions - Only users with the `Organization Owner` role can create private endpoint connections. -- The private endpoint and the {{{ .premium }}} instance you want to connect to must be located in the same region. +- The private endpoint and the {{{ .premium }}} or {{{ .byoc }}} instance you want to connect to must be located in the same region. ## Prerequisites @@ -35,19 +35,19 @@ Make sure that DNS hostnames and DNS resolution are both enabled in your AWS VPC ## Set up a private endpoint connection and connect to your instance -To connect to your {{{ .premium }}} instance via a private endpoint, follow these steps: +To connect to your {{{ .premium }}} or {{{ .byoc }}} instance via a private endpoint, follow these steps: -1. [Select a {{{ .premium }}} instance](#step-1-select-a-premium-instance) +1. [Select a {{{ .premium }}} or {{{ .byoc }}} instance](#step-1-select-a-premium-instance) 2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint) 3. [Create a private endpoint connection](#step-3-create-a-private-endpoint-connection) 4. [Enable private DNS](#step-4-enable-private-dns) -5. [Connect to your {{{ .premium }}} instance](#step-5-connect-to-your-premium-instance) +5. [Connect to your {{{ .premium }}} or {{{ .byoc }}} instance](#step-5-connect-to-your-premium-instance) If you have multiple instances, you need to repeat these steps for each instance that you want to connect to using AWS PrivateLink. -### Step 1. Select a {{{ .premium }}} instance {#step-1-select-a-premium-instance} +### Step 1. Select a {{{ .premium }}} or {{{ .byoc }}} instance {#step-1-select-a-premium-instance} -1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page of your TiDB Cloud console, click the name of your target {{{ .premium }}} instance to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page of your TiDB Cloud console, click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the **Connection Type** drop-down list, select **Private Endpoint**, and then click **Create Private Endpoint Connection**. @@ -59,7 +59,7 @@ If you have multiple instances, you need to repeat these steps for each instance > **Note:** > -> For each {{{ .premium }}} instance, the corresponding endpoint service is automatically created 3 to 4 minutes after the instance creation. +> For each {{{ .premium }}} or {{{ .byoc }}} instance, the corresponding endpoint service is automatically created 3 to 4 minutes after the instance creation. If you see the `TiDB Private Link Service is ready` message, the corresponding endpoint service is ready. You can provide the following information to create the endpoint. @@ -84,7 +84,7 @@ To use the AWS CLI to create a VPC interface endpoint, perform the following ste > > - Before running the command, you need to have AWS CLI installed and configured. See [AWS CLI configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html) for details. > -> - If your service spans across more than three availability zones (AZs), you will get an error message indicating that the VPC endpoint service does not support the AZ of the subnet. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .premium }}} instance is located. In this case, you can contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support). +> - If your service spans across more than three availability zones (AZs), you will get an error message indicating that the VPC endpoint service does not support the AZ of the subnet. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .premium }}} or {{{ .byoc }}} instance is located. In this case, you can contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support).
@@ -102,11 +102,11 @@ To use the AWS Management Console to create a VPC interface endpoint, perform th 4. In the **Service settings** area, enter the service name `${your_endpoint_service_name}` from the generated command (`--service-name ${your_endpoint_service_name}`). 5. Click **Verify service**. 6. In the **Network settings** area, select your VPC in the drop-down list. -7. In the **Subnets** area, select the availability zones where your {{{ .premium }}} instance is located. +7. In the **Subnets** area, select the availability zones where your {{{ .premium }}} or {{{ .byoc }}} instance is located. > **Tip:** > - > If your service spans across more than three availability zones (AZs), you might not be able to select AZs in the **Subnets** area. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .premium }}} instance is located. In this case, contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support). + > If your service spans across more than three availability zones (AZs), you might not be able to select AZs in the **Subnets** area. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .premium }}} or {{{ .byoc }}} instance is located. In this case, contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support). 8. In the **Security groups** area, select your security group properly. @@ -127,7 +127,7 @@ To use the AWS Management Console to create a VPC interface endpoint, perform th > **Tip:** > -> You can view and manage private endpoint connections on the **Networking** page of your target {{{ .premium }}} instance. To access this page, click **Settings** > **Networking** in the left navigation pane. +> You can view and manage private endpoint connections on the **Networking** page of your target {{{ .premium }}} or {{{ .byoc }}} instance. To access this page, click **Settings** > **Networking** in the left navigation pane. ### Step 4. Enable private DNS @@ -159,7 +159,7 @@ To enable private DNS in your AWS Management Console:
-### Step 5. Connect to your {{{ .premium }}} instance {#step-5-connect-to-your-premium-instance} +### Step 5. Connect to your {{{ .premium }}} or {{{ .byoc }}} instance {#step-5-connect-to-your-premium-instance} After you have accepted the private endpoint connection, you are redirected back to the connection dialog. @@ -175,7 +175,7 @@ After you have accepted the private endpoint connection, you are redirected back When you use private endpoint connections, the statuses of private endpoints and private endpoint services are displayed on the instance-level **Networking** page: -1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page of your organization, and then click the name of your target {{{ .premium }}} instance to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page of your organization, and then click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page. 2. Click **Settings** > **Networking** in the left navigation pane. The possible statuses of a private endpoint are explained as follows: @@ -194,7 +194,7 @@ The possible statuses of a private endpoint service are explained as follows: ## Troubleshooting -### I cannot connect to a {{{ .premium }}} instance via a private endpoint after enabling private DNS. Why? +### I cannot connect to a {{{ .premium }}} or {{{ .byoc }}} instance via a private endpoint after enabling private DNS. Why? You might need to properly set the security group for your VPC endpoint in the AWS Management Console. To do so, go to **VPC** > **Endpoints**, right-click your VPC endpoint, and select **Manage security groups**. Ensure that the selected security group allows inbound access from your EC2 instances on port `4000` or a customer-defined port. diff --git a/tidb-cloud/premium/connect-to-premium-via-public-connection.md b/tidb-cloud/premium/connect-to-premium-via-public-connection.md index 502cbb45b4725..aa8d1909bb44d 100644 --- a/tidb-cloud/premium/connect-to-premium-via-public-connection.md +++ b/tidb-cloud/premium/connect-to-premium-via-public-connection.md @@ -3,9 +3,9 @@ title: Connect to {{{ .premium }}} via Public Connection summary: Learn how to connect to your {{{ .premium }}} via public connection. --- -# Connect to {{{ .premium }}} via Public Connection +# Connect to {{{ .premium }}} or {{{ .byoc }}} via Public Connection -This document describes how to connect to your {{{ .premium }}} instance via public connection. The public connection exposes a public endpoint with traffic filters, so you can connect to your {{{ .premium }}} instance via a SQL client from your laptop. +This document describes how to connect to your {{{ .premium }}} or {{{ .byoc }}} instance via public connection. The public connection exposes a public endpoint with traffic filters, so you can connect to your {{{ .premium }}} or {{{ .byoc }}} instance via a SQL client from your laptop. > **Tip:** > @@ -14,11 +14,11 @@ This document describes how to connect to your {{{ .premium }}} instance via pub ## Prerequisite: Configure IP access list -For public connections, {{{ .premium }}} only allows client connections from addresses in the IP access list. If you have not configured the IP access list, follow the steps in [Configure an IP Access List](/tidb-cloud/premium/configure-ip-access-list-premium.md) to configure it before your first connection. +For public connections, {{{ .premium }}} or {{{ .byoc }}} only allows client connections from addresses in the IP access list. If you have not configured the IP access list, follow the steps in [Configure an IP Access List](/tidb-cloud/premium/configure-ip-access-list-premium.md) to configure it before your first connection. ## Connect to the instance -To connect to a {{{ .premium }}} instance via public connection, take the following steps: +To connect to a {{{ .premium }}} or {{{ .byoc }}} instance via public connection, take the following steps: 1. Open the overview page of the target instance. @@ -36,10 +36,20 @@ To connect to a {{{ .premium }}} instance via public connection, take the follow If you have not configured the IP access list, click **Configure IP Access List** or follow the steps in [Configure an IP Access List](/tidb-cloud/premium/configure-ip-access-list-premium.md) to configure it before your first connection. + + 4. Click **CA cert** to download CA cert for TLS connection to {{{ .premium }}} instances. The CA cert supports TLS 1.2 by default. 5. Choose your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your instance. + + + + +4. Choose your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your instance. + + + ## What's next -After you have successfully connected to your {{{ .premium }}} instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). +After you have successfully connected to your {{{ .premium }}} or {{{ .byoc }}} instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). diff --git a/tidb-cloud/premium/connect-to-tidb-instance.md b/tidb-cloud/premium/connect-to-tidb-instance.md index ea01d4929abbf..06b02797cbbf3 100644 --- a/tidb-cloud/premium/connect-to-tidb-instance.md +++ b/tidb-cloud/premium/connect-to-tidb-instance.md @@ -3,9 +3,9 @@ title: Connect to Your {{{ .premium }}} Instance summary: Learn how to connect to your {{{ .premium }}} instance via different methods. --- -# Connect to Your {{{ .premium }}} Instance +# Connect to Your {{{ .premium }}} or {{{ .byoc }}} Instance -This document describes how to connect to your {{{ .premium }}} instance. +This document describes how to connect to your {{{ .premium }}} or {{{ .byoc }}} instance. > **Tip:** > @@ -13,7 +13,7 @@ This document describes how to connect to your {{{ .premium }}} instance. ## Connection methods -After your {{{ .premium }}} instance is created on TiDB Cloud, you can connect to it via direct connections. +After your {{{ .premium }}} or {{{ .byoc }}} instance is created on TiDB Cloud, you can connect to it via direct connections. Direct connections mean the MySQL native connection system over TCP. You can connect to your instance using any tool that supports MySQL connection, such as [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). @@ -23,7 +23,7 @@ Direct connections mean the MySQL native connection system over TCP. You can con ## Network -There are two network connection types for {{{ .premium }}}: +There are two network connection types for {{{ .premium }}} or {{{ .byoc }}}: - [Private endpoint](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md) (recommended) @@ -31,7 +31,7 @@ There are two network connection types for {{{ .premium }}}: - [Public endpoint](/tidb-cloud/premium/connect-to-premium-via-public-connection.md) - The standard connection exposes a public endpoint, so you can connect to your {{{ .premium }}} instance via a SQL client from your laptop. + The standard connection exposes a public endpoint, so you can connect to your {{{ .premium }}} or {{{ .byoc }}} instance via a SQL client from your laptop. @@ -43,4 +43,4 @@ The following table shows the network you can use: ## What's next -After you have successfully connected to your {{{ .premium }}} instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). +After you have successfully connected to your {{{ .premium }}} or {{{ .byoc }}} instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). diff --git a/tidb-cloud/premium/delete-tidb-instance.md b/tidb-cloud/premium/delete-tidb-instance.md index 2d5f4523edc5f..0c54a2eb6db83 100644 --- a/tidb-cloud/premium/delete-tidb-instance.md +++ b/tidb-cloud/premium/delete-tidb-instance.md @@ -3,9 +3,9 @@ title: Delete a {{{ .premium }}} instance summary: Learn how to delete a {{{ .premium }}} instance. --- -# Delete a {{{ .premium }}} instance +# Delete a {{{ .premium }}} or {{{ .byoc }}} instance -This document describes how to delete a {{{ .premium }}} instance. +This document describes how to delete a {{{ .premium }}} or {{{ .byoc }}} instance. You can delete an instance at any time by performing the following steps: @@ -21,11 +21,11 @@ You can delete an instance at any time by performing the following steps: Enter `/` to ensure the instance is deleted correctly. - If you want to restore the instance some time in the future, make sure that you have a backup of the instance. Otherwise, you cannot restore it. For more information about how to back up {{{ .premium }}} instances, see [Back Up and Restore {{{ .premium }}} Data](/tidb-cloud/premium/backup-and-restore-premium.md). + If you want to restore the instance some time in the future, make sure that you have a backup of the instance. Otherwise, you cannot restore it. For more information about how to back up {{{ .premium }}} or {{{ .byoc }}} instances, see [Back Up and Restore {{{ .premium }}} or {{{ .byoc }}} Data](/tidb-cloud/premium/backup-and-restore-premium.md). 5. Click **I understand, delete it**. - Once you delete a backed up {{{ .premium }}} instance, the existing backup files of the instance are moved to the recycle bin. + Once you delete a backed up {{{ .premium }}} or {{{ .byoc }}} instance, the existing backup files of the instance are moved to the recycle bin. Automatic backups will expire and be automatically deleted once the retention period ends. The default retention period is 7 days if you don't modify it. @@ -33,4 +33,4 @@ You can delete an instance at any time by performing the following steps: > > Please be aware that backups will continue to incur charges until deleted. - If you want to restore a {{{ .premium }}} instance from the recycle bin, see [Restore from Recycle Bin](/tidb-cloud/premium/backup-and-restore-premium.md#restore-from-recycle-bin). + If you want to restore a {{{ .premium }}} or {{{ .byoc }}} instance from the recycle bin, see [Restore from Recycle Bin](/tidb-cloud/premium/backup-and-restore-premium.md#restore-from-recycle-bin). diff --git a/tidb-cloud/premium/premium-export.md b/tidb-cloud/premium/premium-export.md index a252061b5a10e..bce6a3be9c60d 100644 --- a/tidb-cloud/premium/premium-export.md +++ b/tidb-cloud/premium/premium-export.md @@ -3,19 +3,19 @@ title: Export Data from {{{ .premium }}} summary: Learn how to export data from {{{ .premium }}} instances. --- -# Export Data from {{{ .premium }}} +# Export Data from {{{ .premium }}} or {{{ .byoc }}} -TiDB Cloud enables you to export data from a {{{ .premium }}} instance to an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes. +TiDB Cloud enables you to export data from a {{{ .premium }}} or {{{ .byoc }}} instance to an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes. -While you can also export data using tools such as [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and TiDB [Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview), the export feature provided by TiDB Cloud offers a more convenient and efficient way to export data from a {{{ .premium }}} instance. It brings the following benefits: +While you can also export data using tools such as [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and TiDB [Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview), the export feature provided by TiDB Cloud offers a more convenient and efficient way to export data from a {{{ .premium }}} or {{{ .byoc }}} instance. It brings the following benefits: -- Convenience: the export service provides a simple and easy-to-use way to export data from a {{{ .premium }}} instance, eliminating the need for additional tools or resources. +- Convenience: the export service provides a simple and easy-to-use way to export data from a {{{ .premium }}} or {{{ .byoc }}} instance, eliminating the need for additional tools or resources. - Isolation: the export service uses separate computing resources, ensuring isolation from the resources used by your online services. - Consistency: the export service ensures the consistency of the exported data without causing locks, which does not affect your online services. > **Note:** > -> - Currently, this feature is only available upon request. To request this feature, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com), and then click **Support Tickets** to go to the [Help Center](https://tidb.support.pingcap.com/servicedesk/customer/portals). Create a ticket, fill in "Apply for data export for {{{ .premium }}} instance" in the **Description** field, and then click **Submit**. +> - Currently, this feature is only available upon request. To request this feature, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com), and then click **Support Tickets** to go to the [Help Center](https://tidb.support.pingcap.com/servicedesk/customer/portals). Create a ticket, fill in "Apply for data export for {{{ .premium }}} or {{{ .byoc }}} instance" in the **Description** field, and then click **Submit**. > - The maximum export size is 1 TiB. Exports larger than this limit might fail. To export more data or request a higher export speed, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). ## Export locations @@ -33,7 +33,7 @@ To export data to Amazon S3, you need to provide the following information: - URI: `s3:////` - One of the following access credentials: - [An access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html): make sure the access key has the `s3:PutObject` permission. - - [A role ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html): make sure the role ARN (Amazon Resource Name) has the `s3:PutObject` permission. Note that only {{{ .premium }}} instances hosted on AWS support the role ARN. + - [A role ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html): make sure the role ARN (Amazon Resource Name) has the `s3:PutObject` permission. Note that only {{{ .premium }}} or {{{ .byoc }}} instances hosted on AWS support the role ARN. For more information, see [Configure External Storage Access](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access). @@ -100,12 +100,12 @@ You can compress the exported CSV and SQL data using the following algorithms: > > If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first. -2. Click the name of your target {{{ .premium }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. +2. Click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. 3. On the **Export** page, click **Export Data** in the upper-right corner. Then configure the following settings: - **Task Name**: enter a name for the export task. The default value is `SNAPSHOT_{snapshot_time}`. - - **Source Connection**: enter **Username** and **Password** of your {{{ .premium }}} instance, and then click **Test Connection** to verify the credentials. + - **Source Connection**: enter **Username** and **Password** of your {{{ .premium }}} or {{{ .byoc }}} instance, and then click **Test Connection** to verify the credentials. - **Target Connection**: - **Storage Provider**: choose Amazon S3. - **Folder URI**: enter the URI of the Amazon S3 with the `s3:////` format. @@ -126,12 +126,12 @@ You can compress the exported CSV and SQL data using the following algorithms: > > If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first. -2. Click the name of your target {{{ .premium }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. +2. Click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. 3. On the **Export** page, click **Export Data** in the upper-right corner. Then configure the following settings: - **Task Name**: enter a name for the export task. The default value is `SNAPSHOT_{snapshot_time}`. - - **Source Connection**: enter **Username** and **Password** of your {{{ .premium }}} instance, and then click **Test Connection** to verify the credentials. + - **Source Connection**: enter **Username** and **Password** of your {{{ .premium }}} or {{{ .byoc }}} instance, and then click **Test Connection** to verify the credentials. - **Target Connection**: - **Storage Provider**: choose Azure Blob Storage. - **Folder URI**: enter the URI of Azure Blob Storage with the `azure://.blob.core.windows.net///` format. @@ -150,12 +150,12 @@ You can compress the exported CSV and SQL data using the following algorithms: > > If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first. -2. Click the name of your target {{{ .premium }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. +2. Click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. 3. On the **Export** page, click **Export Data** in the upper-right corner: - **Task Name**: enter a name for the export task. The default value is `SNAPSHOT_{snapshot_time}`. - - **Source Connection**: enter **Username** and **Password** of your {{{ .premium }}} instance, and then click **Test Connection** to verify the credentials. + - **Source Connection**: enter **Username** and **Password** of your {{{ .premium }}} or {{{ .byoc }}} instance, and then click **Test Connection** to verify the credentials. - **Target Connection**: - **Storage Provider**: choose Alibaba Cloud OSS. - **Folder URI**: enter the Alibaba Cloud OSS URI where you want to export the data, in the `oss:////` format. @@ -176,7 +176,7 @@ To cancel an ongoing export task, take the following steps: > > If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first. -2. Click the name of your target {{{ .premium }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. +2. Click the name of your target {{{ .premium }}} or {{{ .byoc }}} instance to go to its overview page, and then click **Data** > **Export** in the left navigation pane. 3. On the **Export** page, view the export task list. diff --git a/tidb-cloud/tidb-cloud-billing.md b/tidb-cloud/tidb-cloud-billing.md index 4e4c3bd8e869b..ec3cbdde31849 100644 --- a/tidb-cloud/tidb-cloud-billing.md +++ b/tidb-cloud/tidb-cloud-billing.md @@ -25,6 +25,14 @@ For {{{ .essential }}}, you are charged based on the number of provisioned Reque For {{{ .premium }}}, you are billed based on the actual [Request Capacity Unit (RCU)](/tidb-cloud/tidb-cloud-glossary.md#request-capacity-unit-rcu) consumption and the storage that you actually use, rather than the underlying backend nodes or provisioned disk size. See [{{{ .premium }}} Pricing Details](https://www.pingcap.com/tidb-cloud-premium-pricing-details/). + + +### Pricing for {{{ .byoc }}} {#pricing-for-byoc} + +For pricing information about {{{ .byoc }}}, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). + + + ## Invoices If you are in the `Organization Owner` or `Organization Billing Manager` role of your organization, you can manage the invoice information of TiDB Cloud. Otherwise, skip this section. diff --git a/tidb-cloud/tidb-cloud-support.md b/tidb-cloud/tidb-cloud-support.md index 74f95b0d6feab..9ef316aa66c00 100644 --- a/tidb-cloud/tidb-cloud-support.md +++ b/tidb-cloud/tidb-cloud-support.md @@ -109,6 +109,12 @@ To check or upgrade your support plan, perform the following steps: On this page, you can find your current plan. By default, the **Basic** free plan is selected. + + + For {{{ .byoc }}}, **Enterprise** is the minimum required support plan. + + + 2. Choose your desired support plan. @@ -143,3 +149,9 @@ To downgrade your support plan, perform the following steps: 1. In the [TiDB Cloud console](https://tidbcloud.com/), click **Support** in the lower-left corner. 2. Choose the support plan you want to switch to, and then click **Downgrade**. + + + + For {{{ .byoc }}}, you can downgrade only to **Enterprise** or a higher support plan. + +