Skip to content

tikv: improve the note for s3-multi-part-size (#23362) - #23366

Open
ti-chi-bot wants to merge 6 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23362-to-master
Open

tikv: improve the note for s3-multi-part-size (#23362)#23366
ti-chi-bot wants to merge 6 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23362-to-master

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Jul 28, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23362

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

In real-world scenarios, a small percentage of customers still exceed their S3 API quotas, making this configuration still valuable. Since there is no other workaround and the configuration will not be removed, this update replaces the word "deprecated" with "configure with caution." This aims to reduce the hesitation or mental burden for customers who genuinely need to use it to resolve their issues.

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)

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

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Updated guidance for the backup.s3-multi-part-size setting.
    • Added recommendations for careful configuration and warnings about upload failures or timeouts when using values that are too large on unstable networks.

@ti-chi-bot ti-chi-bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ok-to-test Indicates a PR is ready to be tested. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. labels Jul 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign oreoxmt for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details 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

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

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: 5e72d463-bb8a-4720-9062-57a5fd8641a7

📥 Commits

Reviewing files that changed from the base of the PR and between 24494e7 and d7b539b.

📒 Files selected for processing (1)
  • tikv-configuration-file.md

📝 Walkthrough

Walkthrough

Updates the backup.s3-multi-part-size documentation to provide cautious configuration guidance from TiDB v6.1.1 onward and warn about multipart upload failures or timeouts with oversized parts on unstable networks.

Changes

S3 multipart size documentation

Layer / File(s) Summary
Update multipart size guidance
tikv-configuration-file.md
Replaces the previous deprecation note with guidance on S3 rate-limiting failures, cautious configuration, and oversized multipart upload risks.

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

Possibly related PRs

  • pingcap/docs#23362: Updates the same configuration note with effectively identical guidance.

Suggested reviewers: qiancai, mittalrishabh, lilin90

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the doc note update for s3-multi-part-size.
Description check ✅ Passed The description mostly matches the template and includes scope, versions, and cherry-pick context, though the change-summary section is sparse.
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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ok-to-test Indicates a PR is ready to be tested. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants