[pingcap/tidb#46609] support s3 profile for dumpling

[takaidohigasi]

First-time contributors' checklist

• I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

add s3 profile support document for dumpling

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.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
  br: support s3 profile config tidb#62199
• Might cause conflicts after applied to another branch

Summary by CodeRabbit

• Documentation
  • Updated Amazon S3 export credentials guidance to support reading AWS credentials from the local credentials file and using AWS profiles.
  • Added examples for exporting with the default profile and specifying a different profile.
  • Removed outdated instructions that relied on environment variables for access keys.

[ti-chi-bot]

Hi @takaidohigasi. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

[gemini-code-assist]

Summary of Changes

Hello @takaidohigasi, I'm Gemini Code Assist¹! 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 is a documentation update for TiDB's data export utility, Dumpling. It clarifies and expands on the methods available for authenticating with AWS S3, specifically noting the newly introduced support for S3 profiles. This enhancement ensures that users have comprehensive information regarding credential handling when exporting data to S3.

Highlights

• Documentation Update: The dumpling-overview.md documentation has been updated to reflect that Dumpling, the data export tool, now supports using S3 profiles for credential management. This is in addition to its existing support for reading credentials from ~/.aws/credentials.

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

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

[gemini-code-assist]

Code Review

This pull request updates the Dumpling documentation to mention support for S3 profiles. My review focuses on improving the clarity and grammar of the new text to ensure users can easily understand how to use this feature.

[takaidohigasi]

Implementation was merged, and I'm happy if you can remove needs-ok-to-test label. thanks!

[takaidohigasi]

this change was merged and maybe released with 8.5.3, but document is not merged and there isn't release note for it.

https://docs.pingcap.com/tidb/stable/release-8.5.3/

[lance6716]

/ok-to-test

[lance6716]

this change was merged and maybe released with 8.5.3, but document is not merged and there isn't release note for it.

https://docs.pingcap.com/tidb/stable/release-8.5.3/

Don't worry, the PR is not cherry-picked to v8.5.3

/cc @qiancai PTAL

[ti-chi-bot]

@lance6716: GitHub didn't allow me to request PR reviews from the following users: PTAL.

Note that only pingcap members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

In response to this:

this change was merged and maybe released with 8.5.3, but document is not merged and there isn't release note for it.

https://docs.pingcap.com/tidb/stable/release-8.5.3/

Don't worry, the PR is not cherry-picked to v8.5.3

/cc @qiancai PTAL

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.

[takaidohigasi]

thanks for the review

[ti-chi-bot]

[LGTM Timeline notifier]

Timeline:

• 2025-08-22 12:31:29.60392043 +0000 UTC m=+615897.547095946: ☑️ agreed by qiancai.
• 2025-08-27 09:59:13.886440441 +0000 UTC m=+347845.764271405: ☑️ agreed by lance6716.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1d80ccaa-411c-47d5-8137-3c341f84e98b

📥 Commits

Reviewing files that changed from the base of the PR and between 572b97f and a849165.

📒 Files selected for processing (1)

• dumpling-overview.md

---

📝 Walkthrough

Walkthrough

The S3 export documentation now explains reading credentials from ~/.aws/credentials, using the default profile, and selecting a specific profile with --s3.profile. Environment-variable credential instructions were removed.

Changes

S3 credential documentation

Layer / File(s)	Summary
Update AWS credential instructions dumpling-overview.md	The S3 section documents AWS credential files, the default profile, and named profiles through --s3.profile, replacing the previous environment-variable example.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly states the main change: adding S3 profile support documentation for Dumpling.
Description check	✅ Passed	The description follows the template and includes the change, version scope, and branch-modification note.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[qiancai]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment