v7.5.7: br: support imdsv2 to retrive IAM Role (#18934) #21464
Conversation
ti-chi-bot
added
lgtm
size/XS
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 updates the documentation for the Backup & Restore (BR) tool to reflect its compatibility with AWS EC2 Instance Metadata Service Version 2 (IMDSv2). The changes provide essential guidance on version-specific support and necessary configurations, especially in light of recent AWS policy changes regarding IMDSv2 as the default for new instances.
Highlights
- Documentation Update for IMDSv2 Support: A new note has been added to the
backup-and-restore-storages.mdfile, clarifying the Backup & Restore (BR) tool's support for AWS EC2 Instance Metadata Service Version 2 (IMDSv2). - Version Specificity: The documentation now explicitly states that BR supports obtaining IAM role permissions on Amazon EC2 instances with only IMDSv2 enabled starting from v8.4.0.
- Backward Compatibility Guidance: For users operating BR with versions prior to v8.4.0, the updated documentation advises configuring the EC2 instance to support both IMDSv1 and IMDSv2.
- AWS Contextual Information: The note includes important context regarding AWS's 2024 change, where newly created instances now default to supporting only IMDSv2, providing a clear reason for this update.
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 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 or fill out our survey 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
-
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. ↩
Oreoxmt
added
the
do-not-merge/hold
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to reflect BR's support for AWS IMDSv2. The change is clear and adds important information for users who rely on IAM roles for S3 access. I've made one suggestion to rephrase the new note for better clarity and conciseness, referencing the style guide's rules on avoiding repetition and using active voice.
Oreoxmt
changed the title
Co-authored-by: Aolin <[email protected]>
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #18934
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?