Skip to content

Commit 4ff9532

Browse files
committed
delete documentation for proxy elastic mode
1 parent b90b6ff commit 4ff9532

File tree

2 files changed

+7
-16
lines changed

2 files changed

+7
-16
lines changed

using-gatewayd/configuration.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,6 @@ pools:
9595

9696
proxies:
9797
default:
98-
elastic: False
99-
reuseElasticClients: False
10098
healthCheckPeriod: 60s # duration
10199

102100
servers:

using-gatewayd/global-configuration/proxies.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,27 @@ grand_parent: Using GatewayD
1010

1111
# Proxies
1212

13-
The proxy object is used to proxy connections between database clients and servers. At the moment two types of proxies are supported by GatewayD:
13+
The proxy object is used to proxy connections between database clients and servers.
1414

15-
1. **Fixed**: a fixed proxy creates a pool with a fixed number of connection to the database server.
16-
2. **Elastic**: an elastic proxy will create a new connection to the database server when a new database client is connected, that is *on-demand*. The connections can be reused.
17-
18-
Both of the above proxies will honor the pool capacity, and if the number of connections from the clients is more than the capacity, new connections will be rejected.
15+
GatewayD supports a fixed proxy that creates a pool with a fixed number of connection to the database server. It honors the pool capacity, and if the number of connections from the clients is more than the capacity, new connections will be rejected.
1916

2017
The PostgreSQL database expects new connections to authenticate before keeping them connected forever, thus the TCP connections from GatewayD will be timed out and dropped. A health check scheduler is started when creating connections to the database. If there are connections available in the available connections pool after the `healthCheckPeriod` is reached, it will remove and recreate new TCP connections to the database and put them in the pool.
2118

2219
Each proxy has two pools:
2320

24-
1. **Available connections pool**: if the fixed proxy is selected, new connections will be created upon start, and they will be put into this pool. Elastic proxy won't have an available connection pool, unless connections are reused.
21+
1. **Available connections pool**: new connections will be created upon start, and they will be put into this pool.
2522
2. **Busy connections pool**: when a new database client is connected to GatewayD, a connection will be removed from the available connections pool and put into this pool. Later when the client is disconnected, the connection will be closed and a new connection will be put back into the available connections pool.
2623

2724
## Configuration parameters
2825

29-
| Name | Type | Default value | Possible values | Description |
30-
| ------------------- | ----------------- | ------------- | ---------------------- | ------------------------------------------------------------------------------------ |
31-
| elastic | boolean | False | True, False | Whether it is an elastic or a fixed proxy. |
32-
| reuseElasticClients | boolean | False | True, False | Whether the disconnected clients will be put back into the pool (reused) or removed. |
33-
| healthCheckPeriod | duration (string) | 60s | Valid duration strings | Intervals between health checks |
26+
| Name | Type | Default value | Possible values | Description |
27+
| ------------------- | ----------------- | ------------- | ---------------------- | ------------------------------- |
28+
| healthCheckPeriod | duration (string) | 60s | Valid duration strings | Intervals between health checks |
3429

3530
## Example configuration
3631

3732
```yaml
3833
proxies:
3934
default:
40-
elastic: False
41-
reuseElasticClients: False
4235
healthCheckPeriod: 60s # duration
43-
```
36+
```

0 commit comments

Comments
 (0)