Create a Private Mirror

When creating a private cloud, usually, you need to use an isolated network environment, where the official mirror of TiUP is not accessible. Therefore, you can create a private mirror, which is mainly implemented by the mirrors component. You can also use mirrors for offline deployment.

TiUP `mirrors` overview

Execute the following command to get the help information of the mirrors component:

tiup mirrors --help

Starting component `mirrors`: /Users/joshua/.tiup/components/mirrors/v0.0.1/mirrors
Build a local mirrors and download all selected components
Usage:
  tiup mirrors <target-dir> [global-version] [flags]
Examples:
  tiup mirrors local-path --arch amd64,arm --os linux,darwin    # Specify the architectures and OSs
  tiup mirrors local-path --full                                # Build a full local mirrors
  tiup mirrors local-path --tikv v4                             # Specify the version via prefix
  tiup mirrors local-path --tidb all --pd all                   # Download all version for specific component
Flags:
      --overwrite                   Overwrite the exists tarball
  -f, --full                        Build a full mirrors repository
  -a, --arch strings                Specify the downloading architecture (default [amd64])
  -o, --os strings                  Specify the downloading os (default [linux,darwin])
      --tidb strings                Specify the versions for component tidb
      --tikv strings                Specify the versions for component tikv
      --pd strings                  Specify the versions for component pd
      --playground strings          Specify the versions for component playground
      --client strings              Specify the versions for component client
      --prometheus strings          Specify the versions for component prometheus
      --package strings             Specify the versions for component package
      --grafana strings             Specify the versions for component grafana
      --alertmanager strings        Specify the versions for component alertmanager
      --blackbox_exporter strings   Specify the versions for component blackbox_exporter
      --node_exporter strings       Specify the versions for component node_exporter
      --pushgateway strings         Specify the versions for component pushgateway
      --tiflash strings             Specify the versions for component tiflash
      --drainer strings             Specify the versions for component drainer
      --pump strings                Specify the versions for component pump
      --cluster strings             Specify the versions for component cluster
      --mirrors strings             Specify the versions for component mirrors
      --bench strings               Specify the versions for component bench
      --insight strings             Specify the versions for component insight
      --doc strings                 Specify the versions for component doc
      --ctl strings                 Specify the versions for component ctl
  -h, --help                        help for tiup

The basic usage of the tiup mirrors command is as follows:

tiup mirrors <target-dir> [global-version] [flags]

target-dir: used to specify the directory in which cloned data is stored.
global-version: used to quickly set a global version for all components.

The tiup mirrors command provides many optional flags (might provide more in the future). These flags can be divided into the following categories according to their intended usages:

Determines whether to overwrite local packages

The --overwrite flag determines whether to overwrite the local package with the package of the official mirror, if the specified <target-dir> directory contains the package you need to download. If you set this flag, the local package is overwritten.
Determines whether to use the full clone

If you specify the --full flag, you can clone the official mirror fully.

Note:

If --full and the other flags are not specified, only some meta information is cloned.
Determines whether to clone packages from the specific platform

If you want to clone packages only for a specific platform, use -os and -arch to specify the platform. For example:
- Execute the tiup mirros <target-dir> --os=linux command to clone for linux.
- Execute the tiup mirros <target-dir> --arch=amd64 command to clone for amd64.
- Execute the tiup mirros <target-dir> --os=linux --arch=amd64 command to clone for linux/amd64.
Determines whether to clone a specific version of a package

If you want to clone only one version (not all versions) of a component, use --<component>=<version> to specify this version. For example:
- Execute the tiup mirrors <target-dir> --tidb v4 command to clone the v4 version of the TiDB component.
- Execute the tiup mirros <target-dir> --tidb v4 --tikv all command to clone the v4 version of the TiDB component and all versions of the TiKV component.
- Execute the tiup mirrors <target-dir> v4.0.0-rc command to clone the v4.0.0-rc version of all components in a cluster.

Usage examples

This section introduces the usage examples of mirrors, including offline installation of a TiDB cluster, and the creation of a private mirror.

Install a TiDB cluster offline using TiUP

If you want to install a TiDB cluster of the v4.0.0-rc version in an isolated environment, take the following steps:

Pull the required components on a machine connected to the external network:

{{< copyable "shell-regular" >}}
```
tiup mirrors package --os=linux v4.0.0-rc
```
Then a package directory is created in the current directory. This package directory contains necessary components packages to start a cluster.
Use the tar command to pack the components package and send this package to the control machine that is in the isolated environment:

{{< copyable "shell-regular" >}}
```
tar czvf package.tar.gz package
```
Then package.tar.gz is an isolated, offline environment.
After sending the package to the control machine of the target cluster, execute the following command to install TiUP:

{{< copyable "shell-regular" >}}
```
tar xzvf package.tar.gz
cd package
sh local_install.sh
```
Follow the instructions to finish the installation of TiUP, and then deploy the TiDB cluster:

{{< copyable "shell-regular" >}}
```
export TIUP_MIRRORS=/path/to/mirror
tiup cluster deploy <cluster-name> <cluster-version> <topology-file>
tiup cluster start <cluster-name>
```
/path/to/mirror refers to where <target-dir> (in tiup mirrors <target-dir>) is. If /tmp/package refers to where <target-dir> is, execute the following command instead:

{{< copyable "shell-regular" >}}
```
export TIUP_MIRRORS=/tmp/package
```

After you complete the deployment, refer to Deploy and Maintain an Online TiDB Cluster Using TiUP for more details of the cluster operations.