Skip to content

deployment: clarify description about using the same user and UID/GID#22491

Merged
ti-chi-bot[bot] merged 7 commits intopingcap:masterfrom
hfxsd:add-uid-and-gid
Feb 27, 2026
Merged

deployment: clarify description about using the same user and UID/GID#22491
ti-chi-bot[bot] merged 7 commits intopingcap:masterfrom
hfxsd:add-uid-and-gid

Conversation

@hfxsd
Copy link
Collaborator

@hfxsd hfxsd commented Feb 25, 2026

First-time contributors' checklist

What is changed, added or deleted? (Required)

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)
  • 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

@hfxsd hfxsd self-assigned this Feb 25, 2026
@ti-chi-bot ti-chi-bot bot added the contribution This PR is from a community contributor. label Feb 25, 2026
@hfxsd hfxsd requested a review from xhebox February 25, 2026 09:26
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @hfxsd, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the deployment documentation by providing crucial clarifications regarding user management. It emphasizes the importance of consistent UID/GID values for the tidb user across all nodes, particularly when utilizing Backup & Restore with network file systems, to prevent potential permission-related failures. The changes aim to improve the clarity and robustness of the deployment process instructions.

Highlights

  • User Creation Clarification: Clarified the documentation regarding the creation of the tidb user, specifically addressing UID/GID consistency across nodes.
  • Backup & Restore (BR) and NFS Considerations: Added a strong recommendation for consistent UID and GID values for the tidb user on all nodes, especially when using Backup & Restore (BR) with network file systems like NFS, to prevent permission denied errors.
  • Updated useradd Command: Modified the useradd command example to explicitly create a home directory for the tidb user using the -m -d /home/tidb flags.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • check-before-deployment.md
    • Added a detailed explanation about the importance of consistent UID/GID values for the tidb user, especially in scenarios involving Backup & Restore (BR) and Network File System (NFS).
    • Updated the useradd command to include options for creating a home directory for the tidb user.
Activity
  • The author has signed the Contributor License Agreement.
  • The author has indicated that the changes apply to the master and v8.5 versions.
  • The pull request is a translation from pingcap/docs-cn/pull/21388.
  • No human review comments or progress updates have been recorded yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@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 Feb 25, 2026
@hfxsd hfxsd added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. ONCALL Relates to documentation oncall. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed contribution This PR is from a community contributor. 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 Feb 25, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request clarifies the requirements for UID/GID consistency for the tidb user, especially when using Backup & Restore with NFS. The change is accurate and helpful. I've suggested a minor revision to the new paragraph to better align with the documentation style guide, focusing on using the second person and active voice for clearer instructions.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@ti-chi-bot ti-chi-bot bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 26, 2026
@hfxsd hfxsd requested a review from Oreoxmt February 27, 2026 02:17
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 27, 2026

@xhebox: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Collaborator

@Oreoxmt Oreoxmt left a comment

Choose a reason for hiding this comment

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

Rest LGTM

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Feb 27, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 27, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-02-27 06:15:55.170328983 +0000 UTC m=+422027.685123592: ☑️ agreed by Oreoxmt.

Co-authored-by: Aolin <aolinz@outlook.com>
@hfxsd hfxsd added the lgtm label Feb 27, 2026
@hfxsd
Copy link
Collaborator Author

hfxsd commented Feb 27, 2026

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 27, 2026

[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

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 approved label Feb 27, 2026
@ti-chi-bot ti-chi-bot bot merged commit c7b4a4d into pingcap:master Feb 27, 2026
11 of 12 checks passed
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22507.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants