From dc6da9e68a4795dbae49125c4c7a18af1cb6c4a6 Mon Sep 17 00:00:00 2001 From: yikeke Date: Fri, 12 Jun 2020 19:25:17 +0800 Subject: [PATCH 1/2] update outdated ansible deployment recommendations --- benchmark/benchmark-tidb-using-sysbench.md | 2 +- faq/tidb-faq.md | 8 +++++--- online-deployment-using-ansible.md | 10 ++++++---- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/benchmark/benchmark-tidb-using-sysbench.md b/benchmark/benchmark-tidb-using-sysbench.md index 692e57f697fd4..3fdd5eb725659 100644 --- a/benchmark/benchmark-tidb-using-sysbench.md +++ b/benchmark/benchmark-tidb-using-sysbench.md @@ -12,7 +12,7 @@ In this test, Sysbench 1.0.14 and TiDB 3.0 Beta are used. It is recommended to u - [Hardware recommendations](/hardware-and-software-requirements.md) -- The TiDB cluster is deployed according to the [TiDB Deployment Guide](/online-deployment-using-ansible.md). Suppose there are 3 servers in total. It is recommended to deploy 1 TiDB instance, 1 PD instance and 1 TiKV instance on each server. As for disk space, supposing that there are 32 tables and 10M rows of data on each table, it is recommended that the disk space where TiKV's data directory resides is larger than 512 GB. +- The TiDB cluster is deployed according to the [TiDB Deployment Guide](https://pingcap.com/docs/v3.0/online-deployment-using-ansible/). Suppose there are 3 servers in total. It is recommended to deploy 1 TiDB instance, 1 PD instance and 1 TiKV instance on each server. As for disk space, supposing that there are 32 tables and 10M rows of data on each table, it is recommended that the disk space where TiKV's data directory resides is larger than 512 GB. The number of concurrent connections to a single TiDB cluster is recommended to be under 500. If you need to increase the concurrency pressure on the entire system, you can add TiDB instances to the cluster whose number depends on the pressure of the test. diff --git a/faq/tidb-faq.md b/faq/tidb-faq.md index ebc607a1c68d1..4cbd9644ea53f 100644 --- a/faq/tidb-faq.md +++ b/faq/tidb-faq.md @@ -248,7 +248,9 @@ Check the time difference between the machine time of the monitor and the time w #### Deploy TiDB offline using TiDB Ansible -It is not recommended to deploy TiDB offline using TiDB Ansible. If the control machine has no access to external network, you can deploy TiDB offline using TiDB Ansible. For details, see [Offline Deployment Using TiDB Ansible](/offline-deployment-using-ansible.md). +> **Warning:** +> +> TiDB Ansible deployment method is deprecated since TiDB v4.0. [Use TiUP to deploy TiDB](/production-offline-deployment-using-tiup.md) instead. #### How to deploy TiDB quickly using Docker Compose on a single machine? @@ -323,7 +325,7 @@ When you apply rolling updates to the TiDB services, the running application is #### How to upgrade when I deploy TiDB using Binary? -It is not recommended to deploy TiDB using Binary. The support for upgrading using Binary is not as friendly as using TiDB Ansible. It is recommended to deploy TiDB using TiDB Ansible. +It is not recommended to deploy TiDB using Binary. The support for upgrading using Binary is not as friendly as using TiUP. It is recommended to deploy TiDB using TiUP. #### Should I upgrade TiKV or all components generally? @@ -411,7 +413,7 @@ Take `Release Version: v1.0.3-1-ga80e796` as an example of version number descri The TiDB community is highly active. After the 1.0 GA release, the engineers have been keeping optimizing and fixing bugs. Therefore, the TiDB version is updated quite fast. If you want to keep informed of the latest version, see [TiDB Weekly update](https://pingcap.com/weekly/). -It is recommended to deploy the TiDB cluster using the latest version of TiDB Ansible, which will also be updated along with the TiDB version. TiDB has a unified management of the version number after the 1.0 GA release. You can view the version number using the following two methods: +It is not recommended to deploy the TiDB cluster using TiDB Ansible. [Deploy TiDB using TiUP](/production-deployment-using-tiup.md) instead. TiDB has a unified management of the version number after the 1.0 GA release. You can view the version number using the following two methods: - `select tidb_version()` - `tidb-server -V` diff --git a/online-deployment-using-ansible.md b/online-deployment-using-ansible.md index bb694120c8a52..7658f2ada38fd 100644 --- a/online-deployment-using-ansible.md +++ b/online-deployment-using-ansible.md @@ -7,6 +7,12 @@ aliases: ['/docs/dev/how-to/deploy/orchestrated/ansible/'] # Deploy TiDB Using TiDB Ansible +> **Warning:** +> +> For production environments, it is recommended that you [deploy TiDB using TiUP](/production-deployment-using-tiup.md). Since v4.0, it is not recommended to deploy TiDB using TiDB Ansible. You can [import the TiDB cluster deployed by TiDB Ansible to TiUP](/upgrade-tidb-using-tiup.md#import-the-tidb-ansible-cluster-to-tiup). +> +> If you only want to try out TiDB and explore new features, refer to [Quick Start Guide](/quick-start-with-tidb.md) or [deploy TiDB using Docker Compose](/deploy-test-cluster-using-docker-compose.md) on a single machine. + This guide describes how to deploy a TiDB cluster using TiDB Ansible. For the production environment, it is recommended to deploy TiDB using TiDB Ansible. ## Overview @@ -28,10 +34,6 @@ You can use the TiDB Ansible configuration file to set up the cluster topology a - [Clean up data of the TiDB cluster](/maintain-tidb-using-ansible.md#clean-up-cluster-data) - [Destroy the TiDB cluster](/maintain-tidb-using-ansible.md#destroy-a-cluster) -> **Note:** -> -> For production environments, it is recommended that you deploy TiDB [using TiUP](/production-deployment-using-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](/deploy-test-cluster-using-docker-compose.md) on a single machine. - ## Prepare Before you start, make sure you have: From fa675231a8c028cd10a0858a5a2fadadef9d09ef Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Fri, 12 Jun 2020 19:27:10 +0800 Subject: [PATCH 2/2] Update faq/tidb-faq.md --- faq/tidb-faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq/tidb-faq.md b/faq/tidb-faq.md index 4cbd9644ea53f..27a3302402d5b 100644 --- a/faq/tidb-faq.md +++ b/faq/tidb-faq.md @@ -250,7 +250,7 @@ Check the time difference between the machine time of the monitor and the time w > **Warning:** > -> TiDB Ansible deployment method is deprecated since TiDB v4.0. [Use TiUP to deploy TiDB](/production-offline-deployment-using-tiup.md) instead. +> It is not recommended to deploy TiDB using TiDB Ansible since TiDB v4.0. [Use TiUP to deploy TiDB](/production-offline-deployment-using-tiup.md) instead. #### How to deploy TiDB quickly using Docker Compose on a single machine?