Skip to content

Commit 8b57ea9

Browse files
committed
docs: Link from design page to detail pages
1 parent b454e04 commit 8b57ea9

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/design.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The trait `trino_lb_persistence::Persistence` (think of an interface) allows for
1919

2020
In case you are interested in a implementation for a different persistence please feel free to open an issue or pull request!
2121

22+
Read on the [persistence page](./persistence/index.md) for more details.
23+
2224
## 1. Cluster groups
2325

2426
trino-lb has the concept of so-called "cluster groups" consisting of 1 - n Trino clusters.
@@ -54,6 +56,8 @@ Trino will respond with an resource estimation the query will consume.
5456
Please note that this functional heavily depends on [Table statistics](https://trino.io/docs/current/optimizer/statistics.html) being present for the access tables to get meaningful estimations.
5557
4. [ClientTagsRouter](./routing/ClientTagsRouter.md): Route queries based on client tags send in the `X-Trino-Client-Tags` header.
5658

59+
Read on the [routing page](./routing/index.md) for more details.
60+
5761
## 3. Choosing cluster from cluster group
5862

5963
Once the routers have determined which cluster group the query should run a fitting cluster of this group needs to be chosen.
@@ -88,6 +92,8 @@ Currently the following autoscalers are implemented:
8892

8993
1. [Stackable](./scaling/stackable.md): Autoscales [Stackable TrinoClusters](https://docs.stackable.tech/home/stable/trino/), which are part of the Stackable Data Platform (SDP)
9094

95+
Read on the [scaling page](./scaling/index.md) for more details.
96+
9197
## Monitoring
9298

9399
trino-lb emits [OpenTelemetry Metrics](https://opentelemetry.io/docs/concepts/signals/metrics/), which (for now) are only exposed as [Prometheus](https://prometheus.io/) metrics on `http://0.0.0.0:9090/metrics`.

docs/routing/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
Routing is implemented in a generic fashion by exposing the trait `trino_lb::routing::RouterImplementationTrait` (think of like an interface).
44
Different routing engines can be implemented easily using this trait, please feel free to open an issue or pull request!
55

6-
E.g. a router based on [client tags](https://trino.io/docs/current/develop/client-protocol.html?highlight=client+tag#client-request-headers) would be trivial, but also currently possible via the `PythonScriptRouter`.
7-
86
Currently the following routers are implemented:
97

108
1. [TrinoRoutingGroupHeaderRouter](./TrinoRoutingGroupHeaderRouter.md)

0 commit comments

Comments
 (0)