Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 0 additions & 74 deletions TOC-tidb-cloud.md

This file was deleted.

Binary file removed media/tidb-cloud/Project-CIDR.png
Binary file not shown.
Binary file removed media/tidb-cloud/Project-CIDR1.png
Binary file not shown.
Binary file removed media/tidb-cloud/VPC-Peering1.png
Binary file not shown.
Binary file removed media/tidb-cloud/add-credit-card.png
Binary file not shown.
Binary file added media/tidb-cloud/aws-create-policy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/aws-create-role.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/aws-role-arn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/copy-bucket-arn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/tidb-cloud/poc-points.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed media/tidb-cloud/project-CIDR3.png
Binary file not shown.
Binary file modified media/tidb-cloud/statement-analysis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 3 additions & 8 deletions tidb-cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ aliases: ['/tidbcloud/beta/privacy-policy', '/tidbcloud/beta/terms-of-service',
- [Determine Your TiDB Size](/tidb-cloud/size-your-cluster.md)
- [Create a TiDB Cluster](/tidb-cloud/create-tidb-cluster.md)
- [Connect to a TiDB Cluster](/tidb-cloud/connect-to-tidb-cluster.md)
- [Use an HTAP Cluster](/tidb-cloud/use-htap-cluster.md)
- [Use an HTAP Cluster](/tiflash/tiflash-overview.md)
- [Scale a TiDB Cluster](/tidb-cloud/scale-tidb-cluster.md)
- [Upgrade a TiDB Cluster](/tidb-cloud/upgrade-tidb-cluster.md)

Expand Down Expand Up @@ -58,13 +58,8 @@ aliases: ['/tidbcloud/beta/privacy-policy', '/tidbcloud/beta/terms-of-service',
<NavColumn>
<ColumnTitle>Manage User Access</ColumnTitle>

- [Sign In](/tidb-cloud/manage-user-access.md#sign-in)
- [Sign Out](/tidb-cloud/manage-user-access.md#sign-out)
- [View the Organization and Project](/tidb-cloud/manage-user-access.md#view-the-organization-and-project)
- [Invite an Organization Member](/tidb-cloud/manage-user-access.md#invite-an-organization-member)
- [Invite a Project Member](/tidb-cloud/manage-user-access.md#invite-a-project-member)
- [Configure Member Roles](/tidb-cloud/manage-user-access.md#configure-member-roles)
- [Set the Local Time Zone](/tidb-cloud/manage-user-access.md#set-the-local-time-zone)
- [Manage Console User Access](/tidb-cloud/manage-user-access.md)
- [Configure Cluster Security Settings](/tidb-cloud/configure-security-settings.md)

</NavColumn>

Expand Down
23 changes: 16 additions & 7 deletions tidb-cloud/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ aliases: ['/tidbcloud/restore-deleted-tidb-cluster']

This document describes how to back up and restore your TiDB cluster data on TiDB Cloud.

> **Note:**
>
> For [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#developer-tier), the backup and restore feature is unavailable. You can use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export your data as a backup.

## Backup

TiDB Cloud provides two types of data backup: automatic backup and manual backup.

For [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#developer-tier), each cluster allows one automatic backup and two manual backups:

- For the automatic backup, the existing backup will be replaced by the newer backup.
- For the manual backup, if you already have two backups, you need to delete at least one backup before you are able to make another backup.
Daily backups are automatically scheduled for your TiDB clusters in TiDB Cloud. You can pick a backup snapshot and restore it into a new TiDB cluster at any time. Automated backup can reduce your losses in extreme disaster situations.

### Automatic backup

Expand Down Expand Up @@ -70,6 +71,14 @@ To delete an existing backup file, perform the following steps:

2. Click **Delete** for the backup file that you want to delete.

### Delete a running backup job

To delete a running backup job, it is similar as [**Delete backup files**](#delete-backup-files).

1. Navigate to the **Backup** tab of a cluster.

2. Click **Delete** for the backup file that is in the **Pending** or **Running** state.

### Best practices for backup

- It is recommended that you perform backup operations at cluster idle time to minimize the impact on business.
Expand All @@ -94,7 +103,7 @@ To restore your TiDB cluster data from a backup to a new cluster, take the follo
3. In the **Restore** window, make the following changes if necessary:

- Update the port number of the cluster.
- Increase the vCPUs size, node quantity, and storage size for the cluster.
- Increase the node size, node quantity, and storage size for the cluster.

4. Click **Confirm**.

Expand All @@ -112,10 +121,10 @@ To restore a deleted cluster from recycle bin, take the following steps:
4. In the **Restore** window, make the following changes if necessary:

- Update the port number of the cluster.
- Increase the vCPUs size, node quantity, and storage size for the cluster.
- Increase the node size, node quantity, and storage size for the cluster.

5. Click **Confirm**.

The cluster restore process starts and the **Security Quick Start** dialog box is displayed.

6. In the **Security Quick Start** dialog box, set the root password and allowed IP addresses to connect to your cluster, and then click **Apply**.
6. In the **Security Quick Start** dialog box, set the root password and allowed IP addresses to connect to your cluster, and then click **Apply**.
4 changes: 2 additions & 2 deletions tidb-cloud/changefeed-sink-to-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ The **Sink to MySQL** connector can only sink incremental data from your TiDB cl
SET GLOBAL tidb_gc_life_time = '720h';
```

2. Use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data from your TiDB cluster, then use community tools such as [mydumper/myloader](https://centminmod.com/mydumper.html) to load data to the MySQL service.
2. Use [Dumpling](/dumpling-overview.md) to export data from your TiDB cluster, then use community tools such as [mydumper/myloader](https://centminmod.com/mydumper.html) to load data to the MySQL service.

3. From the [exported files of Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview#format-of-exported-files), get the TSO from the metadata file:
3. From the [exported files of Dumpling](/dumpling-overview.md#format-of-exported-files), get the TSO from the metadata file:

{{< copyable "shell-regular" >}}

Expand Down
22 changes: 22 additions & 0 deletions tidb-cloud/configure-security-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Configure Cluster Security Settings
summary: Learn how to configure the root password and allowed IP addresses to connect to your cluster.
---

# Configure Cluster Security Settings

When you create a cluster, the TiDB Cloud console will automatically guide you to configure the root password and allowed IP addresses to connect to your cluster.

If you do not configure the root password or allowed IP addresses at that time, or if you want to modify the cluster security settings, take the following steps:

1. In the TiDB Cloud console, navigate to the **Active Clusters** page of your project, and then locate the pane of your cluster.
2. Click **Security Quick Start** in the pane. The **Security Quick Start** dialog is displayed.
3. In the dialog, configure the root password and allowed IP addresses.

To allow your cluster to be accessible by any IP addresses, click **Allow Access From Anywhere**.

4. Click **Apply**.

> **Tip:**
>
> If you are viewing the overview page of your cluster, you can click the **Quick Start** tab on the page and configure these settings, too.
5 changes: 4 additions & 1 deletion tidb-cloud/connect-to-tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ To connect to your TiDB cluster via standard connection, perform the following s
1. Click one of the buttons to add some rules quickly.

- **Add My Current IP Address**
- **Add Rules from Default Set**
- **Allow Access from Anywhere**

2. Provide an optional description for the newly added IP address or CIDR range.
Expand All @@ -38,6 +37,10 @@ To connect to your TiDB cluster via standard connection, perform the following s

4. Under **Step 2: Connect with a SQL client** in the dialog box, click the tab of your preferred connection method, and then connect to your cluster with the connection string.

> **Note:**
>
> For [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#developer-tier), when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix).

## Connect via VPC peering

> **Note:**
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/create-tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ To create a Dedicated Tier cluster, take the following steps:
>
> When setting the project CIDR, avoid any conflicts with the CIDR of the VPC where your application is located. You cannot modify your project CIDR once it is set.

4. Configure the [cluster size](/tidb-cloud/size-your-cluster.md) for TiDB, TiKV, and TiFlash<sup>beta</sup> (optional) respectively, and then click **Next**.
4. Configure the [cluster size](/tidb-cloud/size-your-cluster.md) for TiDB, TiKV, and TiFlash (optional) respectively, and then click **Next**.

5. Confirm the cluster information in the middle area and the billing information in the right pane.

Expand Down
8 changes: 6 additions & 2 deletions tidb-cloud/delete-tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ You can delete a cluster at any time by performing the following steps:
3. Click **Delete** in the drop-down menu.
4. In the cluster deleting window, enter the cluster name.

If you want to restore the cluster sometime in the future, make sure you have a backup of the cluster. Otherwise, you cannot restore it anymore. For more information about how to back up clusters, see [Back up and Restore TiDB Cluster Data](/tidb-cloud/backup-and-restore.md).
If you want to restore the cluster sometime in the future, make sure that you have a backup of the cluster. Otherwise, you cannot restore it anymore. For more information about how to back up Dedicated Tier clusters, see [Back up and Restore TiDB Cluster Data](/tidb-cloud/backup-and-restore.md).

> **Note:**
>
> For [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#developer-tier), the backup and restore feature is unavailable. You can use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export your data as a backup.

5. Click **I understand the consequences, delete this cluster**.

Once a backed up cluster is deleted, the existing backup files of the cluster are moved to the recycle bin.
Once a backed up Dedicated Tier cluster is deleted, the existing backup files of the cluster are moved to the recycle bin.

- For backup files from an automatic backup, the recycle bin can retain them for 7 days.
- For backup files from a manual backup, there is no expiration date.
Expand Down
6 changes: 2 additions & 4 deletions tidb-cloud/export-data-from-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ summary: This page has instructions for exporting data from your TiDB cluster in

This page describes how to export data from your cluster in TiDB Cloud.

Daily backups are automatically scheduled for your TiDB clusters in TiDB Cloud. You can pick a backup snapshot and restore it into a new TiDB cluster at any time. Automated backup can reduce your losses in extreme disaster situations.
TiDB does not lock in your data. Sometimes you still want to be able to migrate data from TiDB to other data platforms. Because TiDB is highly compatible with MySQL, any export tool suitable for MySQL can also be used for TiDB.

TiDB does not lock in your data, sometimes you still want to be able to migrate data from TiDB to other data platforms. Because TiDB is highly compatible with MySQL, any export tool suitable for MySQL can also be used for TiDB.

You can use the same tool [Dumpling](https://github.com/pingcap/dumpling) for data export.
You can use the tool [Dumpling](https://github.com/pingcap/dumpling) for data export.

1. Download and install TiUP:

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/high-availability-with-multi-az.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ TiDB Cloud clusters consist of three major components: TiDB node, TiKV node, and

TiKV (<https://docs.pingcap.com/tidb/stable/tikv-overview>) is the row-based storage layer of TiDB Cloud cluster with horizontal scalability. On TiDB Cloud, the minimum number of TiKV nodes for a cluster is 3. TiDB Cloud deploys TiKV nodes evenly to all availability zones (at least 3) in the region you select to achieve durability and high availability. In a typical 3-replica setup, your data is distributed evenly among the TiKV nodes across all availability zones and is persisted to the disk of each TiKV node.

* **TiFlash<sup>beta</sup> node**
* **TiFlash node**

TiFlash<sup>beta</sup>(<https://docs.pingcap.com/tidb/stable/tiflash-overview>), as a columnar storage extension of TiKV, is the key component that makes TiDB essentially a Hybrid Transactional/Analytical Processing (HTAP) database. In TiFlash<sup>beta</sup>, the columnar replicas are asynchronously replicated according to the Raft Learner consensus algorithm. TiDB Cloud deploys TiFlash<sup>beta</sup> nodes evenly to different availability zones in a region. It is recommended that you configure at least two TiFlash<sup>beta</sup> nodes in each TiDB Cloud cluster and create at least 2 replicas of the data for high availability in your production environment.
TiFlash(<https://docs.pingcap.com/tidb/stable/tiflash-overview>), as a columnar storage extension of TiKV, is the key component that makes TiDB essentially a Hybrid Transactional/Analytical Processing (HTAP) database. In TiFlash, the columnar replicas are asynchronously replicated according to the Raft Learner consensus algorithm. TiDB Cloud deploys TiFlash nodes evenly to different availability zones in a region. It is recommended that you configure at least two TiFlash nodes in each TiDB Cloud cluster and create at least two replicas of the data for high availability in your production environment.
16 changes: 11 additions & 5 deletions tidb-cloud/import-csv-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ Before importing CSV files into TiDB Cloud, you need to create the target databa

To allow TiDB Cloud to access the CSV files in the Amazon S3 or GCS bucket, do one of the following:

- If your organization is using TiDB Cloud as a service on AWS, [configure cross-account access to Amazon S3](/tidb-cloud/migrate-from-amazon-s3-or-gcs.md#step-2-configure-amazon-s3-access).
- If your CSV files are located in Amazon S3, [configure cross-account access to Amazon S3](/tidb-cloud/migrate-from-amazon-s3-or-gcs.md#step-2-configure-amazon-s3-access).

Once finished, make a note of the Role ARN value as you will need it in [Step 4](#step-4-import-csv-files-to-tidb-cloud).

- If your organization is using TiDB Cloud as a service on Google Cloud Platform (GCP), [configure cross-account access to GCS](/tidb-cloud/migrate-from-amazon-s3-or-gcs.md#step-2-configure-gcs-access).
- If your CSV files are located in GCS, [configure cross-account access to GCS](/tidb-cloud/migrate-from-amazon-s3-or-gcs.md#step-2-configure-gcs-access).

## Step 4. Import CSV files to TiDB Cloud

Expand All @@ -82,13 +82,19 @@ To import the CSV files to TiDB Cloud, take the following steps:
> For the configurations of separator, delimiter, and null, you can use both alphanumeric characters and certain special characters. The supported special characters include `\t`, `\b`, `\n`, `\r`, `\f`, and `\u0001`.

- **Target Database**: fill in the **Username** and **Password** fields.
- **DB/Tables Filter**: if necessary, you can specify a [table filter](https://docs.pingcap.com/tidb/stable/table-filter#cli). Currently, TiDB Cloud only supports one table filter rule.
- **DB/Tables Filter**: if necessary, you can specify a [table filter](/table-filter.md#syntax). If you want to configure multiple filter rules, use `,` to separate the rules.
- **Object Name Pattern**: enter a pattern that matches the names of the CSV files to be imported. For example,`my-data.csv`.
- **Target Table Name**: enter the name of the target table. For example, `mydb.mytable`.

4. Click **Import** to start the import task.
4. Click **Import**.

5. When the import progress shows success, check the number after **Total Files:**.
A warning message about the database resource consumption is displayed.

5. Click **Confirm**.

TiDB Cloud starts validating whether it can access your data in the specified bucket URL. After the validation is completed and successful, the import task starts automatically. If you get the `AccessDenied` error, see [Troubleshoot Access Denied Errors during Data Import from S3](/tidb-cloud/troubleshoot-import-access-denied-error.md).

6. When the import progress shows success, check the number after **Total Files:**.

If the number is zero, it means no data files matched the value you entered in the **Object Name Pattern** field. In this case, ensure that there are no typos in the **Object Name Pattern** field and try again.

Expand Down
Loading