Skip to content
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

Jump to bottom

Quick start: update version and TiUP playground supports M1 silicon #6149

Merged
merged 7 commits into from
Aug 25, 2021
Merged

Quick start: update version and TiUP playground supports M1 silicon #6149

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2605cfb
Quick start: update version and TiUP playground supports M1 silicon
en-jin19 Aug 12, 2021
aea2d9d
Apply suggestions from code review
en-jin19 Aug 12, 2021
d7db1aa
revise translation
en-jin19 Aug 19, 2021
363cc41
update translation
en-jin19 Aug 19, 2021
ef1ab27
Merge branch 'Quick-Start-update-version-and-tiup-playground-supports…
en-jin19 Aug 19, 2021
42057f4
Update quick-start-with-tidb.md
TomShawn Aug 20, 2021
062bd74
Update quick-start-with-tidb.md
TomShawn Aug 20, 2021
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
30 changes: 15 additions & 15 deletions quick-start-with-tidb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,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 @@ -62,10 +58,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 @@ -81,8 +77,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.
TomShawn marked this conversation as resolved.
Show resolved Hide resolved
> + 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 @@ -167,21 +164,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 @@ -211,9 +209,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