Skip to content

update doc about tiup user #15663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −2
Open

update doc about tiup user #15663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions production-deployment-using-tiup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,16 +300,18 @@ For more configuration description, see the following configuration examples:

> **Note:**
>
> You can use secret keys or interactive passwords for security authentication when you deploy TiDB using TiUP:
> When deploying a cluster through TiUP, the user specified for initialization (via the --user parameter) can authenticate securely using either a key or interactive password when you deploy TiDB using TiUP:
>
> - If you use secret keys, specify the path of the keys through `-i` or `--identity_file`.
> - If you use passwords, add the `-p` flag to enter the password interaction window.
> - If password-free login to the target machine has been configured, no authentication is required.
>
> In general, TiUP creates the user and group specified in the `topology.yaml` file on the target machine, with the following exceptions:
> The user and group used by TiUP for executing related processes (specified via `topology.yaml`, defaults to tidb) are generally automatically created on the target machine, with the following exceptions:
>
> - The user name configured in `topology.yaml` already exists on the target machine.
> - You have used the `--skip-create-user` option in the command line to explicitly skip the step of creating the user.
>
> Regardless of whether the user and group specified in topology.yaml are automatically created or not, TiUP will generate a pair of SSH keys and set up passwordless login for that user on each machine. This user and SSH key will be used to manage the machine in subsequent operations, and the user and password used for initialization will no longer be used after deployment is complete.

Before you run the `deploy` command, use the `check` and `check --apply` commands to detect and automatically repair potential risks in the cluster:

Expand Down
1 change: 1 addition & 0 deletions quick-start-with-tidb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,7 @@ Other requirements for the target machine include:

- `<cluster-name>`: Set the cluster name
- `<version>`: Set the TiDB cluster version, such as `v7.5.0`. You can see all the supported TiDB versions by running the `tiup list tidb` command
- `--user`: Specify the user for environment initialization
- `-p`: Specify the password used to connect to the target machine.

> **Note:**
Expand Down