Skip to content

Commit c3f1aec

Browse files
Apply suggestions from code review
Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com>
1 parent 0001851 commit c3f1aec

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/proxy-modes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,34 @@ In this mode, the client will make all requests through trino-lb, not only the i
1616

1717
Benefits:
1818

19-
* Counting queries can be achieved by "sniffing" the traffic
20-
* Trino clients don't need network access to coordinator
19+
- Counting queries can be achieved by inspecting the traffic
20+
- Trino clients do not require network access to coordinator
2121

2222
Downsides:
2323

24-
* Query runtimes can be increased in case many data is transferred from the Trino coordinator to the Trino client due to network delay added by trino-lb (have a look at [a performance research task](https://github.com/stackabletech/trino-lb/issues/72) for details)
24+
- Query run times can be increased in when a lot of data is transferred from the Trino coordinator to the Trino client due to network delay added by trino-lb (see the [performance research task](https://github.com/stackabletech/trino-lb/issues/72) for details)
2525

2626
## Proxy first call
2727

28-
Only the initial `POST` is proxied, all following requests will be send to the Trino cluster directly.
28+
In this mode, the client only sends the initial `POST` to trino-lb. All following requests will be send to the Trino cluster directly.
2929

3030
As trino-lb can not "sniff" the traffic to get informed about started and finished queries we need to hook it up as [HTTP event listener](https://trino.io/docs/current/admin/event-listeners-http.html) in Trino.
3131
This way trino-lb will get informed about all query starts and completions.
3232

3333
Benefits:
3434

35-
* Better performance, as there is no network delay added by trino-lb
36-
* In the future more advanced features can be build based on information from the Trino events
35+
- Better performance, as there is no network delay added by trino-lb
36+
- In the future more advanced features can be built based on information from the Trino events
3737

3838
Downsides:
3939

40-
* It requires active configuration on the Trino side, namely setting up the HTTP event listener
41-
* Trino clients need to have network access to the coordinators
40+
- It requires active configuration on the Trino side, namely setting up the HTTP event listener
41+
- Trino clients require network access to the coordinator
4242

4343
A sample configuration in Trino can look something like the following.
44-
Please have a look at the [kuttl tests](https://github.com/stackabletech/trino-lb/tree/feat/trino-query-events/tests/templates/kuttl/) for complete examples.
44+
Please have a look at the [kuttl tests](https://github.com/stackabletech/trino-lb/tree/main/tests/templates/kuttl/) for complete examples.
4545

46-
Please note that you can not disable the TLS certificate check, in this case secret-operator from the Stackable Data Platform is used to automatically provision valid TLS certificates.
46+
Please note that you cannot disable the TLS certificate check. In the example below, the secret-operator from the Stackable Data Platform is used to provision valid TLS certificates automatically.
4747

4848
```yaml
4949
apiVersion: trino.stackable.tech/v1alpha1

0 commit comments

Comments
 (0)