You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: dashboard/dashboard-ops-reverse-proxy.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -132,7 +132,7 @@ server_configs:
132
132
<details>
133
133
<summary> <strong>Modify configuration when deploying a new cluster using TiUP</strong> </summary>
134
134
135
-
If you are deploying a new cluster, you can add the configuration above to the `topology.yaml` TiUP topology file and deploy the cluster. For specific instruction, see [TiUP deployment document](/production-deployment-using-tiup.md#step-3-initialize-cluster-topology-file).
135
+
If you are deploying a new cluster, you can add the configuration above to the `topology.yaml` TiUP topology file and deploy the cluster. For specific instruction, see [TiUP deployment document](/production-deployment-using-tiup.md#step-3-initialize-the-cluster-topology-file).
Copy file name to clipboardexpand all lines: post-installation-check.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Log in to the database by running the following command:
56
56
mysql -u root -h ${tidb_server_host_IP_address} -P 4000
57
57
```
58
58
59
-
`${tidb_server_host_IP_address}` is one of the IP addresses set for `tidb_servers` when you [initialize the cluster topology file](/production-deployment-using-tiup.md#step-3-initialize-cluster-topology-file), such as `10.0.1.7`.
59
+
`${tidb_server_host_IP_address}` is one of the IP addresses set for `tidb_servers` when you [initialize the cluster topology file](/production-deployment-using-tiup.md#step-3-initialize-the-cluster-topology-file), such as `10.0.1.7`.
60
60
61
61
The following information indicates successful login:
Copy file name to clipboardexpand all lines: production-deployment-using-tiup.md
+9-66
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ TiUP is a cluster operation and maintenance tool introduced in TiDB v4.0. It pro
12
12
13
13
TiUP also supports deploying TiDB, TiFlash, TiCDC, and the monitoring system. This guide introduces how to deploy TiDB clusters with different topologies.
14
14
15
-
## Step 1. Prerequisites and precheck
15
+
## Step 1. Prerequisites and prechecks
16
16
17
17
Make sure that you have read the following documents:
18
18
@@ -31,8 +31,6 @@ Log in to the control machine using a regular user account (take the `tidb` user
31
31
32
32
1. Install TiUP by running the following command:
33
33
34
-
{{< copyable "shell-regular" >}}
35
-
36
34
```shell
37
35
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
38
36
```
@@ -41,32 +39,24 @@ Log in to the control machine using a regular user account (take the `tidb` user
41
39
42
40
1. Redeclare the global environment variables:
43
41
44
-
{{< copyable "shell-regular">}}
45
-
46
42
```shell
47
43
source .bash_profile
48
44
```
49
45
50
46
2. Confirm whether TiUP is installed:
51
47
52
-
{{< copyable "shell-regular">}}
53
-
54
48
```shell
55
49
which tiup
56
50
```
57
51
58
52
3. Install the TiUP cluster component:
59
53
60
-
{{< copyable "shell-regular">}}
61
-
62
54
```shell
63
55
tiup cluster
64
56
```
65
57
66
58
4. If TiUP is already installed, update the TiUP cluster component to the latest version:
67
59
68
-
{{< copyable "shell-regular">}}
69
-
70
60
```shell
71
61
tiup update --self && tiup update cluster
72
62
```
@@ -75,8 +65,6 @@ Log in to the control machine using a regular user account (take the `tidb` user
75
65
76
66
5. Verify the current version of your TiUP cluster:
1. When pulling an offline mirror, you can get an incomplete offline mirror by specifying specific information via parameters, such as the component and version information. For example, you can pull an offline mirror that includes only the offline mirror of TiUP v1.12.3 and TiUP Cluster v1.12.3 by running the following command:
3. Check the path of the current offline mirror on the control machine in the isolated environment. If your TiUP tool is of a recent version, you can get the current mirror address by running the following command:
To switch the mirror to another directory, run the `tiup mirror set <mirror-dir>` command. To switch the mirror to the online environment, run the `tiup mirror set https://tiup-mirrors.pingcap.com` command.
229
197
230
-
## Step 3. Initialize cluster topology file
198
+
## Step 3. Initialize the cluster topology file
231
199
232
200
Run the following command to create a cluster topology file:
233
201
234
-
{{< copyable "shell-regular" >}}
235
-
236
202
```shell
237
203
tiup cluster template > topology.yaml
238
204
```
@@ -241,23 +207,17 @@ In the following two common scenarios, you can generate recommended topology tem
241
207
242
208
- For hybrid deployment: Multiple instances are deployed on a single machine. For details, see [Hybrid Deployment Topology](/hybrid-deployment-topology.md).
243
209
244
-
{{< copyable "shell-regular" >}}
245
-
246
210
```shell
247
211
tiup cluster template --full > topology.yaml
248
212
```
249
213
250
214
- For geo-distributed deployment: TiDB clusters are deployed in geographically distributed data centers. For details, see [Geo-Distributed Deployment Topology](/geo-distributed-deployment-topology.md).
251
215
252
-
{{< copyable "shell-regular">}}
253
-
254
216
```shell
255
217
tiup cluster template --multi-dc > topology.yaml
256
218
```
257
219
258
-
Run `vi topology.yaml` to see the configuration file content:
259
-
260
-
{{< copyable "shell-regular">}}
220
+
Run `vi topology.yaml` to see the content of the configuration file:
261
221
262
222
```shell
263
223
global:
@@ -286,7 +246,7 @@ alertmanager_servers:
286
246
- host: 10.0.1.4
287
247
```
288
248
289
-
The following examples cover seven common scenarios. You need to modify the configuration file (named `topology.yaml`) according to the topology description and templates in the corresponding links. For other scenarios, edit the configuration template accordingly.
249
+
The following examples cover six common scenarios. You need to modify the configuration file (named `topology.yaml`) according to the topology description and templates in the corresponding links. For other scenarios, edit the configuration template accordingly.
@@ -315,39 +275,35 @@ For more configuration description, see the following configuration examples:
315
275
316
276
> **Note:**
317
277
>
318
-
> You can use secret keys or interactive passwords for security authentication when you deploy TiDB using TiUP:
278
+
> You can securely authenticate users used for initialization when deploying a cluster via TiUP (specified via `--user`) using either a key or a cross-password:
319
279
>
320
280
> - If you use secret keys, specify the path of the keys through `-i` or `--identity_file`.
321
281
> - If you use passwords, add the `-p` flag to enter the password interaction window.
322
282
> - If password-free login to the target machine has been configured, no authentication is required.
323
283
>
324
-
> In general, TiUP creates the user and group specified in the `topology.yaml` file on the target machine, with the following exceptions:
284
+
> In general, the users and groups used by TiUP to actually execute the processes (specified via `topology.yaml`, and the default value is `tidb`) are created automatically on the target machine, with the following exceptions:
325
285
>
326
286
> - The user name configured in `topology.yaml` already exists on the target machine.
327
287
> - You have used the `--skip-create-user` option in the command line to explicitly skip the step of creating the user.
288
+
>
289
+
> Regardless of whether the users and groups agreed upon in `topology.yaml` are created automatically, TiUP automatically generates a pair of ssh keys and sets up a secret-free login for that user on each machine. This user and ssh key will be used to manage the machine for all subsequent operations, while the user and password used for initialization will not be used any more after the deployment is complete.
328
290
329
291
Before you run the `deploy` command, use the `check` and `check --apply` commands to detect and automatically repair potential risks in the cluster:
For example, run the following command to check the status of the `tidb-test` cluster:
378
332
379
-
{{< copyable "shell-regular" >}}
380
-
381
333
```shell
382
334
tiup cluster display tidb-test
383
335
```
@@ -393,21 +345,16 @@ After safe start, TiUP automatically generates a password for the TiDB root user
393
345
> **Note:**
394
346
>
395
347
> - After safe start of a TiDB cluster, you cannot log in to TiDB using a root user without a password. Therefore, you need to record the password returned in the command output for future logins.
396
-
>
397
348
> - The password is generated only once. If you do not record it or you forgot it, refer to [Forget the `root` password](/user-account-management.md#forget-the-root-password) to change the password.
398
349
399
350
Method 1: Safe start
400
351
401
-
{{< copyable "shell-regular" >}}
402
-
403
352
```shell
404
353
tiup cluster start tidb-test --init
405
354
```
406
355
407
356
If the output is as follows, the start is successful:
408
357
409
-
{{< copyable "shell-regular" >}}
410
-
411
358
```shell
412
359
Started cluster `tidb-test` successfully.
413
360
The root password of TiDB database has been changed.
@@ -418,8 +365,6 @@ The generated password can NOT be got again in future.
418
365
419
366
Method 2: Standard start
420
367
421
-
{{< copyable "shell-regular" >}}
422
-
423
368
```shell
424
369
tiup cluster start tidb-test
425
370
```
@@ -428,8 +373,6 @@ If the output log includes ```Started cluster `tidb-test` successfully```, the s
428
373
429
374
## Step 8. Verify the running status of the TiDB cluster
430
375
431
-
{{< copyable "shell-regular" >}}
432
-
433
376
```shell
434
377
tiup cluster display tidb-test
435
378
```
@@ -452,4 +395,4 @@ If you have deployed [TiCDC](/ticdc/ticdc-overview.md) along with the TiDB clust
If you want to scale out or scale in your TiDB cluster without interrupting the online services, see [Scale a TiDB Cluster Using TiUP](/scale-tidb-using-tiup.md).
398
+
If you want to scale out or scale in your TiDB cluster without interrupting the online services, see [Scale a TiDB Cluster Using TiUP](/scale-tidb-using-tiup.md).
0 commit comments