This guide describes how to deploy a TiDB cluster offline using Ansible.
Before you start, make sure that you have:
A download machine
Several target machines and one Control Machine
Take the following steps to install system dependencies on the Control Machine installed with the CentOS 7 system.
pip offline installation package to 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
This offline installation package includes
sshpass, and only supports the CentOS 7 system.
After the installation is finished, you can use
pip -V to check whether it is successfully installed.
# pip -V 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 Ansible and its dependencies offline.
tidbuser on the Control Machine and generate the SSH key
Currently, the TiDB 2.0 GA version and the master version are compatible with Ansible 2.5. Ansible and the related dependencies are in the
Download Ansible 2.5 offline installation package.
Install 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 Ansible.
After Ansible is installed, you can view the version using
# ansible --version ansible 2.5.0
The relationship between the
tidb-ansible version and the TiDB version is as follows:
|TiDB version||tidb-ansible tag||Note|
|2.0 version||v2.0.10, v2.0.11||It is the latest 2.0 stable version which can be used in the production environment.|
|2.1 version||v2.1.1 ~ v2.1.6||It is the latest 2.1 stable version which can be used in the production environment (recommended).|
|3.0 version||v3.0.0-beta, v3.0.0-beta.1||It is currently a beta version which is not recommended to use in the production environment.|
||None||It includes the newest features and is updated on a daily basis, so it is not recommended to use it in the production environment.|
If you have questions regarding which version to use, email to email@example.com for more information or file an issue.
Install Ansible on the download machine.
Use the following method to install Ansible online on the download machine installed with the CentOS 7 system. After Ansible is installed, you can view the version using
# yum install epel-release # yum install ansible curl # ansible --version ansible 2.5.0
Make sure that the version of Ansible is 2.5, otherwise a compatibility issue occurs.
Use the following command to download the corresponding version of TiDB-Ansible from the GitHub TiDB-Ansible project. The default folder name is
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.
Download the tidb-ansible version with a specified tag:
$ git clone -b $tag https://github.com/pingcap/tidb-ansible.git
Download the tidb-ansible version that corresponds to the
master branch of TiDB:
$ git clone https://github.com/pingcap/tidb-ansible.git
local_prepare.yml playbook, 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-ansible folder to the
/home/tidb directory of the Control Machine. The ownership authority of the file must be the
Note: 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 ignore this step. See How to check whether the NTP service is normal.
inventory.inifile to orchestrate the TiDB cluster
You do not need to run the playbook in
You can use the
Report button on the Grafana Dashboard to generate the PDF file. This function depends on the
fontconfig package and English fonts. To use this function, download the offline installation package, upload it to the
grafana_servers machine, and install it. This package includes
open-sans-fonts, and only supports the CentOS 7 system.
$ tar -xzvf grafana-font-rpms.el7.tar.gz $ cd grafana-font-rpms.el7 $ chmod u+x install_grafana_font_rpms.sh $ ./install_grafana_font_rpms.sh