Skip to content

Adding TiDB Cloud backup export documentation #20487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+54 −0
Open

Adding TiDB Cloud backup export documentation #20487

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4d54dc
Add documentation for backup exports
benmeadowcroft Mar 7, 2025
ef94e0c
Updated the details on getting the folder URI
benmeadowcroft Mar 7, 2025
787053a
Added detail on the scope of access being regional
benmeadowcroft Mar 7, 2025
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
54 changes: 54 additions & 0 deletions tidb-cloud/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,3 +264,57 @@
The cluster restore process starts and the **Password Settings** dialog box is displayed.

7. In the **Password Settings** dialog box, set the root password to connect to your cluster, and then click **Save**.

## Export backups

TiDB Cloud Dedicated clusters can export a backup to your own Cloud Object Storage location.

### Export backups to Google Cloud Storage

To export your cluster backups to Google Cloud Storage, take the following steps:

1. Navigate to the **Backup** tab of a cluster deployed on Google Cloud.

2. From the list of backups, identify the backup that you want to export.

3. Click **Export** from the action menu of the identified backup. The export backup window displays.

4. In **Google Cloud Storage Settings**, enter the Folder URI of a Google Cloud Storage location that you want to export the backup into.

> **Note**
> - To allow TiDB Cloud to export the backup data to your GCS bucket, you need to configure the GCS access for the bucket. Once the configuration is done for one TiDB cluster in a project, all TiDB clusters in that project and region can access the GCS bucket.

5. If this is the first time exporting a backup to this bucket then configure access by:

1. Copy the **Google Cloud Service Account ID**

2. Sign in to the [Google Cloud console](https://console.cloud.google.com/).

3. Go to the [Bucket](https://console.cloud.google.com/storage/browser) page, and click the name of the GCS bucket you want TiDB Cloud to access.

4. On the **Bucket details** page, click the **PERMISSIONS** tab, and then click **GRANT ACCESS**.

![Grant Access to the bucket ](/media/tidb-cloud/gcp-bucket-permissions.png)

5. Fill in the following information to grant access to your bucket, and then click **SAVE**.

- In the **New Principals** field, paste the Google Cloud Service Account ID of the target TiDB cluster.
- In the **Select a role** drop-down list, select the `Storage Legacy Bucket Writer` role.

> **Note:**
>
> To remove the access to TiDB Cloud, you can simply remove the access that you have granted.

6. On the **Bucket details** page, click the **OBJECTS** tab.

If you want to copy a folder's gsutil URI, open the folder, and then click the copy button following the folder name to copy the folder name. After that, you need to add `gs://` to the beginning and `/` to the end of the name to get a correct URI of the folder.

For example, if the folder name is `tidb-cloud-export-data`, you need to use `gs://tidb-cloud-export-data/` as the URI.

![Get bucket URI](/media/tidb-cloud/gcp-bucket-uri02.png)

7. In the TiDB Cloud Console click **Export** to begin exporting the backup.

Check warning on line 316 in tidb-cloud/backup-and-restore.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.console] Use 'TiDB Cloud console' instead of 'TiDB Cloud Console'.

Raw Output:
{"message": "[PingCAP.console] Use 'TiDB Cloud console' instead of 'TiDB Cloud Console'.", "location": {"path": "tidb-cloud/backup-and-restore.md", "range": {"start": {"line": 316, "column": 15}}}, "severity": "INFO"}

The backup export process starts and the list of **Exported Backups** is displayed showing the progress.

To return to the list at any time, click the **Exported Backups** option on the Cluster's **Backup** page.