byoc: update backup and restore#23286
Conversation
There was a problem hiding this comment.
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.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe documentation expands backup and restore coverage to include BYOC, documents restore sources and limitations, and updates BYOC console terminology and procedures. ChangesBackup and restore documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
tidb-cloud/backup-and-restore-concepts.mdtidb-cloud/byoc/byoc-prepare-environment-aws.mdtidb-cloud/byoc/byoc-service-initialization.mdtidb-cloud/premium/backup-and-restore-premium.md
| <CustomContent plan="byoc"> | ||
|
|
||
| This document also applies to {{{ .byoc }}}. Backup and restore capabilities for {{{ .byoc }}} are currently consistent with {{{ .premium }}}. | ||
|
|
||
| </CustomContent> |
There was a problem hiding this comment.
🎯 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>
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.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit