cloud: add steps to configure storage access for BR #22230
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Clarified and updated instructions for restoring backups from cloud storage, including revised authentication fields and step order. Added details about regional high availability for premium instances and adjusted step numbering for instance creation.
Moved and consolidated limitations for restoring backups to a dedicated section before the steps. Clarified supported cloud providers, manual backup support, and cross-region fees. Updated prerequisites to focus on required credentials.
Co-authored-by: Grace Cai <qqzczy@126.com>
Expanded documentation links to reference 'Premium' alongside 'Starter' and 'Essential' in high availability sections for clarity and completeness.
Standardized references to high availability documentation in TiDB Cloud by updating link text in architecture-concepts.md and key-concepts.md. Added a note in serverless-high-availability.md to direct users to the dedicated high availability documentation for TiDB Cloud Dedicated.
Co-authored-by: Grace Cai <qqzczy@126.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 |
ti-chi-bot
bot
added
contribution
Summary of ChangesHello @wildpcww, 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 TiDB Cloud documentation by providing detailed instructions and necessary permission configurations for restoring data from external cloud storage services, specifically Amazon S3 and Alibaba Cloud OSS. It introduces a new, dedicated guide for performing these restore operations on Premium instances and updates existing high availability documentation to reflect the inclusion of Premium plans and their specific HA characteristics. 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. 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
|
![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 adds documentation for configuring storage access for backup and restore, primarily for the new premium plan. The changes are generally well-structured and add valuable information. I have provided a few suggestions to enhance consistency, correct minor formatting, and address content duplication, aligning with the repository's style guide for better readability and maintainability.
|
|
||
| {{{ .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. | ||
|
|
||
| >**Note:** |
There was a problem hiding this comment.
For correct Markdown rendering and consistency with other notes in the documentation, please add a space between > and **Note:**.
| >**Note:** | |
| > **Note:** |
References
- The style guide emphasizes clarity and readability. Proper markdown formatting is key to that. (link)
|
|
||
| To restore backups from cloud storage, do the following: | ||
|
|
||
| 1. Log in to the [TiDB Cloud console](https://tidbcloud.com), and then navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. In the upper-right corner, click **...** , and then click **Restore from Cloud Storage**. |
There was a problem hiding this comment.
Please remove the extra space before the comma for correct punctuation.
| 1. Log in to the [TiDB Cloud console](https://tidbcloud.com), and then navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. In the upper-right corner, click **...** , and then click **Restore from Cloud Storage**. | |
| 1. Log in to the [TiDB Cloud console](https://tidbcloud.com), and then navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. In the upper-right corner, click **...**, and then click **Restore from Cloud Storage**. |
References
- The style guide requires correcting punctuation mistakes. (link)
| - **Cloud Provider**: select the cloud provider where your backup files are stored. | ||
| - **Region**: if your cloud provider is Alibaba Cloud OSS, select a Region. | ||
| - **Backup Files URI**: enter the URI of the top-level folder that contains your backup files. | ||
| - **Access Key ID**: enter your access key ID. | ||
| - **Access Key Secret**: enter your access key secret. |
There was a problem hiding this comment.
To improve clarity and consistency in these instructions, please capitalize the first letter of the action verbs (select and enter).
| - **Cloud Provider**: select the cloud provider where your backup files are stored. | |
| - **Region**: if your cloud provider is Alibaba Cloud OSS, select a Region. | |
| - **Backup Files URI**: enter the URI of the top-level folder that contains your backup files. | |
| - **Access Key ID**: enter your access key ID. | |
| - **Access Key Secret**: enter your access key secret. | |
| - **Cloud Provider**: Select the cloud provider where your backup files are stored. | |
| - **Region**: if your cloud provider is Alibaba Cloud OSS, select a Region. | |
| - **Backup Files URI**: Enter the URI of the top-level folder that contains your backup files. | |
| - **Access Key ID**: Enter your access key ID. | |
| - **Access Key Secret**: Enter your access key secret. |
References
- The style guide prioritizes clarity and readability in documentation, and consistent formatting of instructions helps with that. (link)
| <CustomContent plan="starter,essential"> | ||
|
|
||
| > **Note:** | ||
| > | ||
| > - For {{{ .starter }}} clusters, only zonal high availability is enabled, and it is not configurable. | ||
| > - For {{{ .essential }}} clusters hosted in the AWS Tokyo (ap-northeast-1) region or any Alibaba Cloud region, regional high availability is enabled by default. You can change it to zonal high availability as needed during cluster creation. For {{{ .essential }}} clusters hosted in other regions, only zonal high availability is enabled, and it is not configurable. | ||
| </CustomContent> | ||
|
|
||
| <CustomContent plan="premium"> | ||
|
|
||
| > **Note:** | ||
| > | ||
| > - For {{{ .starter }}} clusters, only zonal high availability is enabled, and it is not configurable. | ||
| > - For {{{ .premium }}} clusters, only regional high availability is enabled, and it is not configurable. | ||
| > - For {{{ .essential }}} clusters hosted in the AWS Tokyo (ap-northeast-1) region or any Alibaba Cloud region, regional high availability is enabled by default. You can change it to zonal high availability as needed during cluster creation. For {{{ .essential }}} clusters hosted in other regions, only zonal high availability is enabled, and it is not configurable. | ||
| </CustomContent> |
There was a problem hiding this comment.
This section contains duplicated information about starter and essential clusters across the starter,essential and premium content blocks. This violates the style guide's principle of avoiding repetition and could lead to maintenance issues. Please consider refactoring to remove the duplication. For example, you could define the common text once and reference it, or restructure the notes if your documentation system allows for more granular content control.
References
- The style guide advises to avoid unnecessary words and repetition. (link)
ti-chi-bot
bot
added
size/M
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@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. |
hfxsd
changed the title
|
Replaced by #22232 |
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Add Permissions for Restore
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?