docs: clarify OS platform validation coverage - #23625
Conversation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
missing-translation-status
📝 WalkthroughWalkthroughThe documentation updates the descriptions of tested and validated platforms and compatible platforms. The revised text covers validation methods, production deployment recommendations, supported workloads, and subscription-based support confirmation. ChangesPlatform Requirements
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to The PR clarifies OS platform validation coverage without changing product behavior. A minor ambiguity remains in the nearby 32-bit support wording, but it is localized and does not present an actionable merge-blocking risk. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation 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 files. (1 skipped: 1 unsupported.) Full details: Description checkExplanation The description includes the required change summary and affected TiDB version, plus the reference, AI involvement, and change-category sections. The selected v8.5 version matches the stated objective. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
hardware-and-software-requirements.md (1)
129-129: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winClarify the 32-bit support boundary.
Line 129 joins two different conditions with “or”. Readers may not know whether the limitation applies to compilation, deployment, active adaptation, or all three. Replace the sentence with two direct statements.
Committable wording
- If you are using the 32-bit version of an operating system listed in the preceding two tables, TiDB **is not guaranteed** to be compilable, buildable or deployable on the 32-bit operating system and the corresponding CPU architecture, or TiDB does not actively adapt to the 32-bit operating system. + If you use a 32-bit version of an operating system listed in the preceding two tables, TiDB is not guaranteed to compile, build, or deploy on that operating system or its corresponding CPU architecture. + TiDB does not actively adapt to 32-bit operating systems.As per path instructions, use a committable suggestion for a contiguous Markdown fix and preserve the document's technical meaning.
Source: Path instructions
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 6432143d-5fd8-4eb3-8193-cfebea03b3a6
📒 Files selected for processing (1)
hardware-and-software-requirements.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
| In v8.5 LTS, TiDB ensures multi-level quality standards for various combinations of operating systems and CPU architectures. | ||
|
|
||
| + For the following combinations of operating systems and CPU architectures, TiDB **provides enterprise-level production quality**, and the product features have been comprehensively and systematically verified: | ||
| + **Tested and validated platforms.** In the following operating system and CPU architecture combinations, each TiDB release is fully validated through PingCAP's systematic test matrix. These combinations are recommended for production deployment. |
There was a problem hiding this comment.
| + **Tested and validated platforms.** In the following operating system and CPU architecture combinations, each TiDB release is fully validated through PingCAP's systematic test matrix. These combinations are recommended for production deployment. | |
| + **Tested and validated platforms.** For the following combinations of operating systems and CPU architectures, each TiDB release is validated against PingCAP's systematic test matrix. These combinations are recommended for production deployment. |
There was a problem hiding this comment.
Reason:
- "In the following ... combinations" is less idiomatic than "For the following combinations of ...".
- "fully validated" is unnecessarily absolute and could imply exhaustive validation beyond the defined test matrix.
- "Validated against PingCAP's systematic test matrix" more precisely communicates that the distinction is based on release QA coverage rather than an absolute product-quality guarantee.
| > Support for Red Hat Enterprise Linux 9.x starts from [TiUP](https://github.com/pingcap/tiup/releases) v1.16.5. | ||
|
|
||
| + For the following combinations of operating systems and CPU architectures, you can compile, build, and deploy TiDB. In addition, you can also use the basic features of OLTP, OLAP, and the data tools. However, because these combinations have not undergone comprehensive and systematic testing, TiDB **does not guarantee enterprise-level production quality**: | ||
| + **Compatible platforms.** In the following combinations, TiDB can compile, build, and deploy, and supports OLTP, OLAP, and the data tools. These combinations are not included in the systematic per-release test matrix; compatibility is verified through build and deployment verification and extensive production usage by TiDB users. For production deployments on these platforms, contact PingCAP to confirm support coverage under your subscription. |
There was a problem hiding this comment.
| + **Compatible platforms.** In the following combinations, TiDB can compile, build, and deploy, and supports OLTP, OLAP, and the data tools. These combinations are not included in the systematic per-release test matrix; compatibility is verified through build and deployment verification and extensive production usage by TiDB users. For production deployments on these platforms, contact PingCAP to confirm support coverage under your subscription. | |
| + **Compatible platforms.** In the following combinations, TiDB can be compiled, built, and deployed, and supports OLTP, OLAP, and data tools. These combinations are not included in the systematic per-release test matrix; compatibility is verified through build and deployment verification and extensive production usage by TiDB users. For production deployments on these platforms, contact PingCAP to confirm support coverage under your subscription. |
| > Support for Red Hat Enterprise Linux 9.x starts from [TiUP](https://github.com/pingcap/tiup/releases) v1.16.5. | ||
|
|
||
| + For the following combinations of operating systems and CPU architectures, you can compile, build, and deploy TiDB. In addition, you can also use the basic features of OLTP, OLAP, and the data tools. However, because these combinations have not undergone comprehensive and systematic testing, TiDB **does not guarantee enterprise-level production quality**: | ||
| + **Compatible platforms.** In the following combinations, TiDB can compile, build, and deploy, and supports OLTP, OLAP, and the data tools. These combinations are not included in the systematic per-release test matrix; compatibility is verified through build and deployment verification and extensive production usage by TiDB users. For production deployments on these platforms, contact PingCAP to confirm support coverage under your subscription. |
There was a problem hiding this comment.
TBD, “build and deployment verification and extensive production usage by TiDB users.” is confusing, as it implies that all of these compatible combinations have been extensively verified and used in production envrionments too.
ti-chi-bot
Bot
removed
the
missing-translation-status
1 participant
What is changed, added or deleted? (Required)
Clarify the OS and platform requirements by describing the difference between tested and validated platforms and compatible platforms in terms of release test-matrix coverage. Remove wording that could be interpreted as indicating that TiDB is not production-ready on compatible platforms such as Ubuntu, while retaining the existing platform classifications and support boundaries.
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)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit