For production environments, it is recommended that you deploy TiDB using TiUP offline. Since v4.0, PingCAP no longer provides support for deploying TiDB using TiDB Ansible (deprecated). If you really need to use it for deployment, be aware of any risk. You can import the TiDB cluster deployed by TiDB Ansible to TiUP.
If you only want to try out TiDB and explore new features, refer to Quick Start Guide for the TiDB Database Platform.
This guide describes how to deploy a TiDB cluster offline using TiDB Ansible.
Before you start, make sure that you have:
A download machine
- The machine must have access to the Internet in order to download TiDB Ansible, TiDB and related packages.
- For Linux operating system, it is recommended to install CentOS 7.3 or later.
Several target machines and one control machine
- For system requirements and configuration, see Prepare the environment.
- It is acceptable without access to the Internet.
Take the following steps to install system dependencies on the control machine installed with the CentOS 7 system.
pipoffline installation package on the download machine and then upload it to the control machine.
This offline installation package includes
sshpass, and only supports the CentOS 7 system.
Install system dependencies on the control machine.
tar -xzvf ansible-system-rpms.el7.tar.gz && cd ansible-system-rpms.el7 && chmod u+x install_ansible_system_rpms.sh && ./install_ansible_system_rpms.sh
After the installation is finished, you can use
pip -Vto check whether it is successfully installed.
pip 8.1.2 from /usr/lib/python2.7/site-packages (python 2.7)
pipis already installed to your system, make sure that the version is 8.1.2 or later. Otherwise, compatibility error occurs when you install TiDB Ansible and its dependencies offline.
Currently, all the versions of TiDB Ansible from 2.4 to 2.7.11 are supported. The versions of TiDB Ansible and the related dependencies are listed in the
tidb-ansible/requirements.txt file. The following installation steps take Ansible 2.5 as an example.
Download Ansible 2.5 offline installation package on the download machine and then upload it to the control machine.
Install TiDB Ansible and its dependencies offline.
tar -xzvf ansible-2.5.0-pip.tar.gz && cd ansible-2.5.0-pip/ && chmod u+x install_ansible.sh && ./install_ansible.sh
View the version of TiDB Ansible.
After TiDB Ansible is installed, you can view the version using
Install TiDB Ansible on the download machine.
Use the following method to install Ansible online on the download machine installed with the CentOS 7 system. After TiDB Ansible is installed, you can view the version using
yum install epel-release && yum install ansible curl && ansible --version
Make sure that the version of Ansible is 2.5, otherwise a compatibility issue occurs.
Download TiDB Ansible.
Use the following command to download the corresponding version of TiDB Ansible from the TiDB Ansible project GitHub repo. The default folder name is
git clone https://github.com/pingcap/tidb-ansible.git
It is required to use the corresponding tidb-ansible version when you deploy and upgrade the TiDB cluster. If you deploy TiDB using a mismatched version of tidb-ansible (such as using tidb-ansible v2.1.4 to deploy TiDB v2.1.6), an error might occur.
local_prepare.ymlplaybook, and download TiDB binary online to the download machine.
cd tidb-ansible && ansible-playbook local_prepare.yml
After running the above command, copy the
tidb-ansiblefolder to the
/home/tidbdirectory of the control machine. The ownership authority of the file must be the
If the time and time zone of all your target machines are same, the NTP service is on and is normally synchronizing time, you can skip this step. See How to check whether the NTP service is normal.
You do not need to run the playbook in
By default, TiDB periodically shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see Telemetry.
- Deploy TiDB Offline Using TiDB Ansible
- Step 1: Install system dependencies on the control machine
- Step 2: Create the tidb user on the control machine and generate the SSH key
- Step 3: Install TiDB Ansible and its dependencies offline on the control machine
- Step 4: Download TiDB Ansible and TiDB packages on the download machine
- Step 5: Configure the SSH mutual trust and sudo rules on the control machine
- Step 6: Install the NTP service on the target machines
- Step 7: Configure the CPUfreq governor mode on the target machine
- Step 8: Mount the data disk ext4 filesystem with options on the target machines
- Step 9: Edit the inventory.ini file to orchestrate the TiDB cluster
- Step 10: Deploy the TiDB cluster
- Test the TiDB cluster