From e43e58d4e5f3e95a05cd9f5ce041e224dce3efc7 Mon Sep 17 00:00:00 2001 From: Ran Date: Mon, 8 Jun 2020 15:35:41 +0800 Subject: [PATCH 1/3] quick start: update quick start with tidb --- quick-start-with-tidb.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index e8ae736eb2cb2..872432006c1fa 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -2,6 +2,7 @@ title: Quick Start Guide for the TiDB Database Platform summary: Learn how to quickly get started with the TiDB platform and see if TiDB is the right choice for you. category: how-to +aliases: ['/docs-cn/dev/test-deployment-using-docker/'] --- # Quick Start Guide for the TiDB Database Platform @@ -12,18 +13,9 @@ category: how-to This document describes how to try out TiDB, a distributed SQL database, in a few minutes. You can choose any of the following three methods to get started with the TiDB database platform: -- [Try out TiDB with one click using TiDB-Wasm](#try-out-tidb-with-one-click-using-tidb-wasm) - [Deploy a local test environment using TiUP Playground](#deploy-a-local-test-environment-using-tiup-playground) -- [Set up a test environment on a single machine using TiUP cluster](#set-up-a-test-environment-on-a-single-machine-using-tiup-cluster) - -## Try out TiDB with one click using TiDB-Wasm - -- Scenario: Experiment with TiDB SQL and test the TiDB compatibility with MySQL queries. -- Time required: Instant - -TiDB-Wasm enables you to run a TiDB server instance in a browser so that you can experiment with SQL and test TiDB compatibility with MySQL queries. - -Click to try TiDB-Wasm playground: . It takes about 10 seconds to launch the TiDB server instance in your browser. The playground walks you through the basic TiDB SQL statements such as DDL, DML and CRUD operations. +- [Set up a test environment on a single machine using TiUP Cluster](#set-up-a-test-environment-on-a-single-machine-using-tiup-cluster) +- [Try out TiDB with one click using TiDB-Wasm](#try-out-tidb-with-one-click-using-tidb-wasm) ## Deploy a local test environment using TiUP Playground @@ -67,12 +59,12 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in {{< copyable "shell-regular" >}} ```shell - tiup playground v4.0.0-rc --db 2 --pd 3 --kv 3 --monitor + tiup playground v4.0.0 --db 2 --pd 3 --kv 3 --monitor ``` - The command downloads a v4.0.0-rc cluster to the local machine and starts it. + The command downloads a v4.0.0 cluster to the local machine and starts it. `--monitor` means that the monitoring component is also deployed. - `--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: @@ -168,7 +160,7 @@ Other requirements for the target machine: {{< copyable "shell-regular" >}} ```shell - tiup update cluster + tiup update --self && tiup update cluster ``` 4. Use the `root` user privilege to increase the connection limit of the `sshd` service. This is because TiUP needs to simulate deployment on multiple machines. @@ -251,7 +243,7 @@ Other requirements for the target machine: {{< copyable "shell-regular" >}} ```shell - tiup cluster deploy ./topo.yaml --user root + tiup cluster deploy ./topo.yaml --user root -p ``` - ``: Set the cluster name @@ -301,3 +293,12 @@ Other requirements for the target machine: ```shell tiup cluster display ``` + +## Try out TiDB with one click using TiDB-Wasm + +- Scenario: Experiment with TiDB SQL and test the TiDB compatibility with MySQL queries. +- Time required: Instant + +TiDB-Wasm enables you to run a TiDB server instance in a browser so that you can experiment with SQL and test TiDB compatibility with MySQL queries. + +Click to try TiDB-Wasm playground: . It takes about 10 seconds to launch the TiDB server instance in your browser. The playground walks you through the basic TiDB SQL statements such as DDL, DML and CRUD operations. From 16771d37794dd8791581e164e3a48029e44cfd99 Mon Sep 17 00:00:00 2001 From: Ran Date: Mon, 8 Jun 2020 15:44:40 +0800 Subject: [PATCH 2/3] add what's next --- quick-start-with-tidb.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 872432006c1fa..83edd43868b62 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -302,3 +302,17 @@ Other requirements for the target machine: TiDB-Wasm enables you to run a TiDB server instance in a browser so that you can experiment with SQL and test TiDB compatibility with MySQL queries. Click to try TiDB-Wasm playground: . It takes about 10 seconds to launch the TiDB server instance in your browser. The playground walks you through the basic TiDB SQL statements such as DDL, DML and CRUD operations. + +## What's next + +- If you have just deployed a TiDB cluster for the local test environment: + + - Learn [Basic SQL operations in TiDB](/basic-sql-operations.md) + - Learn [TiDB key features and scenarios](/overview.md) + - Learn [TiDB's compatibility with MySQL](/mysql-compatibility.md) + +- If you are ready to deploy a TiDB cluster for the production environment: + + - [Deploy TiDB online using TiUP](/production-deployment-using-tiup.md) + - [Deploy TiDB online using TiUP](/production-offline-deployment-using-tiup.md) + - [Deploy TiDB on Cloud using TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/) From 172070a118966352230b3d9b051825ae728313a8 Mon Sep 17 00:00:00 2001 From: Ran Date: Mon, 8 Jun 2020 19:32:50 +0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> --- 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 83edd43868b62..7337c342246ce 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -2,7 +2,7 @@ title: Quick Start Guide for the TiDB Database Platform summary: Learn how to quickly get started with the TiDB platform and see if TiDB is the right choice for you. category: how-to -aliases: ['/docs-cn/dev/test-deployment-using-docker/'] +aliases: ['/docs/dev/test-deployment-using-docker/'] --- # Quick Start Guide for the TiDB Database Platform