From 18ac724acacdc3f93aef93b9acfc062fc5800203 Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 16 Apr 2020 21:06:23 +0800 Subject: [PATCH 1/4] *: update recommended deployment to TiUP --- _index.md | 5 +++-- faq/tidb.md | 5 +++-- how-to/deploy/orchestrated/ansible.md | 4 ++++ how-to/deploy/orchestrated/docker.md | 2 +- how-to/deploy/orchestrated/tiup.md | 6 +++--- how-to/get-started/deploy-tidb-from-docker-compose.md | 2 +- overview.md | 3 ++- 7 files changed, 17 insertions(+), 10 deletions(-) diff --git a/_index.md b/_index.md index ffb4869243035..15e33c1bbe513 100644 --- a/_index.md +++ b/_index.md @@ -10,13 +10,14 @@ TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP: -- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using TiDB Ansible. It is strongly recommended for production deployment. +- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy a TiDB cluster using TiUP. It is strongly recommended for production deployment. +- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md):This guide describes how to deploy a TiDB cluster for production environments using TiDB Ansible. - [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.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 TiDB Ansible. - [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker. - [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-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: - You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB on: + 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/) diff --git a/faq/tidb.md b/faq/tidb.md index debebd37c8dbb..976d98743ae24 100644 --- a/faq/tidb.md +++ b/faq/tidb.md @@ -203,9 +203,10 @@ For details, see [Software and Hardware Recommendations](/how-to/deploy/hardware ### Install and deploy -#### Deploy TiDB using TiDB Ansible (recommended) +#### Deploy TiDB for production (recommended) -See [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md). +- [TiUP Deployment](how-to/deploy/orchestrated/tiup.md) +- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md) ##### Why the modified `toml` configuration for TiKV/PD does not take effect? diff --git a/how-to/deploy/orchestrated/ansible.md b/how-to/deploy/orchestrated/ansible.md index 0642957444e77..fc6a9cc6f8579 100644 --- a/how-to/deploy/orchestrated/ansible.md +++ b/how-to/deploy/orchestrated/ansible.md @@ -27,6 +27,10 @@ You can use the TiDB Ansible configuration file to set up the cluster topology a - [Clean up data of the TiDB cluster](/how-to/deploy/orchestrated/ansible-operations.md#clean-up-cluster-data) - [Destroy the TiDB cluster](/how-to/deploy/orchestrated/ansible-operations.md#destroy-a-cluster) +> **Note:** +> +> For production environments, it is recommended that you deploy TiDB [using TiUP](/how-to/deploy/orchestrated/tiup.md). You can also deploy TiDB using TiDB Ansible. If you only want to try TiDB out and explore the features, it is recommended to [deploy TiDB using Docker Compose](/how-to/get-started/deploy-tidb-from-docker-compose.md) on a single machine. + ## Prepare Before you start, make sure you have: diff --git a/how-to/deploy/orchestrated/docker.md b/how-to/deploy/orchestrated/docker.md index e47cb33cf26e4..ea87feccfd398 100644 --- a/how-to/deploy/orchestrated/docker.md +++ b/how-to/deploy/orchestrated/docker.md @@ -12,7 +12,7 @@ To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardw > **Warning:** > -> This is for testing only. DO NOT USE in production! Please deploy TiDB with [our Ansible solution](/how-to/deploy/orchestrated/ansible.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. +> This is for testing only. DO NOT USE in production! Please deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. ## Preparation diff --git a/how-to/deploy/orchestrated/tiup.md b/how-to/deploy/orchestrated/tiup.md index 069c8d421f16c..b75beb200bd12 100644 --- a/how-to/deploy/orchestrated/tiup.md +++ b/how-to/deploy/orchestrated/tiup.md @@ -453,7 +453,7 @@ You need to fill in the result in the configuration file (as described in the St - Configuration optimization for TiKV - Make `readpool` thread pool self-adaptive. Configure the `readpool.unified.max-thread-count` parameter to make `readpool.storage` and `readpool.coprocessor` share a unified thread pool, and also enable self-adaptive switches for them. The calculation formula is as follows: - + ``` readpool.unified.max-thread-count = cores * 0.8 / the number of TiKV instances ``` @@ -465,7 +465,7 @@ You need to fill in the result in the configuration file (as described in the St ``` - If multiple TiKV instances are deployed on the same physical disk, you need to modify the `capacity` parameter in `conf/tikv.yml`: - + ``` raftstore.capactiy = the total disk capacity / the number of TiKV instances ``` @@ -473,7 +473,7 @@ You need to fill in the result in the configuration file (as described in the St - Label scheduling configuration Because multiple TiKV instances are deployed on a single machine, in order to avoid losing 2 replicas of the default 3 replicas in the Region Group during machine downtime which causes cluster unavailability, you can use labels to implement intelligent scheduling of PD. - + - TiKV configuration Configure the same host-level label information on the same physical machines: diff --git a/how-to/get-started/deploy-tidb-from-docker-compose.md b/how-to/get-started/deploy-tidb-from-docker-compose.md index 47a43142d6dfc..b79da913cfe77 100644 --- a/how-to/get-started/deploy-tidb-from-docker-compose.md +++ b/how-to/get-started/deploy-tidb-from-docker-compose.md @@ -12,7 +12,7 @@ With Docker Compose, you can use a YAML file to configure application services i > **Warning:** > -> This is for testing only. DO NOT USE in production! Please deploy TiDB with [our Ansible solution](/how-to/deploy/orchestrated/ansible.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. +> This is for testing only. DO NOT USE in production! Please deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. ## Prerequisites diff --git a/overview.md b/overview.md index 4c51779161562..fef6879fa5be1 100644 --- a/overview.md +++ b/overview.md @@ -10,7 +10,8 @@ TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP: -- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using TiDB Ansible. It is strongly recommended for production deployment. +- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy TiDB using TiUP. It is strongly recommended for production deployment. +- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB for production environments using TiDB Ansible. - [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.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 TiDB Ansible. - [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker. - [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-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. From 6bede06b680094cfea2ffae68f1d14cd48ff0883 Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 16 Apr 2020 22:24:10 +0800 Subject: [PATCH 2/4] Update faq/tidb.md --- faq/tidb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq/tidb.md b/faq/tidb.md index 976d98743ae24..36784c66e24e9 100644 --- a/faq/tidb.md +++ b/faq/tidb.md @@ -205,7 +205,7 @@ For details, see [Software and Hardware Recommendations](/how-to/deploy/hardware #### Deploy TiDB for production (recommended) -- [TiUP Deployment](how-to/deploy/orchestrated/tiup.md) +- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md) - [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md) ##### Why the modified `toml` configuration for TiKV/PD does not take effect? From 6935e00d08e8ad72887b0ee4bbf4414540974b33 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Fri, 17 Apr 2020 11:39:31 +0800 Subject: [PATCH 3/4] Apply suggestions from code review --- _index.md | 3 +-- faq/tidb.md | 1 - how-to/deploy/orchestrated/docker.md | 2 +- how-to/get-started/deploy-tidb-from-docker-compose.md | 2 +- overview.md | 3 +-- 5 files changed, 4 insertions(+), 7 deletions(-) diff --git a/_index.md b/_index.md index 15e33c1bbe513..34078c6b938c2 100644 --- a/_index.md +++ b/_index.md @@ -10,8 +10,7 @@ TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP: -- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy a TiDB cluster using TiUP. It is strongly recommended for production deployment. -- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md):This guide describes how to deploy a TiDB cluster for production environments using TiDB Ansible. +- [TiUP Deployment](/how-to/deploy/orchestrated/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. - [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.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 TiDB Ansible. - [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker. - [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-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. diff --git a/faq/tidb.md b/faq/tidb.md index 36784c66e24e9..fc09865a0b8c8 100644 --- a/faq/tidb.md +++ b/faq/tidb.md @@ -206,7 +206,6 @@ For details, see [Software and Hardware Recommendations](/how-to/deploy/hardware #### Deploy TiDB for production (recommended) - [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md) -- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md) ##### Why the modified `toml` configuration for TiKV/PD does not take effect? diff --git a/how-to/deploy/orchestrated/docker.md b/how-to/deploy/orchestrated/docker.md index ea87feccfd398..0beb47321aa8c 100644 --- a/how-to/deploy/orchestrated/docker.md +++ b/how-to/deploy/orchestrated/docker.md @@ -12,7 +12,7 @@ To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardw > **Warning:** > -> This is for testing only. DO NOT USE in production! Please deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. +> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. ## Preparation diff --git a/how-to/get-started/deploy-tidb-from-docker-compose.md b/how-to/get-started/deploy-tidb-from-docker-compose.md index b79da913cfe77..50609e1e8deee 100644 --- a/how-to/get-started/deploy-tidb-from-docker-compose.md +++ b/how-to/get-started/deploy-tidb-from-docker-compose.md @@ -12,7 +12,7 @@ With Docker Compose, you can use a YAML file to configure application services i > **Warning:** > -> This is for testing only. DO NOT USE in production! Please deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. +> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production. ## Prerequisites diff --git a/overview.md b/overview.md index fef6879fa5be1..546991d536316 100644 --- a/overview.md +++ b/overview.md @@ -10,8 +10,7 @@ TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP: -- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy TiDB using TiUP. It is strongly recommended for production deployment. -- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB for production environments using TiDB Ansible. +- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy TiDB using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment. - [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.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 TiDB Ansible. - [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker. - [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-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. From 58de021b5c3a1426ea2fb11e56376503617a1965 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Fri, 17 Apr 2020 11:41:05 +0800 Subject: [PATCH 4/4] Update faq/tidb.md --- faq/tidb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq/tidb.md b/faq/tidb.md index fc09865a0b8c8..c00e8f51cf3aa 100644 --- a/faq/tidb.md +++ b/faq/tidb.md @@ -205,7 +205,7 @@ For details, see [Software and Hardware Recommendations](/how-to/deploy/hardware #### Deploy TiDB for production (recommended) -- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md) +See [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md). ##### Why the modified `toml` configuration for TiKV/PD does not take effect?