Repository navigation
Fix TiUP deployment doc inconsistencies - #24451
doc-claw-bot wants to merge 1 commit into
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 |
📝 Walkthrough
Merge Risk: 🔵 Low · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Docstring Coverage |  |
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 | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
| Title check | |
The title clearly summarizes the main change: fixing inconsistencies in TiUP deployment documentation. |
| Description check | |
The description follows the required template, explains all documentation changes, identifies affected versions, provides a reference link, and completes the applicable checkboxes. |
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · 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.
Comment @coderabbitai help to get the list of available commands.
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
aaf2cebe-2c1c-4fb6-98eb-029d69f4b9cb
📒 Files selected for processing: 3
check-before-deployment.mdpost-installation-check.mdproduction-deployment-using-tiup.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.
| swapoff -a | ||
| ``` | ||
|
|
||
| - To keep swap disabled after a reboot, remove or comment out the corresponding swap entry in `/etc/fstab`. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
set -o pipefail
printf '%s\n' '--- PR diff for target file ---'
git diff --no-ext-diff --unified=30 f515483d161b557aabede94f1e3fd784bcd69d78 9146c0654bdc363b9ea398b64e051da731ed2c1b -- check-before-deployment.md
printf '%s\n' '--- current file: swap section ---'
nl -ba check-before-deployment.md | sed -n '90,135p'
printf '%s\n' '--- deployment host/platform references ---'
rg -n -i -F --glob '*.md' -e 'supported operating system' -e 'operating system' -e 'Ubuntu' -e 'CentOS' -e 'RHEL' -e 'systemd' -e 'GPT' -e 'swap' -- . | sed -n '1,240p'Repository: pingcap/docs
Length of output: 41432
🏁 Script executed:
set -o pipefail
printf '%s\n' '--- target metadata and links ---'
sed -n '1,45p' check-before-deployment.md
rg -n -F --glob '*.md' -e 'OS and platform requirements' -e 'Operating system and platform' -e 'systemd' -e 'GPT' hardware-and-software-requirements.md production-deployment-using-tiup.md faq/deploy-and-maintain-faq.md check-before-deployment.md || test "$?" -eq 1
printf '%s\n' '--- supported OS requirements ---'
nl -ba hardware-and-software-requirements.md | sed -n '1,180p'
printf '%s\n' '--- TiUP deployment prerequisites and service manager references ---'
nl -ba production-deployment-using-tiup.md | sed -n '1,180p'Repository: pingcap/docs
Length of output: 21101
🌐 Web query:
systemd-gpt-auto-generator swap partition GPT type fstab official documentation
💡 Result:
**Yes—systemd can activate a GPT swap partition without an `/etc/fstab` entry.** `systemd-gpt-auto-generator` discovers swap partitions with GPT type GUID `0657fd6d-a4ab-43c4-84e5-0933c84b4f4f` (`SD_GPT_SWAP`), provided they’re on the same physical disk as the root partition. ([manpages.debian.org](https://manpages.debian.org/unstable/systemd/systemd-gpt-auto-generator.8.en.html))
The generator is enabled by default. An `/etc/fstab` swap entry is also supported, but the fstab generator handles that separately; GPT discovery is intended to make fstab configuration unnecessary. ([manpages.debian.org](https://manpages.debian.org/unstable/systemd/systemd-gpt-auto-generator.8.en.html))
Citations:
- 1: https://manpages.debian.org/unstable/systemd/systemd-gpt-auto-generator.8.en.html
- 2: https://manpages.debian.org/unstable/systemd/systemd-gpt-auto-generator.8.en.html
Cover GPT-discovered swap partitions.
On supported Linux hosts that use systemd-gpt-auto-generator, a GPT-typed swap partition on the root disk can be activated without an /etc/fstab entry. Removing or commenting out that entry may therefore not keep swap disabled after reboot.
Document the supported method to disable automatic activation for GPT-discovered swap partitions.
What is changed, added, or deleted? (Required)
Fix four deployment-doc inconsistencies in the TiDB Self-Managed guides:
v6.1.0NUMA deployment example with the version placeholderv{{{ .tidb-version }}}tiup cluster start --initrequire-pwhen logging in asrootWhich 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
--init, including guidance to enter the generated password.