cloud-premium: add manual backup support for premium instances#22615
cloud-premium: add manual backup support for premium instances#22615wildpcww wants to merge 1 commit intopingcap:release-8.5from
Conversation
- Add manual backup feature with key characteristics and creation steps
- Update PITR window to 7 days for premium instances
- Fix Premium naming consistency using {{{ .premium }}} variable
- Remove manual backup limitation note since it's now supported
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
[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 |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the documentation for TiDB Cloud premium instances by detailing the newly supported manual backup feature. It provides users with essential information on how to create and manage manual backups, their characteristics, and how they integrate with existing restore options. Additionally, it clarifies the updated Point-in-Time Recovery window for premium instances, ensuring the documentation accurately reflects current service capabilities. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively documents the new manual backup feature for premium instances, updates the Point-in-Time Recovery (PITR) window, and improves naming consistency. The changes are well-structured and clear. I have provided a few minor suggestions to enhance grammar, voice, and formatting consistency, aligning with the documentation style guide.
| # Back Up and Restore {{{ .premium }}} Data | ||
|
|
||
| This document describes how to back up and restore your data on {{{ .premium }}} instances. {{{ .premium }}} supports automatic backup and lets you restore backup data to a new instance as needed. | ||
| 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 |
There was a problem hiding this comment.
This sentence is missing a period at the end. According to the style guide, all sentences should have correct punctuation.
| 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 | |
| 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. |
References
- The style guide requires correct English grammar, spelling, and punctuation. (link)
|
|
||
| 2. In the upper-right corner, click **...**, and then click **Manual Backup**. | ||
|
|
||
| 3. Confirm the operation. The backup is stored in TiDB Cloud and will appear in the Backup List. It can be restored directly through the UI without requiring external storage credentials. |
There was a problem hiding this comment.
The last sentence uses passive voice ("It can be restored"). The style guide recommends using active voice and addressing the user directly with "you" to improve clarity.
| 3. Confirm the operation. The backup is stored in TiDB Cloud and will appear in the Backup List. It can be restored directly through the UI without requiring external storage credentials. | |
| 3. Confirm the operation. The backup is stored in TiDB Cloud and will appear in the Backup List. You can restore it directly through the UI without requiring external storage credentials. |
References
- The style guide recommends writing in the second person ('you') and avoiding passive voice. (link)
| - **Point-in-Time Restore**: restores your instance to a specific point in time. | ||
|
|
||
| - Premium instances: can be restored to any time within the last 33 days, but not earlier than the instance creation time or later than one minute before the current time. | ||
| - Premium instances: can be restored to any time within the last 7 days, but not earlier than the instance creation time or later than one minute before the current time. (Note: PITR is not supported for manual backups) |
There was a problem hiding this comment.
The (Note: ...) format is inconsistent with the style used for notes elsewhere in the documentation. To improve consistency, it's better to integrate the note into the sentence or use the standard blockquote format for notes.
| - Premium instances: can be restored to any time within the last 7 days, but not earlier than the instance creation time or later than one minute before the current time. (Note: PITR is not supported for manual backups) | |
| - Premium instances: can be restored to any time within the last 7 days, but not earlier than the instance creation time or later than one minute before the current time. Note that PITR is not supported for manual backups. |
References
- The style guide emphasizes clarity, simplicity, and consistency in documentation. (link)
|
@wildpcww: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
1 participant
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)?
Do your changes match any of the following descriptions?