diff --git a/_index.md b/_index.md index 2708bd93cf052..d74a19ecfc884 100644 --- a/_index.md +++ b/_index.md @@ -6,45 +6,101 @@ category: introduction # TiDB Introduction -[TiDB](https://github.com/pingcap/tidb) ("Ti" stands for Titanium) is an open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. +[TiDB](https://github.com/pingcap/tidb) ("Ti" stands for Titanium) is an open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. TiDB can be deployed on-premise or in-cloud. -TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP: + + +About TiDB -- [TiUP Deployment](/production-deployment-using-tiup.md): This guide describes how to deploy a TiDB cluster using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment. -- [Docker Deployment](/test-deployment-using-docker.md): This guide describes how to deploy TiDB using Docker. -- [Docker Compose Deployment](/deploy-test-cluster-using-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: +- [TiDB Introduction](/overview.md) +- [Key Features](/key-features.md) +- [Compatibility with MySQL](/mysql-compatibility.md) +- [Usage Limitations](/tidb-limitations.md) - You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB for production environments on: + - - [AWS EKS (Elastic Kubernetes Service)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-aws-eks/) - - [GKE (Google Kubernetes Engine)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-gcp-gke/) - - [Google Cloud Shell](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-gke/) - - [Alibaba Cloud ACK (Container Service for Kubernetes)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-alibaba-cloud/) + +Quick Start - Or deploy TiDB locally using: +- [Quick Start Guide](/quick-start-with-tidb.md) +- [Explore SQL with TiDB](/basic-sql-operations.md) - - [kind](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-kind/) - - [Minikube](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-minikube/) + -- [Binary Tarball Deployment](/production-deployment-from-binary-tarball.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/deploy-tidb-from-binary.md) and [testing](/test-deployment-from-binary-tarball.md) environments are also available. + +Deploy and Use -## Community Provided Blog Posts & Tutorials +- [Hardware and Software Requirements](/hardware-and-software-requirements.md) +- [Check Environment and Configuration](/check-before-deployment.md) +- [Deploy a TiDB Cluster Using TiUP](/production-deployment-using-tiup.md) +- [Use TiFlash for Analytical Processing](/tiflash/use-tiflash.md) +- [Deploy TiDB in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/) -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://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) -- [TiDB Best Practices](https://pingcap.com/blog/2017-07-24-tidbbestpractice/) + +Migrate Data -_Your contribution is also welcome! Feel free to open a [pull request](https://github.com/pingcap/docs/blob/master/overview.md) to add additional links._ +- [Migration Overview](/migration-overview.md) +- [Migrate from MySQL SQL Files](/migrate-from-mysql-mydumper-files.md) +- [Migrate from Aurora MySQL Database](/migrate-from-aurora-mysql-database.md) +- [Migrate from CSV Files](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) -## Source Code + -Source code for [all components of the TiDB platform](https://github.com/pingcap) is available on GitHub. + +Maintain -- [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) +- [Upgrade TiDB Using TiUP](/upgrade-tidb-using-tiup.md) +- [Scale TiDB Using TiUP](/scale-tidb-using-tiup.md) +- [Back up and Restore Data](/br/backup-and-restore-tool.md) +- [Deploy and Manage TiCDC](/ticdc/manage-ticdc.md) +- [Maintain TiDB Using TiUP](/maintain-tidb-using-tiup.md) +- [Maintain TiFlash](/tiflash/maintain-tiflash.md) + + + + +Monitor and Alert + +- [Monitoring Framework](/tidb-monitoring-framework.md) +- [Monitoring API](/tidb-monitoring-api.md) +- [Deploy Monitoring Services](/deploy-monitoring-services.md) +- [Alert Rules and Solutions](/alert-rules.md) +- [TiFlash Alert Rules and Solutions](/tiflash/tiflash-alert-rules.md) + + + + +Troubleshoot + +- [TiDB Troubleshooting Map](/tidb-troubleshooting-map.md) +- [Identify Slow Queries](/identify-slow-queries.md) +- [SQL Diagnostics](/system-tables/system-table-sql-diagnostics.md) +- [Troubleshoot the TiDB Cluster](/troubleshoot-tidb-cluster.md) +- [Troubleshoot TiCDC](/ticdc/troubleshoot-ticdc.md) +- [Troubleshoot TiFlash](/tiflash/troubleshoot-tiflash.md) + + + + +Reference + +- [TiDB Architecture](/architecture.md) +- [Key Monitoring Metrics](/grafana-overview-dashboard.md) +- [Enable TLS](/enable-tls-between-clients-and-servers.md) +- [Privilege Management](/privilege-management.md) +- [Role-Based Access Control](/role-based-access-control.md) +- [Certificate-Based Authentication](/certificate-authentication.md) + + + + +FAQs + +- [TiDB FAQs](/faq/tidb-faq.md) +- [FAQs After Upgrade](/faq/upgrade-faq.md) +- [TiDB Lightning FAQs](/tidb-lightning/tidb-lightning-faq.md) + + + \ No newline at end of file diff --git a/maintain-tidb-using-tiup.md b/maintain-tidb-using-tiup.md index 4f0229afac11c..f700d6abc1c27 100644 --- a/maintain-tidb-using-tiup.md +++ b/maintain-tidb-using-tiup.md @@ -1,11 +1,11 @@ --- -title: Common TiUP Operations +title: TiUP Common Operations summary: Learn the common operations to operate and maintain a TiDB cluster using TiUP. category: how-to aliases: ['/docs/dev/how-to/maintain/tiup-operations/'] --- -# Common TiUP Operations +# TiUP Common Operations This document describes the following common operations when you operate and maintain a TiDB cluster using TiUP. diff --git a/tidb-lightning/tidb-lightning-faq.md b/tidb-lightning/tidb-lightning-faq.md index 550029414f1f2..e7439d3ab6ee3 100644 --- a/tidb-lightning/tidb-lightning-faq.md +++ b/tidb-lightning/tidb-lightning-faq.md @@ -1,11 +1,11 @@ --- -title: TiDB Lightning FAQ +title: TiDB Lightning FAQs summary: Learn about the frequently asked questions (FAQs) and answers about TiDB Lightning. category: faq aliases: ['/docs/dev/faq/tidb-lightning/'] --- -# TiDB Lightning FAQ +# TiDB Lightning FAQs >**Note:** >