TiUP FAQs

This document collects the frequently asked questions (FAQs) about TiUP.

Can TiUP not use the official mirror source?

TiUP supports specifying the mirror source through the TIUP_MIRRORS environment variable. The address of the mirror source can be a local directory or an HTTP server address. If your environment cannot access the network, you can create your own offline mirror source to use TiUP.

After using an unofficial mirror, if you want the official mirror back and use it, take one of the following measures:

• Set the TIUP_MIRRORS variable to the official mirror address: https://tiup-mirrors.pingcap.com.
• Make sure that the TIUP_MIRRORS variable is not set, and then execute the tiup mirror set https://tiup-mirrors.pingcap.com command.

How do I put my own component into the TiUP mirrors?

TiUP does not support third-party components for the time being, but the TiUP Team has developed the TiUP component development specifications and is developing the tiup-publish component. After everything is ready, a contributor can publish their own components to TiUP's official mirrors by using the tiup publish <comp> <version> command.

What is the difference between the TiUP playground and TiUP cluster components?

The TiUP playground component is mainly used to build a stand-alone development environment on Linux or macOS operating systems. It helps you get started quickly and run a specified version of the TiUP cluster easily. The TiUP cluster component is mainly used to deploy and maintain a production environment cluster, which is usually a large-scale cluster.

How do I write the topology file for the TiUP cluster component?

Refer to these templates to write the topology file. The templates include:

• Multi-DC deployment topology
• Minimal deployment topology
• Complete topology file

You can edit your topology file based on the templates and your needs.

Can multiple instances be deployed on the same host?

You can use the TiUP cluster component to deploy multiple instances on the same host, but with different ports and directories configured; otherwise, directory and port conflicts might occur.

Are port and directory conflicts detected within the same cluster?

Port and directory conflicts in the same cluster are detected during deployment and scaling. If there is any directory or port conflict, the deployment or scaling process is interrupted.

Are port and directory conflicts detected among different clusters?

If multiple different clusters are deployed by the same TiUP control machine, the port and directory conflicts among these clusters are detected during deployment and scaling. If the clusters are deployed by different TiUP control machines, conflict detection is not supported currently.

During cluster deployment, TiUP received an ssh: handshake failed: read tcp 10.10.10.34:38980 -> 10.10.10.34:3600: read: connection reset by peer error

The error might occur because the default number of concurrent threads of TiUP exceeds the default maximum number of SSH connections. To solve the issue, you can increase the default number of SSH connections, and then restart the sshd service:

vi /etc/ssh/sshd_config

MaxSessions 1000
MaxStartups 1000