Skip to content

Commit

Permalink
readme: add future plans and blog link (#370)
Browse files Browse the repository at this point in the history
  • Loading branch information
djshow832 authored Sep 20, 2023
1 parent 01f1152 commit e4b65b7
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ TiProxy is forked from [Weir](https://github.com/tidb-incubator/weir).

When a TiDB instance restarts or shuts down, TiProxy migrates backend connections on this instance to other instances. In this way, the clients won't be disconnected.

For more details, please refer to the blog [Achieving Zero-Downtime Upgrades with TiDB](https://www.pingcap.com/blog/achieving-zero-downtime-upgrades-tidb/).

### Load Balance

TiProxy routes new connections to backends based on their scores to keep load balanced. The score is basically calculated from the connections on each backend.
Expand All @@ -26,6 +28,22 @@ The TiProxy also checks health on TiDB instances to ensure they are alive, and m

For more details, see [Design Doc](https://github.com/pingcap/tidb/blob/master/docs/design/2022-07-20-session-manager.md).

## Future Plans

TiProxy's role as a versatile database proxy is continuously evolving to meet the diverse needs of self-hosting users. Here are some of the key expectations that TiProxy is poised to fulfill:

### Tenant Isolation

In a multi-tenant database environment that supports database consolidation, TiProxy offers the ability to route connections based on usernames or client addresses. This ensures the effective isolation of TiDB resources, safeguarding data and performance for different tenants.

### Traffic Management

Sudden traffic spikes can catch any system off guard. TiProxy steps in with features like rate limiting and query refusal in extreme cases, enabling you to better manage and control incoming traffic to TiDB.

### Post-Upgrade Validation

Ensuring the smooth operation of TiDB after an upgrade is crucial. TiProxy can play a vital role in this process by replicating traffic and replaying it on a new TiDB cluster. This comprehensive testing helps verify that the upgraded system works as expected.

## Build

Build the binary in local:
Expand Down Expand Up @@ -140,7 +158,7 @@ spec:
baseImage: pingcap/tikv
tiproxy:
replicas: 1
baseImage: {your-image}
baseImage: pingcap/tiproxy
```
Note that if you have enabled `tlsCluster`, you don't need to set the signing certs, `additionalVolumes` and `additionalVolumeMounts`.
Expand Down

0 comments on commit e4b65b7

Please sign in to comment.