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

*: Reorganize quick start to promote other platforms #598

Merged
merged 12 commits into from
Sep 7, 2018
Merged

*: Reorganize quick start to promote other platforms #598

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6a3b709
Change to links to major deployment platforms
morgo Sep 5, 2018
8d3a116
Update QUICKSTART.md
morgo Sep 5, 2018
662a68c
Update QUICKSTART.md
morgo Sep 5, 2018
3900692
Update QUICKSTART.md
morgo Sep 5, 2018
177fb73
Update QUICKSTART.md
morgo Sep 5, 2018
8119a4c
Remove tutorial from navigation
morgo Sep 5, 2018
05444c6
Improved link to edit directly
morgo Sep 5, 2018
ed97a99
Update QUICKSTART.md
morgo Sep 6, 2018
00c116f
Minor correction
ceohockey60 Sep 6, 2018
cc8bb60
Changed third party to unofficial
morgo Sep 7, 2018
722f2f4
Addressing Feedback
morgo Sep 7, 2018
b95d163
Update QUICKSTART.md
morgo Sep 7, 2018
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
65 changes: 19 additions & 46 deletions QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,57 +6,30 @@ 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.
Installation instructions for platforms officially supported by PingCAP.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about using the following statement?
As an open source distributed scalable HTAP database, TiDB can be deployed on premise or cross-cloud. The following deployment options are officially supported by PingCAP:


> **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).
- [Ansible (recommended)](op-guide/ansible-deployment.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Ansible Deployment: 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Ansible Offline Deployment: 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](op-guide/docker-deployment.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docker Deployment: This guide describes how to deploy TiDB using Docker.

- [Docker Compose (development environments)](op-guide/docker-compose.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docker Compose Deployment: 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 (beta)](op-guide/kubernetes.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kubernetes Deployment (beta): This guide describes how to deploy TiDB on Kubernetes using 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.


## Prerequisites
## Community Provided Blog Posts & Tutorials

Before you begin, make sure to install the following tools:
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.

- [Git](https://git-scm.com/downloads)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [MySQL Client](https://dev.mysql.com/downloads/mysql/)
- [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)

## Deploy a TiDB cluster
_Please open a [pull request](https://github.com/pingcap/docs/edit/master/QUICKSTART.md) to add additional links._
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your contribution is also welcome! Feel free to open a pull request to add additional links.


1. Download `tidb-docker-compose`:
## Source Code

```bash
git clone https://github.com/pingcap/tidb-docker-compose.git
```
Source code for [all components of the TiDB platform](https://github.com/pingcap) is available on GitHub.

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).
- [TiDB](https://github.com/pingcap/tidb)
- [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)
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down