TiUP terms and core concepts

This article mainly explains the important terms and core concepts of TiUP.

TiUP component

The TiUP program contains only a few commands to download, update, and uninstall components.TiUP extends its functionality through various components.Component is a program or script that can be run. When running a component through tiup , TiUP will add a set of environment variables and create corresponding data for the programdirectory, and then run the program.

By running the tiup command, you can run the supported TiUP components, where the running logic is:

1. If the user specifies a specific version of a component by running tiup [:version]:

   • The component does not have any version installed locally, download the latest stable version from the mirror server
   • The component has other versions installed locally, but there is no user-specified version, download the user-specified version from the mirror server
   • If the specified version is already installed locally, set the environment variable to run the installed version

2. If the user runs a component via tiup and no version is specified:

   • The component does not have any version installed locally, download the latest stable version from the mirror server
   • If a partial version is already installed locally, set the environment variable to run the latest version of the installed version

TiUP mirror repository

All components of TiUP are downloaded from mirror repositories (mirrors), which contain TAR packages for each component and corresponding meta information (version, entry startup file, checksum).TiUP uses PingCAP's official mirror repository by default.Users can customize the image repository through the TIUP_MIRRORS environment variable.

The mirror repository can be a local file directory or an online HTTP server:

1. TIUP_MIRRORS=/path/to/local tiup list
2. TIUP_MIRRORS=https://private-mirrors.example.com tiup list