Add export backup guide for S3 and GCS. #22263
Conversation
ti-chi-bot
bot
added
contribution
|
Hi @ginkgoch. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
ti-chi-bot
bot
added
the
needs-ok-to-test
Summary of ChangesHello @ginkgoch, 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 enhances the TiDB Cloud documentation by providing new guides for exporting database backups to external cloud storage solutions. It specifically adds detailed, step-by-step instructions for users to export their backups to both AWS S3 and Google Cloud Storage, ensuring greater flexibility and control over backup management. 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
|
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 adds documentation for exporting backups to AWS S3 and Google Cloud Storage. The changes are clear and well-structured. I've provided a few suggestions to improve clarity, conciseness, and adherence to the style guide. These include making some phrases more specific, removing a redundant sentence, and making instructions more actionable for the user.
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>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@Kensleycc: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn 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. |
hfxsd
added
translation/no-need
|
[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 |
|
/cc @Oreoxmt |
|
/ok-to-test |
ti-chi-bot
bot
added
ok-to-test
|
@ginkgoch: 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. |
| <div label="Amazon S3"> | ||
|
|
||
| To export a specific backup to cloud storage, such as and Google Cloud Storage, perform the following steps: |
There was a problem hiding this comment.
| <div label="Amazon S3"> | |
| To export a specific backup to cloud storage, such as and Google Cloud Storage, perform the following steps: | |
| To export a specific backup to cloud storage, such as Amazon S3 or Google Cloud Storage, follow the steps for your target storage provider. |
| <SimpleTab> | ||
|
|
||
| <div label="Amazon S3"> | ||
|
|
There was a problem hiding this comment.
| To export a backup to Amazon S3, perform the following steps: | |
|
|
||
| 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. | ||
|
|
||
| 2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. |
There was a problem hiding this comment.
| 2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. | |
| 2. Locate the backup you want to export, and then click **...** > **Export** in the **Action** column. |
|
|
||
| 2. Locate the backup you want to export, and click **...** > **Export** in the **Action** column. | ||
|
|
||
| 3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI**, and then select a bucket region for the backup bucket. |
There was a problem hiding this comment.
| 3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI**, and then select a bucket region for the backup bucket. | |
| 3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI** field, and then select a bucket region for the backup bucket. |
|
|
||
| 3. In the **Export Backup to Amazon S3** dialog, enter the **Folder URI**, and then select a bucket region for the backup bucket. | ||
|
|
||
| 4. Click **Generate Command** to see the command for configuring permissions. |
There was a problem hiding this comment.
| 4. Click **Generate Command** to see the command for configuring permissions. | |
| 4. Click **Generate Command** to view the command for configuring permissions. |
| - **With AWS Console**: | ||
|
|
||
| 1. Navigate to the [Amazon S3 console](https://console.aws.amazon.com/s3/). | ||
| 2. Go to the bucket detail page, and then switch to the **Permissions** tab. |
There was a problem hiding this comment.
| 2. Go to the bucket detail page, and then switch to the **Permissions** tab. | |
| 2. Open the target bucket details page, and then click the **Permissions** tab. |
|
|
||
| 1. Navigate to the [Amazon S3 console](https://console.aws.amazon.com/s3/). | ||
| 2. Go to the bucket detail page, and then switch to the **Permissions** tab. | ||
| 3. Scroll down to **Bucket Policy**, and then click **Edit**. |
There was a problem hiding this comment.
| 3. Scroll down to **Bucket Policy**, and then click **Edit**. | |
| 3. Scroll to **Bucket policy**, and then click **Edit**. |
| 2. Go to the bucket detail page, and then switch to the **Permissions** tab. | ||
| 3. Scroll down to **Bucket Policy**, and then click **Edit**. | ||
| 4. Copy the policy content from the generated command, and then paste it into the policy editor. | ||
| 5. Click **Save Changes**. |
There was a problem hiding this comment.
| 5. Click **Save Changes**. | |
| 5. Click **Save changes**. |
|
|
||
| <div label="Google Cloud Storage"> | ||
|
|
||
| To export a specific backup to Google Cloud Storage, perform the following steps: |
There was a problem hiding this comment.
| To export a specific backup to Google Cloud Storage, perform the following steps: | |
| To export a backup to Google Cloud Storage, perform the following steps: |
|
|
||
| 3. In the **Export Backup to Google Cloud Storage** dialog, note down the **Google Cloud Service Account ID**, which is required for a later step. | ||
|
|
||
| 4. In the [Google Cloud console](https://console.cloud.google.com/), create a custom IAM role, or make sure that an existing role has the following permissions: |
There was a problem hiding this comment.
| 4. In the [Google Cloud console](https://console.cloud.google.com/), create a custom IAM role, or make sure that an existing role has the following permissions: | |
| 4. In the [Google Cloud console](https://console.cloud.google.com/), create a custom IAM role with the following permissions. If you use an existing role, verify that it has these permissions. |
| - `storage.objects.create` | ||
| - `storage.objects.delete` | ||
|
|
||
| 5. In **Cloud Storage** > **Buckets**, select the target bucket, and then go to **Permissions** > **Grant Access**. |
There was a problem hiding this comment.
| 5. In **Cloud Storage** > **Buckets**, select the target bucket, and then go to **Permissions** > **Grant Access**. | |
| 5. Go to **Cloud Storage** > **Buckets**, select the target bucket, and then click **Permissions** > **Grant Access**. |
|
|
||
| 5. In **Cloud Storage** > **Buckets**, select the target bucket, and then go to **Permissions** > **Grant Access**. | ||
|
|
||
| 6. In **New principals**, enter the **Service Account ID** that you noted down in Step 3, select the role from Step 4, and then click **Save**. |
There was a problem hiding this comment.
| 6. In **New principals**, enter the **Service Account ID** that you noted down in Step 3, select the role from Step 4, and then click **Save**. | |
| 6. In **New principals**, enter the **Service Account ID** from step 3, assign the role from step 4, and then click **Save**. |
|
|
||
| 6. In **New principals**, enter the **Service Account ID** that you noted down in Step 3, select the role from Step 4, and then click **Save**. | ||
|
|
||
| 7. Switch to the **Configuration** tab, copy the **gsutil URI**, and then paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. You can append a path suffix to the URI to create a subdirectory. |
There was a problem hiding this comment.
| 7. Switch to the **Configuration** tab, copy the **gsutil URI**, and then paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. You can append a path suffix to the URI to create a subdirectory. | |
| 7. Open the **Configuration** tab, copy the **gsutil URI**, and paste it into the **Export Path** field in the **Export Backup to Google Cloud Storage** dialog. To export to a subdirectory, append a path suffix to the URI. |
[LGTM Timeline notifier]Timeline:
|
4 participants
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?