summaryrefslogtreecommitdiff
path: root/docs/configuration/highavailability/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/highavailability/index.rst')
-rw-r--r--docs/configuration/highavailability/index.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/configuration/highavailability/index.rst b/docs/configuration/highavailability/index.rst
index c82391c7..952a345b 100644
--- a/docs/configuration/highavailability/index.rst
+++ b/docs/configuration/highavailability/index.rst
@@ -347,6 +347,22 @@ times:
.. start_vyoslinter
+An optional ``timeout`` can be set to define the maximum number of seconds the
+script is allowed to run. This is useful for scripts that may hang or take
+longer than expected — setting the timeout higher than the interval allows
+longer-running scripts to complete before being considered failed.
+
+.. stop_vyoslinter
+
+.. code-block:: none
+
+ set high-availability vrrp group Foo health-check script /config/scripts/vrrp-check.sh
+ set high-availability vrrp group Foo health-check interval 20
+ set high-availability vrrp group Foo health-check failure-count 3
+ set high-availability vrrp group Foo health-check timeout 40
+
+.. start_vyoslinter
+
When the vrrp group is a member of the sync group will use only
the sync group health check script.
This example shows how to configure it for the sync group: