Skip to content

Commit

Permalink
Quick start: update version and TiUP playground supports M1 silicon (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Aug 25, 2021
1 parent 6143b5d commit 7499133
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ This guide walks you through the quickest way to get started with TiDB. You will

## Deploy a local test environment on Mac OS

> **Note:**
>
> Currently, some TiDB components do not have a released version that supports the Apple M1 chip. Therefore, the `tiup playground` command currently cannot be executed on the local Mac machine that uses the Apple M1 chip.
As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB instances, 3 TiKV instances, 3 PD instances, and optional TiFlash instances. With TiUP Playground, you can quickly build the test cluster by taking the following steps:

1. Download and install TiUP:
Expand Down Expand Up @@ -61,10 +57,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
{{< copyable "shell-regular" >}}

```shell
tiup playground v5.1.0 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.2.0 --db 2 --pd 3 --kv 3 --monitor
```

The command downloads a version cluster to the local machine and starts it, such as v5.1.0. `--monitor` means that the monitoring component is also deployed.
The command downloads a version cluster to the local machine and starts it, such as v5.2.0. `--monitor` means that the monitoring component is also deployed.

To view the latest version, run `tiup list tidb`.

Expand All @@ -80,8 +76,9 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in

> **Note:**
>
> For the playground operated in this way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
> If you want the data to be persisted on storage,run `tiup --tag <your-tag> playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag).
> + Since v5.2.0, TiDB supports running `tiup playground` on the machine that uses the Apple M1 chip.
> + For the playground operated in this way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
> + If you want the data to be persisted on storage,run `tiup --tag <your-tag> playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag).

4. Start a new session to access TiDB:

Expand Down Expand Up @@ -166,21 +163,22 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
{{< copyable "shell-regular" >}}

```shell
tiup playground v5.1.0 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.2.0 --db 2 --pd 3 --kv 3 --monitor
```

The command downloads a version cluster to the local machine and starts it, such as v5.1.0. `--monitor` means that the monitoring component is also deployed.
The command downloads a version cluster to the local machine and starts it, such as v5.2.0. `--monitor` means that the monitoring component is also deployed.

To view the latest version, run `tiup list tidb`.

This command returns the access methods of the cluster:

```log
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
To connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root
To connect TiDB: mysql --host 127.0.0.1 --port 4001 -u root
To connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root -p (no password) --comments
To view the dashboard: http://127.0.0.1:2379/dashboard
To view the monitor: http://127.0.0.1:9090
PD client endpoints: [127.0.0.1:2379]
To view the Prometheus: http://127.0.0.1:9090
To view the Grafana: http://127.0.0.1:3000
```

> **Note:**
Expand Down Expand Up @@ -210,9 +208,11 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in

6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, with an empty password.

7. (Optional) [Load data to TiFlash](/tiflash/use-tiflash.md) for analysis.
7. Access the Grafana dashboard of TiDB through <http://127.0.0.1:3000>. Both the default username and password are `admin`.

8. Clean up the cluster after the test deployment:
8. (Optional) [Load data to TiFlash](/tiflash/use-tiflash.md) for analysis.

9. Clean up the cluster after the test deployment:

1. Stop the process by pressing `ctrl-c`.

Expand Down

0 comments on commit 7499133

Please sign in to comment.