From 6dc03a03703fe4e1a0451154b228508e1b26d726 Mon Sep 17 00:00:00 2001 From: en-jin19 Date: Thu, 12 Aug 2021 09:25:11 +0200 Subject: [PATCH 1/6] Quick start: update version and TiUP playground supports M1 silicon --- quick-start-with-tidb.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index fb9ac382d8103..e34da926ee1a8 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -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: @@ -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`. @@ -79,7 +75,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in ``` > **Note:** - > + > With TiDB v5.2.0 or a later version, `tiup playground` command can be executed 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 playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag). @@ -166,10 +162,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`. @@ -177,10 +173,11 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in ```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:** @@ -210,9 +207,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 . The default username is `root`, with an empty password. -7. (Optional) [Load data to TiFlash](/tiflash/use-tiflash.md) for analysis. +7. Access the TiDB Grafana Web interface at . 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`. From 1a480a945b819dbd2309f1e0710ce6e336eee600 Mon Sep 17 00:00:00 2001 From: Enwei Date: Thu, 12 Aug 2021 10:10:35 +0200 Subject: [PATCH 2/6] Apply suggestions from code review Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com> --- quick-start-with-tidb.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index e34da926ee1a8..f3518090fe427 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -75,7 +75,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in ``` > **Note:** - > With TiDB v5.2.0 or a later version, `tiup playground` command can be executed on the machine that uses the Apple M1 chip. + > TiDB v5.2.0 or a later version 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 playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag). @@ -207,7 +207,7 @@ 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 . The default username is `root`, with an empty password. -7. Access the TiDB Grafana Web interface at . The default username and password are `admin`. +7. Access the Grafana dashboard of TiDB at . Both the default username and password are `admin`. 8. (Optional) [Load data to TiFlash](/tiflash/use-tiflash.md) for analysis. From e916771a057e342e8f0516078c9b57106e2b3033 Mon Sep 17 00:00:00 2001 From: Enwei Date: Thu, 19 Aug 2021 08:53:10 +0200 Subject: [PATCH 3/6] revise translation Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- quick-start-with-tidb.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index f3518090fe427..8acdf16a3abec 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -75,9 +75,9 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in ``` > **Note:** - > TiDB v5.2.0 or a later version 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 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 playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag). 4. Start a new session to access TiDB: From e3f372389048a7537f24c5712c9bcf5e8ef73c41 Mon Sep 17 00:00:00 2001 From: en-jin19 Date: Thu, 19 Aug 2021 08:58:44 +0200 Subject: [PATCH 4/6] update translation --- quick-start-with-tidb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 8acdf16a3abec..7eb89b1778571 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -207,7 +207,7 @@ 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 . The default username is `root`, with an empty password. -7. Access the Grafana dashboard of TiDB at . Both the default username and password are `admin`. +7. Access the Grafana dashboard of TiDB through . Both the default username and password are `admin`. 8. (Optional) [Load data to TiFlash](/tiflash/use-tiflash.md) for analysis. From f44d4c5d0d04809328ef97f185edfcdaffaf57fb Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 20 Aug 2021 15:38:19 +0800 Subject: [PATCH 5/6] Update quick-start-with-tidb.md --- quick-start-with-tidb.md | 1 + 1 file changed, 1 insertion(+) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 7eb89b1778571..be12e3499fcba 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -75,6 +75,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in ``` > **Note:** + > + 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 playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag). From 4fb5353ebd8a264acc564b32f7cae24774ef5dab Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 20 Aug 2021 15:38:47 +0800 Subject: [PATCH 6/6] Update quick-start-with-tidb.md --- quick-start-with-tidb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index be12e3499fcba..1f9c859c54a79 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -75,7 +75,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in ``` > **Note:** - + > > + 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 playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag).