summaryrefslogtreecommitdiff
path: root/docs/configuration/highavailability
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@vyos.io>2024-11-07 17:38:08 +0000
committerGitHub <noreply@github.com>2024-11-07 17:38:08 +0000
commitef82f2a53ba35ea5ebad4438bb45adc370862f2c (patch)
tree32d7b424c100da61d2d431eb5f4afca4486f5b9f /docs/configuration/highavailability
parent2707e9ac6778eb9e71937bebc484290a0be03adb (diff)
parentb6e494eca6a88bd98309be47bb9fa10e48bf221b (diff)
downloadvyos-documentation-ef82f2a53ba35ea5ebad4438bb45adc370862f2c.tar.gz
vyos-documentation-ef82f2a53ba35ea5ebad4438bb45adc370862f2c.zip
Merge pull request #1565 from aapostoliuk/vrrp-script
VRRP: Added additional information about scripting.
Diffstat (limited to 'docs/configuration/highavailability')
-rw-r--r--docs/configuration/highavailability/index.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/configuration/highavailability/index.rst b/docs/configuration/highavailability/index.rst
index 93d01364..a7683ef3 100644
--- a/docs/configuration/highavailability/index.rst
+++ b/docs/configuration/highavailability/index.rst
@@ -308,9 +308,16 @@ execute custom checks in addition to the master router reachability. Transition
scripts are executed when VRRP state changes from master to backup or fault and
vice versa and can be used to enable or disable certain services, for example.
+.. warning:: It is not recommended to change VRRP configuration inside health-check
+ and transition scripts.
+
Health check scripts
^^^^^^^^^^^^^^^^^^^^
+There is the ability to run an arbitrary script at regular intervals according to health-check
+parameters. If a script returns 0, it indicates success. If a script returns anything
+else, it will indicate that the VRRP instance should enter the FAULT state.
+
This setup will make the VRRP process execute the
``/config/scripts/vrrp-check.sh script`` every 60 seconds, and transition the
group to the fault state if it fails (i.e. exits with non-zero status) three