summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMaria Matejka <mq@ucw.cz>2022-07-28 13:50:59 +0200
committerMaria Matejka <mq@ucw.cz>2022-08-02 17:34:38 +0200
commitf8500b5943490ca62a1538fead4d8a88ad189c5a (patch)
tree6b1dfdbd707ea94bd1c0128021bd3ed0b7d49589 /doc
parent058ed711397df75350d905fc135758a6470c0143 (diff)
Route table cork: Indicate whether the export queues are congested.
These routines detect the export congestion (as defined by configurable thresholds) and propagate the state to readers. There are no readers for now, they will be added in following commits.
Diffstat (limited to 'doc')
-rw-r--r--doc/bird.sgml9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml
index c48b064c..a4d7cb0c 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -699,6 +699,15 @@ to set options.
periods. Default: adaptive, based on number of routing tables in the
configuration. From 10 s (with <= 25 routing tables) up to 600 s (with
>= 1500 routing tables).
+
+ <tag><label id="rtable-cork-threshold">cork threshold <m/number/ <m/number/</tag>
+ Too many pending exports may lead to memory bloating. In such cases,
+ BIRD tries to relieve the memory pressure by pausing some routines until
+ the queue sizes get low enough. This option allows the user to set the
+ thresholds; first value is the low threshold (when to resume), the
+ second one is the high threshold (when to pause). The higher is the
+ threshold, the more memory can get used. In most cases, the defaults
+ should work for you. Default: 128, 512.
</descrip>