Skip to content

Refine tiflash FAQ and configuration docs (#20252) #20617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

ti-chi-bot
Copy link
Member

This is an automated cherry-pick of #20252

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • tiflash/create-tiflash-replicas.md
    • Added instructions for adjusting the remove-peer restriction when rebalancing Regions from old to new TiFlash nodes.
  • tiflash/tiflash-configuration.md
    • Removed the PD scheduling parameters section.
    • Clarified that floating-point numbers can be used for profiles.default.max_memory_usage_for_all_queries since v6.6.0.
    • Removed the multi-disk deployment eariler than v4.0.9 because that version reaches EOL
  • tiflash/troubleshoot-tiflash.md
    • Added a check for CPU support for vector extension instruction sets (AVX2 for AMD64, ARMv8 for ARM64).
    • Reorganized the 'TiFlash replica is always unavailable' section, providing a more structured approach to troubleshooting.
    • Removed the 'Data replication gets stuck' section and integrated its content into the 'TiFlash replica is always unavailable' section.

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 (in Chinese).

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)?

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

@ti-chi-bot ti-chi-bot added area/develop This PR relates to the area of TiDB App development. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm size/L Denotes a PR that changes 100-499 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Jul 4, 2025
@ti-chi-bot
Copy link
Member Author

@JaySon-Huang This PR has conflicts, I have hold it.
Please resolve them or ask others to resolve them, then comment /unhold to remove the hold label.

@hfxsd hfxsd removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 4, 2025
@hfxsd
Copy link
Collaborator

hfxsd commented Jul 4, 2025

/approve

Copy link

ti-chi-bot bot commented Jul 4, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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

The pull request process is described here

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 approved label Jul 4, 2025
@ti-chi-bot ti-chi-bot bot merged commit 12edb9f into pingcap:release-8.5 Jul 4, 2025
7 checks passed
@@ -1,32 +1,13 @@
---
title: TiFlash 配置参数
summary: TiFlash 配置参数包括 PD 调度参数和 TiFlash 配置参数。PD 调度参数可通过 pd-ctl 调整,包括 replica-schedule-limit 和 store-balance-rate。TiFlash 配置参数包括 tiflash.toml 和 tiflash-learner.toml,用于配置 TiFlash TCP/HTTP 服务的监听和存储路径。另外,通过拓扑 label 进行副本调度和多盘部署也是可行的。
aliases: ['/docs-cn/dev/tiflash/tiflash-configuration/','/docs-cn/dev/reference/tiflash/configuration/']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we remove these dev aliases for the release-8.5 branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/develop This PR relates to the area of TiDB App development. lgtm size/L Denotes a PR that changes 100-499 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants