add tiup no-sudo doc #19753

Yujie-Xie · 2025-02-08T08:47:00Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

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

What is the related PR or file link(s)?

This PR is translated from:add tiup no-sudo doc docs#20179
Other reference 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

CLAassistant · 2025-02-08T08:47:06Z

All committers have signed the CLA.

ti-chi-bot · 2025-02-08T08:47:09Z

Welcome @Yujie-Xie!

It looks like this is your first PR to pingcap/docs-cn 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to pingcap/docs-cn. 😃

ti-chi-bot · 2025-02-08T08:47:10Z

Hi @Yujie-Xie. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

ti-chi-bot · 2025-02-10T03:58:30Z

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

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.

tiup/tiup-cluster-no-sudo-mode.md

tiup/tiup-cluster-topology-reference.md

Co-authored-by: xixirangrang <hfxsd@hotmail.com>

tiup/tiup-cluster-no-sudo-mode.md

ti-chi-bot · 2025-02-11T03:52:15Z

[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 ask for approval from hfxsd, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

hfxsd · 2025-02-11T05:35:34Z

/retest

hfxsd · 2025-02-11T06:07:23Z

/ok-to-test

TOC.md

tiup/tiup-cluster-no-sudo-mode.md

Co-authored-by: xixirangrang <hfxsd@hotmail.com>

tiup/tiup-cluster-no-sudo-mode.md

lilin90 · 2025-02-18T09:27:14Z

tiup/tiup-cluster-no-sudo-mode.md

@@ -0,0 +1,212 @@
+---
+title: 使用 TiUP no-sudo 模式部署运维 TiDB 线上集群
+summary: 介绍如何使用 TiUP no-sudo 模式部署运维 TiDB 线上集群


Suggested change

summary: 介绍如何使用 TiUP no-sudo 模式部署运维 TiDB 线上集群

summary: 了解如何使用 TiUP no-sudo 模式部署运维 TiDB 线上集群。

lilin90 · 2025-02-18T09:42:14Z

tiup/tiup-cluster-no-sudo-mode.md

+
+## 准备用户并配置 SSH 互信
+
+1. 以 `tidb` 用户为例，你需要依次登录到所有的部署目标机器，并以 `root` 用户使用如下命令创建一个普通用户 `tidb`。在 no-sudo 模式下，不需要为 `tidb` 用户配置 sudo 免密，即无需将 `tidb` 用户加入 `sudoers` 中。


Suggested change

1. 以 `tidb` 用户为例，你需要依次登录到所有的部署目标机器，并以 `root` 用户使用如下命令创建一个普通用户 `tidb`。在 no-sudo 模式下，不需要为 `tidb` 用户配置 sudo 免密，即无需将 `tidb` 用户加入 `sudoers` 中。

1. 以 `tidb` 用户为例。依次登录所有的部署目标机器，并以 `root` 用户使用如下命令创建一个普通用户 `tidb`。在 no-sudo 模式下，不需要为 `tidb` 用户配置 sudo 免密，即无需将 `tidb` 用户加入 `sudoers` 文件中。

lilin90 · 2025-02-18T09:54:51Z

tiup/tiup-cluster-no-sudo-mode.md

+                  └─3358 /usr/bin/pulseaudio --daemonize=no --log-target=journal
+        ```
+
+        执行 `systemctl --user`。如果没有报错，说明 `systemd user` 模式已经正常启动。


建议采用子步骤，因为是一个具体操作。

Suggested change

执行 `systemctl --user`。如果没有报错，说明 `systemd user` 模式已经正常启动。

3. 执行 `systemctl --user`。如果没有报错，说明 `systemd` user 模式已经正常启动。

lilin90 · 2025-02-18T09:58:42Z

tiup/tiup-cluster-no-sudo-mode.md

+    3. 使用 `root` 用户执行以下命令，为 systemd 用户 `tidb` 启用驻留。
+
+        ```bash
+        loginctl enable-linger tidb
+        ```
+
+        更多详情，请参考 [systemd 用户实例的自动启动](https://wiki.archlinux.org/title/Systemd/User#Automatic_start-up_of_systemd_user_instances)。
+
+3. 在中控机使用 ssh-keygen 生成密钥，并将公钥复制到其他部署机器，完成 SSH 互信。


这里开始建议另起一个 step 3，上面 systemd user 模式正常启动已完成 step 2。

使用 ssh-keygen 这一步是否要提供具体的操作命令？

Suggested change

3. 使用 `root` 用户执行以下命令，为 systemd 用户 `tidb` 启用驻留。

```bash

loginctl enable-linger tidb

```

更多详情，请参考 [systemd 用户实例的自动启动](https://wiki.archlinux.org/title/Systemd/User#Automatic_start-up_of_systemd_user_instances)。

3. 在中控机使用 ssh-keygen 生成密钥，并将公钥复制到其他部署机器，完成 SSH 互信。

3. 使用 `root` 用户执行以下命令，为 systemd 用户 `tidb` 启用驻留。

```bash

loginctl enable-linger tidb

```

更多详情，参见 [systemd 用户实例的自动启动](https://wiki.archlinux.org/title/Systemd/User#Automatic_start-up_of_systemd_user_instances)。

4. 在中控机上使用 `ssh-keygen` 生成密钥，并将公钥复制到其他部署机器，完成 SSH 互信。

lilin90 · 2025-02-18T10:19:25Z

tiup/tiup-cluster-no-sudo-mode.md

+
+2. 编辑拓扑文件。
+
+    相比以往的模式，使用 no-sudo 模式的 TiUP 时，需要在 `topology.yaml` 的 `global` 模块中新增一行 `systemd_mode: "user"`。该 `systemd_mode` 参数用于设置是否使用 `systemd user` 模式。如果不设置该参数，其默认值为 `system`，表示需要使用 sudo 权限。


这里“以往的”是指 sudo 模式吗？

Suggested change

相比以往的模式，使用 no-sudo 模式的 TiUP 时，需要在 `topology.yaml` 的 `global` 模块中新增一行 `systemd_mode: "user"`。该 `systemd_mode` 参数用于设置是否使用 `systemd user` 模式。如果不设置该参数，其默认值为 `system`，表示需要使用 sudo 权限。

相比以往的 sudo 模式，使用 no-sudo 模式的 TiUP 时，需要在 `topology.yaml` 的 `global` 模块中新增一行 `systemd_mode: "user"`。该 `systemd_mode` 参数用于设置是否使用 `systemd user` 模式。如果不设置该参数，其默认值为 `system`，表示需要使用 sudo 权限。

lilin90 · 2025-02-19T02:25:48Z

tiup/tiup-cluster-no-sudo-mode.md

+    adduser tidb
+    ```
+
+2. 在每台部署目标机器上，为 `tidb` 用户启动 `systemd user` 模式。该步骤是必须的，请勿跳过。


英文里只给 systemd 加了行内代码格式，请确认下保持两边一致。

add tiup no-sudo doc

0b1c966

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 8, 2025

Yujie-Xie added 3 commits February 8, 2025 16:49

add index

ae810b9

format optimization

544ab88

format optimization

4803aed

hfxsd added translation/from-docs This PR is translated from a PR in pingcap/docs. and removed missing-translation-status This PR does not have translation status info. labels Feb 10, 2025

kaaaaaaang approved these changes Feb 10, 2025

View reviewed changes

Update tiup-cluster-no-sudo-mode.md

e62b4c5

hfxsd reviewed Feb 10, 2025

View reviewed changes

Apply suggestions from code review

d86b4e0

Co-authored-by: xixirangrang <hfxsd@hotmail.com>

hfxsd reviewed Feb 10, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

hfxsd reviewed Feb 10, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

hfxsd reviewed Feb 11, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

hfxsd self-assigned this Feb 11, 2025

hfxsd reviewed Feb 11, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

Apply suggestions from code review

c230ef2

hfxsd added needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Feb 11, 2025

ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Feb 11, 2025

hfxsd added 3 commits February 11, 2025 14:29

Update tiup-cluster-no-sudo-mode.md

1dda6ae

Update tiup-cluster-no-sudo-mode.md

3716a64

Update tiup-cluster-no-sudo-mode.md

e8d44f5

hfxsd reviewed Feb 11, 2025

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

Update TOC.md

83d9203

hfxsd requested a review from lilin90 February 11, 2025 08:57

hfxsd and others added 3 commits February 11, 2025 22:26

Update tiup-cluster-no-sudo-mode.md

c3ed6a2

add new command

f48dec6

format optimization

725810f

hfxsd reviewed Feb 14, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

hfxsd reviewed Feb 14, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

Apply suggestions from code review

78dca1a

Co-authored-by: xixirangrang <hfxsd@hotmail.com>

Yujie-Xie commented Feb 14, 2025

View reviewed changes

tiup/tiup-cluster-no-sudo-mode.md Outdated Show resolved Hide resolved

Update tiup/tiup-cluster-no-sudo-mode.md

49cd466

lilin90 reviewed Feb 18, 2025

View reviewed changes

lilin90 reviewed Feb 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add tiup no-sudo doc #19753

add tiup no-sudo doc #19753

Yujie-Xie commented Feb 8, 2025 •

edited by hfxsd

Loading

CLAassistant commented Feb 8, 2025 •

edited

Loading

ti-chi-bot bot commented Feb 8, 2025

ti-chi-bot bot commented Feb 8, 2025

ti-chi-bot bot commented Feb 10, 2025

ti-chi-bot bot commented Feb 11, 2025

hfxsd commented Feb 11, 2025

hfxsd commented Feb 11, 2025

lilin90 Feb 18, 2025

lilin90 Feb 18, 2025

lilin90 Feb 18, 2025 •

edited

Loading

lilin90 Feb 18, 2025

lilin90 Feb 18, 2025

lilin90 Feb 19, 2025

	summary: 介绍如何使用 TiUP no-sudo 模式部署运维 TiDB 线上集群
	summary: 了解如何使用 TiUP no-sudo 模式部署运维 TiDB 线上集群。


		## 准备用户并配置 SSH 互信

		1. 以 `tidb` 用户为例，你需要依次登录到所有的部署目标机器，并以 `root` 用户使用如下命令创建一个普通用户 `tidb`。在 no-sudo 模式下，不需要为 `tidb` 用户配置 sudo 免密，即无需将 `tidb` 用户加入 `sudoers` 中。

	1. 以 `tidb` 用户为例，你需要依次登录到所有的部署目标机器，并以 `root` 用户使用如下命令创建一个普通用户 `tidb`。在 no-sudo 模式下，不需要为 `tidb` 用户配置 sudo 免密，即无需将 `tidb` 用户加入 `sudoers` 中。
	1. 以 `tidb` 用户为例。依次登录所有的部署目标机器，并以 `root` 用户使用如下命令创建一个普通用户 `tidb`。在 no-sudo 模式下，不需要为 `tidb` 用户配置 sudo 免密，即无需将 `tidb` 用户加入 `sudoers` 文件中。

	执行 `systemctl --user`。如果没有报错，说明 `systemd user` 模式已经正常启动。
	3. 执行 `systemctl --user`。如果没有报错，说明 `systemd` user 模式已经正常启动。


		2. 编辑拓扑文件。

		相比以往的模式，使用 no-sudo 模式的 TiUP 时，需要在 `topology.yaml` 的 `global` 模块中新增一行 `systemd_mode: "user"`。该 `systemd_mode` 参数用于设置是否使用 `systemd user` 模式。如果不设置该参数，其默认值为 `system`，表示需要使用 sudo 权限。

	相比以往的模式，使用 no-sudo 模式的 TiUP 时，需要在 `topology.yaml` 的 `global` 模块中新增一行 `systemd_mode: "user"`。该 `systemd_mode` 参数用于设置是否使用 `systemd user` 模式。如果不设置该参数，其默认值为 `system`，表示需要使用 sudo 权限。
	相比以往的 sudo 模式，使用 no-sudo 模式的 TiUP 时，需要在 `topology.yaml` 的 `global` 模块中新增一行 `systemd_mode: "user"`。该 `systemd_mode` 参数用于设置是否使用 `systemd user` 模式。如果不设置该参数，其默认值为 `system`，表示需要使用 sudo 权限。

add tiup no-sudo doc #19753

Are you sure you want to change the base?

add tiup no-sudo doc #19753

Conversation

Yujie-Xie commented Feb 8, 2025 • edited by hfxsd Loading

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

CLAassistant commented Feb 8, 2025 • edited Loading

ti-chi-bot bot commented Feb 8, 2025

ti-chi-bot bot commented Feb 8, 2025

ti-chi-bot bot commented Feb 10, 2025

ti-chi-bot bot commented Feb 11, 2025

hfxsd commented Feb 11, 2025

hfxsd commented Feb 11, 2025

lilin90 Feb 18, 2025

Choose a reason for hiding this comment

lilin90 Feb 18, 2025

Choose a reason for hiding this comment

lilin90 Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

lilin90 Feb 18, 2025

Choose a reason for hiding this comment

lilin90 Feb 18, 2025

Choose a reason for hiding this comment

lilin90 Feb 19, 2025

Choose a reason for hiding this comment

Yujie-Xie commented Feb 8, 2025 •

edited by hfxsd

Loading

CLAassistant commented Feb 8, 2025 •

edited

Loading

lilin90 Feb 18, 2025 •

edited

Loading