| title | summary | category |
|---|---|---|
TiDB Quick Start Guide |
Learn how to quickly start a TiDB cluster. |
quick start |
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 Deployment: This guide describes how to deploy TiDB using Ansible. It is strongly recommended for production deployment.
- 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 Deployment: This guide describes how to deploy TiDB using Docker.
- 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 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.
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
- Developer install guide (single machine)
Your contribution is also welcome! Feel free to open a pull request to add additional links.
Source code for all components of the TiDB platform is available on GitHub.