Skip to content

byoc: update backup and restore#23286

Open
wildpcww wants to merge 7 commits into
pingcap:release-8.5from
wildpcww:backupandrestore
Open

byoc: update backup and restore#23286
wildpcww wants to merge 7 commits into
pingcap:release-8.5from
wildpcww:backupandrestore

Conversation

@wildpcww

@wildpcww wildpcww commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Updated backup and restore concepts with BYOC-specific wording, broader scope beyond Dedicated, and revised “for more information” links.
    • Added a new Restore subsection under Point-in-time Restore, clarifying restore sources and that PITR applies only to automatic backups (not manual backups), with restores creating new instances.
    • Updated Premium backup/restore guidance to include BYOC, including CustomContent coverage, plan-specific recycle bin restore steps, and cloud-storage restore instructions.
    • Refined BYOC AWS setup and service initialization references to use consistent “TiDB Cloud console” wording.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 15, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the TiDB Cloud backup and restore documentation to incorporate the BYOC (Bring Your Own Cloud) plan type, detailing its backup and restore capabilities. The review feedback highlights minor spacing and formatting inconsistencies around template variables like {{{ .premium }}} and {{{ .byoc }}} that should be corrected for consistency.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
@lilin90 lilin90 changed the title Backupandrestore byoc: update backup and restore Jul 20, 2026
@lilin90 lilin90 self-assigned this Jul 20, 2026
@lilin90 lilin90 added the translation/no-need No need to translate this PR. label Jul 20, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 20, 2026
@lilin90 lilin90 added missing-translation-status This PR does not have translation status info. BYOC Related to TiDB Cloud BYOC docs. and removed missing-translation-status This PR does not have translation status info. labels Jul 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The documentation expands backup and restore coverage to include BYOC, documents restore sources and limitations, and updates BYOC console terminology and procedures.

Changes

Backup and restore documentation

Layer / File(s) Summary
Backup and restore concepts
tidb-cloud/backup-and-restore-concepts.md
Automatic and manual backup guidance now includes BYOC, retention and limitation details, and a new restore subsection covering snapshots, PITR, and external storage.
Premium and BYOC restore procedures
tidb-cloud/premium/backup-and-restore-premium.md
Recycle Bin and cloud storage restore instructions now apply to both Premium and BYOC through plan-specific content.
BYOC console instructions
tidb-cloud/byoc/byoc-prepare-environment-aws.md, tidb-cloud/byoc/byoc-service-initialization.md
Console wording is standardized, and instance provisioning and Amazon S3 restore instructions include updated console guidance.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • pingcap/docs#23323: Updates related BYOC service initialization and Amazon S3 restore wording.

Suggested labels: type/enhancement, area/tidb-cloud

Suggested reviewers: lilin90

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description mostly mirrors the template but leaves the required change summary and related links sections empty. Fill in the required change summary, explain why the docs changed, and add any related PR or file links; confirm the affected version selection.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the BYOC backup and restore documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: a545f2f9-42bb-4f2e-bea5-557cc19c7376

📥 Commits

Reviewing files that changed from the base of the PR and between 37c45d5 and 20ce4be.

📒 Files selected for processing (4)
  • tidb-cloud/backup-and-restore-concepts.md
  • tidb-cloud/byoc/byoc-prepare-environment-aws.md
  • tidb-cloud/byoc/byoc-service-initialization.md
  • tidb-cloud/premium/backup-and-restore-premium.md

Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment on lines +11 to +15
<CustomContent plan="byoc">

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

</CustomContent>

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

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Comment thread tidb-cloud/backup-and-restore-concepts.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BYOC Related to TiDB Cloud BYOC docs. contribution This PR is from a community contributor. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants