TiProxy Deployment Topology

This document describes the deployment topology of TiProxy based on the minimal TiDB topology.

TiProxy is a L7 proxy server for TiDB, which can balance connections and migrate sessions when possible.

Topology information

InstanceCountPhysical machine configurationIPConfiguration
TiDB316 VCore 32GB 310.0.1.4
10.0.1.5
10.0.1.6		Default port
Global directory configuration
PD34 VCore 8GB 310.0.1.1
10.0.1.2
10.0.1.3		Default port
Global directory configuration
TiKV316 VCore 32GB 2TB (nvme ssd) 310.0.1.7
10.0.1.8
10.0.1.9		Default port
Global directory configuration
TiProxy34 VCore 8 GB 110.0.1.11Default port
Global directory configuration
Monitoring & Grafana14 VCore 8GB * 1 500GB (ssd)10.0.1.13Default port
Global directory configuration

Topology templates

For more information about the template for TiProxy, see The simple template for the TiProxy topology.

For detailed descriptions of the configuration items in the preceding TiDB cluster topology file, see Topology Configuration File for Deploying TiDB Using TiUP.

Key parameters

  • The instance level "-host" configuration in tiproxy_servers only supports IP, not domain name.
  • For detailed TiProxy parameter description, see TiProxy Configuration.

TiProxy Topology - 图1

Note

  • You do not need to manually create the tidb user in the configuration file. The TiUP cluster component automatically creates the tidb user on the target machines. You can customize the user, or keep the user consistent with the control machine.
  • If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.