Skip to content

check-before-deployment: fix TuneD custom profile path - #23775

Open
doc-claw-bot wants to merge 2 commits into
pingcap:release-8.5from
doc-claw-bot:docs/fix-tuned-profile-path
Open

check-before-deployment: fix TuneD custom profile path#23775
doc-claw-bot wants to merge 2 commits into
pingcap:release-8.5from
doc-claw-bot:docs/fix-tuned-profile-path

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

  • Clarify the TuneD custom profile path in check-before-deployment.md.
  • Add version-specific command examples for both path formats:
    • TuneD earlier than v2.23.0: /etc/tuned/<profile_name>/tuned.conf
    • TuneD v2.23.0 and later: /etc/tuned/profiles/<profile_name>/tuned.conf
  • Explain that each path format is only recognized by its corresponding TuneD version range.

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)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)?

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 TuneD profile setup instructions with version-specific paths for releases earlier than v2.23.0 and for v2.23.0 and later.
    • Added a note clarifying that each path format applies only to its corresponding TuneD version range.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. labels Sep 8, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 8, 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 kissmydb 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

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 8, 2026
@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. needs-cherry-pick-master Should cherry pick this PR to master branch. and removed missing-translation-status This PR does not have translation status info. labels Sep 8, 2026
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview 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: Advanced

Run ID: c7c1433d-cfa5-4030-8640-f6a0896913e8

📥 Commits

Reviewing files that changed from the base of the PR and between 96dfa2b and 6836d0b.

📒 Files selected for processing (1)
  • check-before-deployment.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The deployment guide documents separate TuneD profile paths for versions before v2.23.0 and versions from v2.23.0 onward.

Changes

TuneD profile deployment

Layer / File(s) Summary
Update TuneD profile directory instructions
check-before-deployment.md
The commands use /etc/tuned/balanced-tidb-optimal/ before TuneD v2.23.0 and /etc/tuned/profiles/balanced-tidb-optimal/ from TuneD v2.23.0 onward. The guide states that each path applies only to its version range.

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

Merge Risk: ⚪ Minimal · up to 6836d

The deployment guide now directs users to the TuneD profile directory appropriate to their version, reducing the chance that a custom profile is not detected. No merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Title check ✅ Passed The title clearly and concisely identifies the main change: correcting the TuneD custom profile path in the deployment documentation.
Description check ✅ Passed The description explains the documentation changes, affected TuneD versions, applicable TiDB branches, reference links, AI involvement, and change classifications. It provides the required information…
✨ 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.

@ti-chi-bot ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 8, 2026
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. needs-cherry-pick-master Should cherry pick this PR to master branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant