Skip to content

Commit 1fac388

Browse files
jmacdotorgdormando
authored andcommitted
Clarify across several reference entries that children can take either a pool list or a set name.
1 parent 8b0bee3 commit 1fac388

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

content/features/proxy/reference.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,15 @@ result that it received.
2929

3030
```lua
3131
route_allsync{
32-
children = { "{{<var>}}POOL_NAME{{</var>}}", [ ... ] }
32+
children = {{<var>}}POOL_LIST_OR_SET_NAME{{</var>}}
3333
}
3434
```
35+
Replace <var>POOL_LIST_OR_SET_NAME</var> with either one of the following:
36+
37+
* A bracketed, comma-separated list of of pool names defined in the `pools{}` block of your configuration file—for example, `{ "cust_pool_1", "cust_pool_2" }`.
38+
39+
* The name of a set defined in the `pools{}` block of your configuration file—for example, `"set_cust_pools"`.
40+
3541

3642
### `route_allfastest`
3743

@@ -41,10 +47,16 @@ The proxy returns the first response that it receives from any pool.
4147

4248
```lua
4349
route_allfastest{
44-
children = { "{{<var>}}POOL_NAME{{</var>}}", [ ... ] }
50+
children = {{<var>}}POOL_LIST_OR_SET_NAME{{</var>}}
4551
}
4652
```
4753

54+
Replace <var>POOL_LIST_OR_SET_NAME</var> with either one of the following:
55+
56+
* A bracketed, comma-separated list of of pool names defined in the `pools{}` block of your configuration file—for example, `{ "cust_pool_1", "cust_pool_2" }`.
57+
58+
* The name of a set defined in the `pools{}` block of your configuration file—for example, `"set_cust_pools"`.
59+
4860
### `route_split`
4961

5062
Routes a request to exactly two pools.
@@ -81,7 +93,7 @@ Routes the request to a list of pools, serially. You can tune the behavior of th
8193

8294
```lua
8395
route_failover{
84-
children = { "{{<var>}}POOL_NAME{{</var>}}", [ ... ] },
96+
children = {{<var>}}POOL_LIST_OR_SET_NAME{{</var>}},
8597
failover_count = {{<var>}}FAILOVER_COUNT{{</var>}},
8698
shuffle = {{<var>}}SHUFFLE_BOOLEAN{{</var>}},
8799
miss = {{<var>}}MISS_BOOLEAN{{</var>}},
@@ -90,7 +102,9 @@ route_failover{
90102

91103
Replace the following:
92104

93-
* <var>POOL_NAME</var>: the name of a pool defined in the `pools{}` block of your configuration file.
105+
* <var>POOL_LIST_OR_SET_NAME</var>: either one of the following:
106+
* A bracketed, comma-separated list of of pool names defined in the `pools{}` block of your configuration file—for example, `{ "cust_pool_1", "cust_pool_2" }`.
107+
* The name of a set defined in the `pools{}` block of your configuration file—for example, `"set_cust_pools"`.
94108
* <var>FAILOVER_COUNT</var>: the number of failures that the proxy receives from a pool before fails over to the next pool in the list.
95109
* <var>SHUFFLE_BOOLEAN</var>: if true, then the proxy randomizes the list of pools before routing the request. Otherwise, uses the list of pools in the given order.
96110
* <var>MISS_BOOLEAN</var>: if true, then the proxy treats both misses and errors as failures. Otherwise, the proxy counts only errors as failures.

0 commit comments

Comments
 (0)