Skip to content

byoc: update backup and restore #23286

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
wildpcww wants to merge 7 commits into
base: release-8.5
Choose a base branch
from
+36 −9
Open

byoc: update backup and restore #23286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b1b458
Update backup-and-restore-concepts.md
wildpcww Jul 15, 2026
2f2eec8
Update backup-and-restore-premium.md
wildpcww Jul 15, 2026
20ce4be
Update capitalization for style
lilin90 Jul 21, 2026
7dd57bb
Apply suggestions from code review
lilin90 Jul 21, 2026
f34fdf1
Refine wording and format
lilin90 Jul 21, 2026
6b1f452
Merge branch 'release-8.5' into backupandrestore
lilin90 Jul 21, 2026
3dac83f
Remove an extra blank line
lilin90 Jul 21, 2026
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
23 changes: 20 additions & 3 deletions tidb-cloud/backup-and-restore-concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,32 @@ summary: Learn about backup & restore concepts for TiDB Cloud.

TiDB Cloud Backup & Restore features are designed to safeguard your data and ensure business continuity by enabling you to back up and recover data.

<CustomContent plan="byoc">

With TiDB Cloud BYOC, you can manage backup and restore operations through the TiDB Cloud console, while the data plane runs in your own cloud account. This provides a managed backup and restore experience while keeping your data plane in your cloud environment.

</CustomContent>

## Automatic backup

In TiDB Cloud, snapshot backups are taken automatically by default and stored according to your backup retention policy.

For more information, see the following:

- [Automatic backups for {{{ .starter }}} and {{{ .essential }}} instances](/tidb-cloud/backup-and-restore-serverless.md#automatic-backups)
- [Automatic backups for {{{ .premium }}} instances](/tidb-cloud/premium/backup-and-restore-premium.md#automatic-backups)
- [Automatic backups for {{{ .premium }}} <CustomContent plan="byoc">and {{{ .byoc }}} </CustomContent>instances](/tidb-cloud/premium/backup-and-restore-premium.md#automatic-backups)
- [Automatic backups for TiDB Cloud Dedicated clusters](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup)

## Manual backup

Manual backup is a feature of TiDB Cloud Dedicated that enables you to back up your data to a known state as needed, and then restore to that state at any time.
Manual backup enables you to back up your data to a known state as needed, and then restore to that state at any time. You can use a manual backup before high-risk operations such as system upgrades, critical data deletion, or irreversible schema changes.

For more information, see [Perform a manual backup](/tidb-cloud/backup-and-restore.md#perform-a-manual-backup).
{{{ .premium }}}<CustomContent plan="byoc">, {{{ .byoc }}},</CustomContent> and TiDB Cloud Dedicated support manual backups. A manual backup provides a controlled restore point and is retained until you explicitly delete it. Manual backups do not support PITR or partial backups, and each restore operation creates a new instance.

For more information, see the following:
Comment thread
lilin90 marked this conversation as resolved.

- [Manual backups for {{{ .premium }}}<CustomContent plan="byoc"> and {{{ .byoc }}}</CustomContent> instances](/tidb-cloud/premium/backup-and-restore-premium.md#manual-backups)
- [Perform a manual backup for TiDB Cloud Dedicated clusters](/tidb-cloud/backup-and-restore.md#perform-a-manual-backup)

## Dual region backup

Expand All @@ -42,3 +53,9 @@ If you want to perform Point-in-time Restore, note the following:
- For {{{ .starter }}} instances, Point-in-time Restore is not available.
- For {{{ .essential }}} instances, you can restore to any time within the last 30 days. For more information, see [Restore mode](/tidb-cloud/backup-and-restore-serverless.md#restore-mode).
- For TiDB Cloud Dedicated clusters, you need to [enable PITR](/tidb-cloud/backup-and-restore.md#turn-on-point-in-time-restore) in advance.

## Restore

TiDB Cloud supports restoring data from backup snapshots or point-in-time recovery to a new cluster or instance. Restore operations help you recover from accidental data loss, data corruption, or application errors.

For {{{ .premium }}}<CustomContent plan="byoc"> and {{{ .byoc }}}</CustomContent> instances, you can restore data to a new instance. You can restore from automatic backups, manual backups, or supported external cloud storage backups. PITR is supported only for automatic backups and is not supported for manual backups.
2 changes: 1 addition & 1 deletion tidb-cloud/byoc/byoc-prepare-environment-aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Before initiating the BYOC deployment, prepare the required infrastructure compo

Unique identifier for your organization within TiDB Cloud.

1. Log in to the [TiDB Cloud Console](https://tidbcloud.com/).
1. Log in to the [TiDB Cloud console](https://tidbcloud.com/).

If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up. You can sign up with an email and password to manage TiDB Cloud credentials, or use single sign-on (SSO) via Google, GitHub, or Microsoft accounts.

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/byoc/byoc-service-initialization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ After deploying your BYOC infrastructure, create your first {{{ .byoc }}} instan

## Create a BYOC instance

You can now provision TiDB instances directly via the TiDB Cloud Console.
You can now provision TiDB instances directly via the TiDB Cloud console.

1. Initiate instance creation. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and follow the [BYOC instance creation workflow](/tidb-cloud/byoc/create-tidb-instance-byoc.md) to create a new instance.

Expand All @@ -32,7 +32,7 @@ After preparing your backup file in Amazon S3, you can proceed to restore the da

2. Execute the Restore Process.

Once the access keys are configured, you can initiate the restore job from the TiDB Cloud Console.
Once the access keys are configured, you can initiate the restore job from the TiDB Cloud console.

For step-by-step restoration procedures, see [Restore backups from cloud storage](/tidb-cloud/premium/backup-and-restore-premium.md#restore-backups-from-cloud-storage).

Expand Down
16 changes: 13 additions & 3 deletions tidb-cloud/premium/backup-and-restore-premium.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ aliases: ['/tidbcloud/restore-deleted-tidb-cluster']

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.

<CustomContent plan="byoc">

This document also applies to {{{ .byoc }}}. Backup and restore capabilities for {{{ .byoc }}} are currently consistent with {{{ .premium }}}.

</CustomContent>
Comment on lines +11 to +15

@coderabbitai coderabbitai Bot Jul 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

Scope the complete restore procedures for BYOC, not only the introduction and labels.

The new text states that this document applies to BYOC, but the shared procedure still contains Premium-only wording and links: Restore to a new Premium instance, “Premium instances” for PITR, the deleted Premium instance description, and the cloud-storage step linking to Create a Premium Instance. BYOC readers can therefore follow the wrong plan’s instructions. Wrap the full applicable procedures in plan-specific blocks or replace these references with genuinely plan-neutral guidance and BYOC targets.

Also applies to: 171-180, 198-202


Backup files can originate from the following sources:

- Active {{{ .premium }}} instances
Expand Down Expand Up @@ -162,14 +168,16 @@ To restore a deleted {{{ .premium }}} instance from the Recycle Bin, take the fo
>
> If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first.

2. On the **Recycle Bin** page, click the **Premium** tab to go to the recycle bin of {{{ .premium }}} instances.
2. On the **Recycle Bin** page, click the <CustomContent plan="premium">**Premium**</CustomContent><CustomContent plan="byoc">**BYOC**</CustomContent> tab to go to the recycle bin of <CustomContent plan="premium">{{{ .premium }}}</CustomContent><CustomContent plan="byoc">{{{ .byoc }}}</CustomContent> instances.

3. Locate the {{{ .premium }}} instance you want to restore, and then click the **>** button to expand the available backups of the instance.
3. Locate the <CustomContent plan="premium">{{{ .premium }}}</CustomContent><CustomContent plan="byoc">{{{ .byoc }}}</CustomContent> instance you want to restore, and then click the **>** button to expand the available backups of the instance.

4. In the row of your desired backup, click **...**, and then select **Restore**.

5. On the **Restore** page, follow the same steps as [Restore to a new instance](#restore-to-a-new-instance) to restore the backup to a new instance.

<CustomContent plan="premium">

### Restore backups from a different plan type

Currently, you can only restore backups from a {{{ .dedicated }}} cluster hosted on AWS to a new {{{ .premium }}} instance.
Expand All @@ -187,9 +195,11 @@ To restore a backup generated by a {{{ .dedicated }}} cluster, follow these step

3. On the **Restore** page, follow the same steps as [Restore to a new instance](#restore-to-a-new-instance) to restore the backup to a new instance.

</CustomContent>

### Restore backups from cloud storage

{{{ .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.
<CustomContent plan="premium">{{{ .premium }}}</CustomContent><CustomContent plan="byoc">{{{ .byoc }}}</CustomContent> 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.

>**Note:**
>
Expand Down
Loading