From 92ccb2b1df7ee3f48c431ae8d6e252a1dd53a601 Mon Sep 17 00:00:00 2001 From: Howard Chen Date: Mon, 5 Jan 2026 14:30:40 +0800 Subject: [PATCH 1/9] Add export backup guide for S3 and GCS. --- tidb-cloud/backup-and-restore.md | 55 ++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 632b20508627e..f903f7881aeca 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -176,6 +176,61 @@ To apply a manual backup to your TiDB Cloud Dedicated cluster, perform the follo 4. Click **Confirm**. Then your cluster data is backed up. +### Export backups + +To export a specific backup to Cloud Storage, perform the following steps: + + + +
+1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. + +2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. + +3. In the **Export Backup to AWS S3** dialog, enter the **Folder URI** and select a region for the backup bucket. + +4. Click **Generate Command** to see the command for configuring permissions. + + - **With AWS CLI**: + Execute the generated command on AWS to grant TiDB Cloud access to your AWS sources. + + - **With AWS Console**: + 1. Navigate to the Amazon S3 console. + 2. Go to the bucket detail page and switch to the **Permissions** tab. + 3. Scroll down to **Bucket Policy**, and click **Edit**. + 4. Copy the policy content from the generated command and paste it into the policy editor. + 5. Click **Save Changes**. + +5. Click **Export** to start the export process. +
+ +
+To export a specific backup to Google Cloud Storage (GCS), perform the following steps: + +1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. + +2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. + +3. In the **Export Backup to Google Cloud Storage** dialog, note the **Google Cloud Service Account ID** we will use later. + +4. In Google Cloud Console, ensure a role exists with the following permissions: + + - `storage.buckets.get` + - `storage.objects.list` + - `storage.objects.create` + - `storage.objects.delete` + +5. In **Cloud Storage** > **Buckets**, select the target bucket, and go to **Permissions** > **Grant Access**. + +6. In **New principals**, enter the **Service Account ID** noted in step 3, select the role from step 4, and click **Save**. + +7. Switch to the **Configuration** tab, copy the **gsutil URI**, and paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. You can append a path suffix to the URI to create a subdirectory. + +8. Click **Export** to start the export process. +
+ +
+ ### Delete backups #### Delete backup files From 684f9df3d010781e2ea16ec32f883009b57add78 Mon Sep 17 00:00:00 2001 From: Ginkgoch Date: Mon, 5 Jan 2026 14:34:02 +0800 Subject: [PATCH 2/9] Update tidb-cloud/backup-and-restore.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- tidb-cloud/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index f903f7881aeca..88711e01b94de 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -192,7 +192,7 @@ To export a specific backup to Cloud Storage, perform the following steps: 4. Click **Generate Command** to see the command for configuring permissions. - **With AWS CLI**: - Execute the generated command on AWS to grant TiDB Cloud access to your AWS sources. + Execute the generated command on AWS to grant TiDB Cloud access to your AWS S3 bucket. - **With AWS Console**: 1. Navigate to the Amazon S3 console. From ecd11777f1da6b3922c82d2109fc29d81d34c20b Mon Sep 17 00:00:00 2001 From: Ginkgoch Date: Mon, 5 Jan 2026 14:34:19 +0800 Subject: [PATCH 3/9] Update tidb-cloud/backup-and-restore.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- tidb-cloud/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 88711e01b94de..981691a1d3b6d 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -211,7 +211,7 @@ To export a specific backup to Google Cloud Storage (GCS), perform the following 2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. -3. In the **Export Backup to Google Cloud Storage** dialog, note the **Google Cloud Service Account ID** we will use later. +3. In the **Export Backup to Google Cloud Storage** dialog, note the **Google Cloud Service Account ID**, which is required for a later step. 4. In Google Cloud Console, ensure a role exists with the following permissions: From d475afcc79a543836cb9f7105d380b2223bcd0cd Mon Sep 17 00:00:00 2001 From: Ginkgoch Date: Mon, 5 Jan 2026 14:34:41 +0800 Subject: [PATCH 4/9] Update tidb-cloud/backup-and-restore.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- tidb-cloud/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 981691a1d3b6d..4c1830fd292a3 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -213,7 +213,7 @@ To export a specific backup to Google Cloud Storage (GCS), perform the following 3. In the **Export Backup to Google Cloud Storage** dialog, note the **Google Cloud Service Account ID**, which is required for a later step. -4. In Google Cloud Console, ensure a role exists with the following permissions: +4. In Google Cloud Console, create a custom IAM role or make sure that an existing role has the following permissions: - `storage.buckets.get` - `storage.objects.list` From 11c5a993d2913ab9317babdd09ea5ebd7928b38b Mon Sep 17 00:00:00 2001 From: Howard Chen Date: Mon, 5 Jan 2026 14:36:34 +0800 Subject: [PATCH 5/9] Remove GCS abbr. --- tidb-cloud/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 4c1830fd292a3..a99bd8e988c2e 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -205,7 +205,7 @@ To export a specific backup to Cloud Storage, perform the following steps:
-To export a specific backup to Google Cloud Storage (GCS), perform the following steps: +To export a specific backup to Google Cloud Storage, perform the following steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. From c6a8c5bf985bb26c55d4f631e05f330b2b003e38 Mon Sep 17 00:00:00 2001 From: Howard Chen Date: Mon, 5 Jan 2026 14:38:40 +0800 Subject: [PATCH 6/9] Improve a casing. --- tidb-cloud/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index a99bd8e988c2e..8cc5512b2d46c 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -213,7 +213,7 @@ To export a specific backup to Google Cloud Storage, perform the following steps 3. In the **Export Backup to Google Cloud Storage** dialog, note the **Google Cloud Service Account ID**, which is required for a later step. -4. In Google Cloud Console, create a custom IAM role or make sure that an existing role has the following permissions: +4. In Google Cloud console, create a custom IAM role or make sure that an existing role has the following permissions: - `storage.buckets.get` - `storage.objects.list` From b89be80ed1d466084250faa5d023ecce3324b628 Mon Sep 17 00:00:00 2001 From: houfaxin Date: Wed, 7 Jan 2026 19:42:35 +0800 Subject: [PATCH 7/9] refine wording --- tidb-cloud/backup-and-restore.md | 36 +++++++++++++++++++------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 8cc5512b2d46c..8fac8a8be5eba 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -178,55 +178,63 @@ To apply a manual backup to your TiDB Cloud Dedicated cluster, perform the follo ### Export backups -To export a specific backup to Cloud Storage, perform the following steps: +
+ +To export a specific backup to cloud storage, such as and Google Cloud Storage, perform the following steps: -
+
+ 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. 2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. -3. In the **Export Backup to AWS S3** dialog, enter the **Folder URI** and select a region for the backup bucket. +3. In the **Export Backup to AWS S3** dialog, enter the **Folder URI**, and then select a region for the backup bucket. 4. Click **Generate Command** to see the command for configuring permissions. - **With AWS CLI**: - Execute the generated command on AWS to grant TiDB Cloud access to your AWS S3 bucket. + + Execute the generated command on AWS to grant TiDB Cloud access to your Amazon S3 bucket. - **With AWS Console**: - 1. Navigate to the Amazon S3 console. - 2. Go to the bucket detail page and switch to the **Permissions** tab. - 3. Scroll down to **Bucket Policy**, and click **Edit**. - 4. Copy the policy content from the generated command and paste it into the policy editor. + + 1. Navigate to the [Amazon S3 console](https://console.aws.amazon.com/s3/). + 2. Go to the bucket detail page, and then switch to the **Permissions** tab. + 3. Scroll down to **Bucket Policy**, and then click **Edit**. + 4. Copy the policy content from the generated command, and then paste it into the policy editor. 5. Click **Save Changes**. 5. Click **Export** to start the export process. +
+ To export a specific backup to Google Cloud Storage, perform the following steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. -2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. +2. Locate the backup you want to export, and then click **...** > **Export** in the **Action** column. -3. In the **Export Backup to Google Cloud Storage** dialog, note the **Google Cloud Service Account ID**, which is required for a later step. +3. In the **Export Backup to Google Cloud Storage** dialog, note down the **Google Cloud Service Account ID**, which is required for a later step. -4. In Google Cloud console, create a custom IAM role or make sure that an existing role has the following permissions: +4. In the [Google Cloud console](https://console.cloud.google.com/), create a custom IAM role, or make sure that an existing role has the following permissions: - `storage.buckets.get` - `storage.objects.list` - `storage.objects.create` - `storage.objects.delete` -5. In **Cloud Storage** > **Buckets**, select the target bucket, and go to **Permissions** > **Grant Access**. +5. In **Cloud Storage** > **Buckets**, select the target bucket, and then go to **Permissions** > **Grant Access**. -6. In **New principals**, enter the **Service Account ID** noted in step 3, select the role from step 4, and click **Save**. +6. In **New principals**, enter the **Service Account ID** that you noted down in Step 3, select the role from Step 4, and then click **Save**. -7. Switch to the **Configuration** tab, copy the **gsutil URI**, and paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. You can append a path suffix to the URI to create a subdirectory. +7. Switch to the **Configuration** tab, copy the **gsutil URI**, and then paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. You can append a path suffix to the URI to create a subdirectory. 8. Click **Export** to start the export process. +
From 82550a0d27fab3fb4f39210ecc095d4428da39ff Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Thu, 8 Jan 2026 14:39:21 +0800 Subject: [PATCH 8/9] Update tidb-cloud/backup-and-restore.md --- tidb-cloud/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 8fac8a8be5eba..aeca0a64f77a3 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -190,7 +190,7 @@ To export a specific backup to cloud storage, such as and Google Cloud Storage, 2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. -3. In the **Export Backup to AWS S3** dialog, enter the **Folder URI**, and then select a region for the backup bucket. +3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI**, and then select a bucket region for the backup bucket. 4. Click **Generate Command** to see the command for configuring permissions. From e01167b7fd09e4a62b61242876613e3887e54d5b Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 12 Jan 2026 09:24:55 +0800 Subject: [PATCH 9/9] Apply suggestions from code review Co-authored-by: Aolin --- tidb-cloud/backup-and-restore.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index aeca0a64f77a3..e713cb82a3fea 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -178,21 +178,21 @@ To apply a manual backup to your TiDB Cloud Dedicated cluster, perform the follo ### Export backups -
- -To export a specific backup to cloud storage, such as and Google Cloud Storage, perform the following steps: +To export a specific backup to cloud storage, such as Amazon S3 or Google Cloud Storage, follow the steps for your target storage provider.
+To export a backup to Amazon S3, perform the following steps: + 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. -2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. +2. Locate the backup you want to export, and then click **...** > **Export** in the **Action** column. -3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI**, and then select a bucket region for the backup bucket. +3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI** field, and then select a bucket region for the backup bucket. -4. Click **Generate Command** to see the command for configuring permissions. +4. Click **Generate Command** to view the command for configuring permissions. - **With AWS CLI**: @@ -201,10 +201,10 @@ To export a specific backup to cloud storage, such as and Google Cloud Storage, - **With AWS Console**: 1. Navigate to the [Amazon S3 console](https://console.aws.amazon.com/s3/). - 2. Go to the bucket detail page, and then switch to the **Permissions** tab. - 3. Scroll down to **Bucket Policy**, and then click **Edit**. + 2. Open the target bucket details page, and then click the **Permissions** tab. + 3. Scroll to **Bucket policy**, and then click **Edit**. 4. Copy the policy content from the generated command, and then paste it into the policy editor. - 5. Click **Save Changes**. + 5. Click **Save changes**. 5. Click **Export** to start the export process. @@ -212,7 +212,7 @@ To export a specific backup to cloud storage, such as and Google Cloud Storage,
-To export a specific backup to Google Cloud Storage, perform the following steps: +To export a backup to Google Cloud Storage, perform the following steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. @@ -220,18 +220,18 @@ To export a specific backup to Google Cloud Storage, perform the following steps 3. In the **Export Backup to Google Cloud Storage** dialog, note down the **Google Cloud Service Account ID**, which is required for a later step. -4. In the [Google Cloud console](https://console.cloud.google.com/), create a custom IAM role, or make sure that an existing role has the following permissions: +4. In the [Google Cloud console](https://console.cloud.google.com/), create a custom IAM role with the following permissions. If you use an existing role, verify that it has these permissions. - `storage.buckets.get` - `storage.objects.list` - `storage.objects.create` - `storage.objects.delete` -5. In **Cloud Storage** > **Buckets**, select the target bucket, and then go to **Permissions** > **Grant Access**. +5. Go to **Cloud Storage** > **Buckets**, select the target bucket, and then click **Permissions** > **Grant Access**. -6. In **New principals**, enter the **Service Account ID** that you noted down in Step 3, select the role from Step 4, and then click **Save**. +6. In **New principals**, enter the **Service Account ID** from step 3, assign the role from step 4, and then click **Save**. -7. Switch to the **Configuration** tab, copy the **gsutil URI**, and then paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. You can append a path suffix to the URI to create a subdirectory. +7. Open the **Configuration** tab, copy the **gsutil URI**, and paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. To export to a subdirectory, append a path suffix to the URI. 8. Click **Export** to start the export process.