TiProxy Deployment Topology
October 11, 2025 ยท View on GitHub
This document describes the deployment topology of TiProxy based on the minimal TiDB topology.
For other deployment methods, refer to the following documents:
- To deploy TiProxy using TiDB Operator, see the TiDB Operator documentation.
- To quickly deploy TiProxy locally using TiUP, see Deploy TiProxy.
- To deploy TiProxy using TiUP, see Installation and usage.
TiProxy is a L7 proxy server for TiDB, which can balance connections and migrate sessions when possible.
Topology information
| Instance | Count | Physical machine configuration | IP | Configuration |
|---|---|---|---|---|
| TiDB | 3 | 16 VCore 32GB * 3 | 10.0.1.4 10.0.1.5 10.0.1.6 | Default port Global directory configuration |
| PD | 3 | 4 VCore 8GB * 3 | 10.0.1.1 10.0.1.2 10.0.1.3 | Default port Global directory configuration |
| TiKV | 3 | 16 VCore 32GB 2TB (nvme ssd) * 3 | 10.0.1.7 10.0.1.8 10.0.1.9 | Default port Global directory configuration |
| TiProxy | 2 | 4 VCore 8 GB * 1 | 10.0.1.11 10.0.1.12 | Default port Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.13 | Default port Global directory configuration |
Note:
The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
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 intiproxy_serversonly supports IP, not domain name. - For detailed TiProxy parameter description, see TiProxy Configuration.
Note:
- You do not need to manually create the
tidbuser in the configuration file. The TiUP cluster component automatically creates thetidbuser 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.