Skip to content

docs: remove outdated CentOS 7 quick start recommendation - #24256

Open
doc-claw-bot wants to merge 2 commits into
pingcap:masterfrom
doc-claw-bot:docs/quick-start-os-recommendation
Open

doc-claw-bot wants to merge 2 commits into
pingcap:masterfrom
doc-claw-bot:docs/quick-start-os-recommendation

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

What is changed, added, or deleted? (Required)

  • Replace the outdated CentOS 7.3/7.6 recommendations in quick-start-with-tidb.md with guidance to use a TiDB-supported Linux distribution.
  • Fix the cleanup steps in the simulated production deployment section to use tiup cluster stop and tiup cluster destroy instead of the Playground-only Ctrl+C and tiup clean --all flow.
  • Fix two issues in basic-features.md: mark authentication_ldap_sasl as supported in v7.1 and correct Transparent layer security to Transport Layer Security.

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)

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 TiDB deployment guidance to reference supported Linux distributions and CPU architectures.
    • Revised cleanup steps to stop and destroy the TiUP cluster.
    • Corrected the TLS name and updated LDAP SASL authentication support status to version 7.1.

@ti-chi-bot

ti-chi-bot Bot commented Oct 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 breezewish 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 contribution This PR is from a community contributor. label Oct 8, 2026
@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 8, 2026
@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

📝 Walkthrough
📝 Walkthrough

Walkthrough

The quick-start guide updates platform requirements and TiUP cluster cleanup instructions. The basic features table corrects the TLS label and marks LDAP SASL authentication as supported in version 7.1.

Changes

Deployment guidance

Layer / File(s) Summary
Update platform requirements
quick-start-with-tidb.md
The deployment prerequisite now refers to supported Linux distributions. The architecture guidance links to supported OS and CPU architecture combinations for TiUP cluster deployments.
Update cluster cleanup
quick-start-with-tidb.md
The guide now instructs readers to stop the named TiUP cluster, then destroy it with tiup cluster destroy.

Feature availability

Layer / File(s) Summary
Update security feature entries
basic-features.md
The TLS feature label is corrected to “Transport Layer Security.” LDAP SASL authentication is marked supported in version 7.1.

Priority: ➖ Normal

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

Change: Other



Merge Risk: 🔵 Low · up to d074b

Add a warning that the cleanup command deletes cluster data. The potential impact is limited to readers who run it on a cluster containing data they intend to keep.

Architecture Summary

Architecture risk: 🔵 Low · up to d074b

The change affects 2 systems.

Changed systems: basic-features.md, quick-start-with-tidb.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — basic-features.md (service) was modified; 1 changed file maps to changed impact.
  • observed — quick-start-with-tidb.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in basic-features.md: Renames the TLS feature label from “Transparent layer security” to “Transport Layer Security”; the version availability values remain unchanged.
  • observed — Modified behavior in basic-features.md: Changes authentication_ldap_sasl availability for version 7.1 from N to Y; the other version values are unchanged.
  • observed — Modified behavior in quick-start-with-tidb.md: Replaces the CentOS 7.3-or-later prerequisite with a requirement for a TiDB-supported Linux distribution and a link to current OS recommendations.
  • observed — Modified behavior in quick-start-with-tidb.md: Replaces the AMD64 and ARM-specific CentOS recommendations with a link to supported operating system and CPU architecture combinations for TiUP cluster deployments.


Pre-merge checks | Passed 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 identifies the primary documentation change: removing the outdated CentOS 7 quick-start recommendation. It does not mention every secondary correction, which is acceptable.
Description check Passed The description includes the required change summary, affected versions, reference links, AI involvement, and scope checkboxes. The required sections are complete and relevant.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR



  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@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-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Oct 8, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 8, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔇 Additional comments (1)
quick-start-with-tidb.md-292-292 (1)

292-292: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.

Specify ARM 64 explicitly.

The linked requirements list ARM 64 and require a 64-bit CPU. “ARM architectures” can include 32-bit ARM, so this sentence overstates the supported architectures.

- Currently, the TiUP cluster supports deploying TiDB on the x86_64 (AMD64) and ARM 64 architectures. For supported operating system and CPU architecture combinations, see [OS and platform requirements](/hardware-and-software-requirements.md#os-and-platform-requirements).

As per path instructions: “For every actionable issue, provide a GitHub committable suggestion block containing the exact replacement text whenever the fix can be safely and completely applied to contiguous lines in the diff.”

Source: Path instructions


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: cfe41530-ea2e-4e3b-b10c-7a6b7471929e
📥 Commits

Reviewing files that changed from the base of the PR and between 73c1955 and c61e5cb.

📒 Files selected for processing (1)
  • quick-start-with-tidb.md

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

@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 Oct 12, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 7b4158fd-f06b-4381-8d5c-c0056cc34228
📥 Commits

Reviewing files that changed from the base of the PR and between c61e5cb and d074bf4.

📒 Files selected for processing (2)
  • basic-features.md
  • quick-start-with-tidb.md

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

Comment thread quick-start-with-tidb.md
tiup cluster stop <cluster-name>
```

2. Destroy the cluster after it is stopped:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

State that destroying the cluster deletes its data.

tiup cluster destroy deletes service log, deployment, and data directories. State this effect before the command so readers know this cleanup step removes more than running services.

    2. Destroy the cluster after it is stopped. This command deletes the cluster's log, deployment, and data directories.

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-release-8.5 Should cherry pick this PR to release-8.5 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