From 6a3b709947ceda2151a2cbb4b5a8e77a2a194c8b Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 12:16:05 -0600 Subject: [PATCH 01/12] Change to links to major deployment platforms --- QUICKSTART.md | 62 +++++++++------------------------------------------ 1 file changed, 11 insertions(+), 51 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 10d231e952c78..ef7f23701bb02 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -6,57 +6,17 @@ category: quick start # TiDB Quick Start Guide -This guide introduces how to deploy and monitor a TiDB cluster on your local drive using Docker Compose for experimenting and testing. +- Docker Compose +- Ansible +- Ansible +- Docker +- GKE +- DinD -> **Warning:** Deploying TiDB using Docker Compose can only be used for experimental purposes. For production usage, [use Ansible to deploy the TiDB cluster](op-guide/ansible-deployment.md). +## Community Provided Blog Posts & Tutorials -## Prerequisites +A collection of blog posts demonstrating how to install TiDB. The content is maintained by +third parties and not guaranteed to be up to date. -Before you begin, make sure to install the following tools: - -- [Git](https://git-scm.com/downloads) -- [Docker Compose](https://docs.docker.com/compose/install/) -- [MySQL Client](https://dev.mysql.com/downloads/mysql/) - -## Deploy a TiDB cluster - -1. Download `tidb-docker-compose`: - - ```bash - git clone https://github.com/pingcap/tidb-docker-compose.git - ``` - -2. Change the directory to tidb-docker-compose and get the latest TiDB Docker Images: - - ```bash - cd tidb-docker-compose && docker-compose pull - ``` - -3. Start the TiDB cluster: - - ```bash - docker-compose up -d - ``` - -Congratulations! You have deployed a TiDB cluster! You can see messages in your terminal of the default components of a TiDB cluster: - -- 1 TiDB instance -- 3 TiKV instances -- 3 Placement Driver (PD) instances -- Prometheus -- Grafana -- 2 TiSpark instances (one master, one slave) -- 1 TiDB-Vision instance - -You can now test your TiDB server using one of the following methods: - -- Use the MySQL client to connect to TiDB: - - ``` - mysql -h 127.0.0.1 -P 4000 -u root - ``` - - You can [try TiDB](try-tidb.md) to explore the SQL statements. - -- Use Grafana to view the status of the cluster via [http://localhost:3000](http://localhost:3000) with the default account name and password: `admin` and `admin`. -- Use [TiDB-Vision](https://github.com/pingcap/tidb-vision), a cluster visualization tool, to see data transfer and load-balancing inside your cluster via [http://localhost:8010](http://localhost:8010). +- [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) +- [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) From 8d3a116452d7bc33bbcc5fdda03d7c1d81acdba4 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 12:49:50 -0600 Subject: [PATCH 02/12] Update QUICKSTART.md --- QUICKSTART.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/QUICKSTART.md b/QUICKSTART.md index ef7f23701bb02..1ba89e413ae6c 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -20,3 +20,12 @@ third parties and not guaranteed to be up to date. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) + +## Source Code + +Source Code for [all PingCAP projects](https://github.com/pingcap) is available on GitHub. + +- [TiDB](https://github.com/pingcap/tidb) +- [TiKV](https://github.com/tikv/tikv) +- [PD](https://github.com/pingcap/pd) +- [TiSpark](https://github.com/pingcap/tispark) From 662a68c01174758433d7d914c291ca4c927101fd Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 12:54:38 -0600 Subject: [PATCH 03/12] Update QUICKSTART.md --- QUICKSTART.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 1ba89e413ae6c..b1f6c244c4547 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -6,12 +6,11 @@ category: quick start # TiDB Quick Start Guide -- Docker Compose -- Ansible -- Ansible -- Docker -- GKE -- DinD +- [Docker Compose](op-guide/docker-compose.md) +- [Ansible (recommended)](op-guide/ansible-deployment.md) +- [Ansible (offline deployment)](op-guide/offline-ansible-deployment.md) +- [Docker](op-guide/docker-deployment.md) +- [Kubernetes](op-guide/kubernetes.md) ## Community Provided Blog Posts & Tutorials @@ -21,6 +20,8 @@ third parties and not guaranteed to be up to date. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) +_Please open a [pull request](https://github.com/pingcap/docs/pulls) to have your tutorial added here._ + ## Source Code Source Code for [all PingCAP projects](https://github.com/pingcap) is available on GitHub. From 3900692641f34876c7cd5b53bbe72c414fd04748 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 12:56:29 -0600 Subject: [PATCH 04/12] Update QUICKSTART.md --- QUICKSTART.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index b1f6c244c4547..d33b8aea0166c 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -6,10 +6,10 @@ category: quick start # TiDB Quick Start Guide -- [Docker Compose](op-guide/docker-compose.md) - [Ansible (recommended)](op-guide/ansible-deployment.md) - [Ansible (offline deployment)](op-guide/offline-ansible-deployment.md) - [Docker](op-guide/docker-deployment.md) +- [Docker Compose](op-guide/docker-compose.md) - [Kubernetes](op-guide/kubernetes.md) ## Community Provided Blog Posts & Tutorials From 177fb738a2fa2844b92d78a9d0b8fd230e64b3e8 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 13:10:16 -0600 Subject: [PATCH 05/12] Update QUICKSTART.md --- QUICKSTART.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index d33b8aea0166c..add2a53aa6517 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -6,11 +6,13 @@ category: quick start # TiDB Quick Start Guide +Installation instructions for platforms officially supported by PingCAP. + - [Ansible (recommended)](op-guide/ansible-deployment.md) - [Ansible (offline deployment)](op-guide/offline-ansible-deployment.md) - [Docker](op-guide/docker-deployment.md) -- [Docker Compose](op-guide/docker-compose.md) -- [Kubernetes](op-guide/kubernetes.md) +- [Docker Compose (for development environments)](op-guide/docker-compose.md) +- [Kubernetes (beta)](op-guide/kubernetes.md) ## Community Provided Blog Posts & Tutorials From 8119a4cbf596980d9d6d3c071934596b437bd60f Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 13:14:14 -0600 Subject: [PATCH 06/12] Remove tutorial from navigation It is in Quickstart now. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 86f63aab8dc01..e9a9f4a22cad0 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ + Quick Start - [TiDB Quick Start Guide](QUICKSTART.md) - [Basic SQL Statements](try-tidb.md) -- [TiDB Tutorial](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) + TiDB User Guide + TiDB Server Administration - [The TiDB Server](sql/tidb-server.md) From 05444c6554d597f9e78949a61368550e6823efaf Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 16:14:22 -0600 Subject: [PATCH 07/12] Improved link to edit directly --- QUICKSTART.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index add2a53aa6517..5f88cb63f6d7b 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -22,7 +22,7 @@ third parties and not guaranteed to be up to date. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) -_Please open a [pull request](https://github.com/pingcap/docs/pulls) to have your tutorial added here._ +_Please open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to have your tutorial added here._ ## Source Code From ed97a995b6b9e05b252b87cb937d15688c378e2a Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Thu, 6 Sep 2018 09:45:13 -0600 Subject: [PATCH 08/12] Update QUICKSTART.md --- QUICKSTART.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 5f88cb63f6d7b..4a409962a0612 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -11,18 +11,18 @@ Installation instructions for platforms officially supported by PingCAP. - [Ansible (recommended)](op-guide/ansible-deployment.md) - [Ansible (offline deployment)](op-guide/offline-ansible-deployment.md) - [Docker](op-guide/docker-deployment.md) -- [Docker Compose (for development environments)](op-guide/docker-compose.md) +- [Docker Compose (development environments)](op-guide/docker-compose.md) - [Kubernetes (beta)](op-guide/kubernetes.md) ## Community Provided Blog Posts & Tutorials -A collection of blog posts demonstrating how to install TiDB. The content is maintained by -third parties and not guaranteed to be up to date. +A collection of installation guides for TiDB authored by the community. The content is maintained by +third parties and not guaranteed to be up to date. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) -_Please open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to have your tutorial added here._ +_Please open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to add additional links._ ## Source Code @@ -32,3 +32,4 @@ Source Code for [all PingCAP projects](https://github.com/pingcap) is available - [TiKV](https://github.com/tikv/tikv) - [PD](https://github.com/pingcap/pd) - [TiSpark](https://github.com/pingcap/tispark) +- [TiDB Operator](https://github.com/pingcap/tidb-operator) From 00c116ffb04b4ae1b07a7ba0a7dda6db8d227a82 Mon Sep 17 00:00:00 2001 From: kxu Date: Thu, 6 Sep 2018 10:09:02 -0700 Subject: [PATCH 09/12] Minor correction Minor editorial correction to framing components of TiDB platform --- QUICKSTART.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 4a409962a0612..f37e968d86b4f 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -26,7 +26,7 @@ _Please open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKS ## Source Code -Source Code for [all PingCAP projects](https://github.com/pingcap) is available on GitHub. +Source code for [all components of the TiDB platform](https://github.com/pingcap) is available on GitHub. - [TiDB](https://github.com/pingcap/tidb) - [TiKV](https://github.com/tikv/tikv) From cc8bb60803ff438ee8cb77bd737093e3c7e498b7 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Thu, 6 Sep 2018 20:22:32 -0600 Subject: [PATCH 10/12] Changed third party to unofficial i.e. not part of official documentation project, but may include PingCAP employees. --- QUICKSTART.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index f37e968d86b4f..b22ff79f2c63c 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -16,8 +16,7 @@ Installation instructions for platforms officially supported by PingCAP. ## Community Provided Blog Posts & Tutorials -A collection of installation guides for TiDB authored by the community. The content is maintained by -third parties and not guaranteed to be up to date. +A collection of unofficial installation guides for TiDB authored by the community. The content is not guaranteed to be up to date. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) From 722f2f459f478672047924d016796445b47700c5 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Thu, 6 Sep 2018 21:13:23 -0600 Subject: [PATCH 11/12] Addressing Feedback --- QUICKSTART.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index b22ff79f2c63c..4ede7a400b527 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -6,22 +6,22 @@ category: quick start # TiDB Quick Start Guide -Installation instructions for platforms officially supported by PingCAP. +As an open source distributed scalable HTAP database, TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP. -- [Ansible (recommended)](op-guide/ansible-deployment.md) -- [Ansible (offline deployment)](op-guide/offline-ansible-deployment.md) -- [Docker](op-guide/docker-deployment.md) -- [Docker Compose (development environments)](op-guide/docker-compose.md) -- [Kubernetes (beta)](op-guide/kubernetes.md) +- [Ansible Deployment](op-guide/ansible-deployment.md): This guide describes how to deploy TiDB using Ansible. It is strongly recommended for production deployment. +- [Ansible Offline Deployment](op-guide/offline-ansible-deployment.md): If your environment has no access to the internet, you can follow this guide to see how to deploy a TiDB cluster offline using Ansible. +- [Docker Deployment](op-guide/docker-deployment.md): This guide describes how to deploy TiDB using Docker. +- [Docker Compose Deployment](op-guide/docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive. +- [Kubernetes Deployment (beta)](op-guide/kubernetes.md): This guide describes how to deploy TiDB on Kubernetes using [TiDB Operator](https://github.com/pingcap/tidb-operator). You can follow this guide to see how to deploy TiDB on Google Kubernetes Engine or deploy TiDB locally using Docker in Docker. ## Community Provided Blog Posts & Tutorials -A collection of unofficial installation guides for TiDB authored by the community. The content is not guaranteed to be up to date. +The following list collects deployment guides and tutorials from the community. The content is subject to change by the contributors. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) -_Please open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to add additional links._ +_Your contribution is also welcome! Feel free to open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to add additional links. ## Source Code From b95d163ca64c1d8fc5689a0812d22d383ec85bb2 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Thu, 6 Sep 2018 21:15:01 -0600 Subject: [PATCH 12/12] Update QUICKSTART.md --- QUICKSTART.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 4ede7a400b527..af6208b61aaec 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -21,7 +21,7 @@ The following list collects deployment guides and tutorials from the community. - [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) - [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html) -_Your contribution is also welcome! Feel free to open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to add additional links. +_Your contribution is also welcome! Feel free to open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to add additional links._ ## Source Code