Skip to content

Serverless restore timeout #20920

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.

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

Merged
merged 4 commits into from
May 8, 2025
Merged

Conversation

shiyuhang0
Copy link
Member

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.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

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

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

Copy link

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

Choose a reason for hiding this comment

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

Hello @shiyuhang0, 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!

Summary of Changes

This pull request adds documentation regarding the timeout behavior for serverless restores in TiDB Cloud. Specifically, it clarifies what happens when a restore operation exceeds 3 hours, detailing the different outcomes for restores to new clusters versus in-place restores. It also directs users to TiDB Cloud Support if data corruption occurs after a canceled restore.

Highlights

  • Restore Timeout Documentation: The PR adds a section explaining the 3-hour timeout for serverless restores.
  • Restore to New Cluster: Clarifies that a timed-out restore to a new cluster results in the deletion of the target cluster, leaving the source cluster unchanged.
  • Restore In-Place: Explains that a timed-out in-place restore will change the cluster status to Available, making it accessible again.
  • Support Contact: Instructs users to contact TiDB Cloud Support if data corruption occurs after a canceled restore.

Changelog

  • tidb-cloud/backup-and-restore-serverless.md
    • Added a 'Restore Timeout' section to explain the behavior when a restore operation exceeds 3 hours.
    • Documented the outcome of a canceled restore for both 'Restore to a New Cluster' and 'Restore In-Place' scenarios.
    • Included instructions to contact TiDB Cloud Support in case of data corruption after a canceled restore.
Using Gemini Code Assist

The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and 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 to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 7, 2025
Copy link

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

Choose a reason for hiding this comment

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

Code Review

The pull request introduces documentation for restore timeout in TiDB Cloud Serverless. The changes are clear and concise. However, I have a few suggestions to improve clarity and adherence to the style guide.

Summary of Findings

  • Clarity and Readability: The documentation could benefit from rephrasing to enhance clarity and readability for TiDB users. Specifically, consider rephrasing the sentence about the outcome of a canceled restore to improve understanding.
  • Sentence Structure: The sentence structure in the 'Restore Timeout' section could be improved for better flow and comprehension. Consider breaking down longer sentences into shorter, more digestible ones.
  • Terminology Consistency: Ensure consistent use of terminology throughout the documentation. For example, verify that 'TiDB Cloud Serverless clusters' and 'TiDB Serverless clusters' are used consistently.

Merge Readiness

The changes are well-structured and provide valuable information about restore timeouts. Addressing the suggestions related to clarity, sentence structure, and terminology consistency would further enhance the documentation. I am unable to approve the pull request, and users should have others review and approve this code before merging.

@Oreoxmt Oreoxmt self-assigned this May 7, 2025
@Oreoxmt Oreoxmt self-requested a review May 7, 2025 10:39
@Oreoxmt Oreoxmt added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels May 7, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label May 7, 2025
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented May 7, 2025

/bot-review

Copy link

github-actions bot commented May 7, 2025

✅ AI review completed, 3 comments generated.

Copy link

ti-chi-bot bot commented May 7, 2025

@zhangyangyu: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions 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.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label May 8, 2025
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels May 8, 2025
Copy link

ti-chi-bot bot commented May 8, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-05-08 02:22:21.715604662 +0000 UTC m=+494588.898507923: ☑️ agreed by Oreoxmt.
  • 2025-05-08 02:30:04.943326977 +0000 UTC m=+495052.126230221: ☑️ agreed by hfxsd.

@Oreoxmt
Copy link
Collaborator

Oreoxmt commented May 8, 2025

/approve

Copy link

ti-chi-bot bot commented May 8, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Oreoxmt

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

The pull request process is described here

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

@ti-chi-bot ti-chi-bot bot added the approved label May 8, 2025
@ti-chi-bot ti-chi-bot bot merged commit 622cc50 into pingcap:release-8.1 May 8, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/tidb-cloud This PR relates to the area of TiDB Cloud. lgtm size/XS Denotes a PR that changes 0-9 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.

4 participants