summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRuss White <russ@riw.us>2019-09-17 13:48:14 +0200
committerGitHub <noreply@github.com>2019-09-17 13:48:14 +0200
commitf0b7ed8823b4dcc10cdace50411a4ab0b60fd384 (patch)
treedaf8b0582fba093e3679de8f53a5a9dc2607bef7 /doc
parentMerge pull request #4981 from donaldsharp/bgp_distance (diff)
parentwatchfrr: Convert `wtf` to a more meaningful message (diff)
downloadfrr-f0b7ed8823b4dcc10cdace50411a4ab0b60fd384.tar.xz
frr-f0b7ed8823b4dcc10cdace50411a4ab0b60fd384.zip
Merge pull request #4988 from donaldsharp/watchfrr_ignore_daemon
Watchfrr ignore daemon
Diffstat (limited to 'doc')
-rw-r--r--doc/user/index.rst1
-rw-r--r--doc/user/subdir.am1
-rw-r--r--doc/user/watchfrr.rst30
3 files changed, 32 insertions, 0 deletions
diff --git a/doc/user/index.rst b/doc/user/index.rst
index 6c3b14e06..416c51f13 100644
--- a/doc/user/index.rst
+++ b/doc/user/index.rst
@@ -58,6 +58,7 @@ Protocols
vnc
vrrp
bmp
+ watchfrr
########
Appendix
diff --git a/doc/user/subdir.am b/doc/user/subdir.am
index 0f0a8a077..ce519fbfb 100644
--- a/doc/user/subdir.am
+++ b/doc/user/subdir.am
@@ -43,6 +43,7 @@ user_RSTFILES = \
doc/user/zebra.rst \
doc/user/bfd.rst \
doc/user/flowspec.rst \
+ doc/user/watchfrr.rst \
# end
EXTRA_DIST += \
diff --git a/doc/user/watchfrr.rst b/doc/user/watchfrr.rst
new file mode 100644
index 000000000..df04a1e37
--- /dev/null
+++ b/doc/user/watchfrr.rst
@@ -0,0 +1,30 @@
+.. _watchfrr:
+
+********
+WATCHFRR
+********
+
+:abbr:`WATCHFRR` is a daemon that handles failed daemon processes and
+intelligently restarts them as needed.
+
+Starting WATCHFRR
+=================
+
+WATCHFRR is started as per normal systemd startup and typically does not
+require end users management.
+
+WATCHFRR commands
+=================
+
+.. index:: show watchfrr
+.. clicmd:: show watchfrr
+
+ Give status information about the state of the different daemons being
+ watched by WATCHFRR
+
+.. index:: [no] watchfrr ignore DAEMON
+.. clicmd:: [no] watchfrr ignore DAEMON
+
+ Tell WATCHFRR to ignore a particular DAEMON if it goes unresponsive.
+ This is particularly useful when you are a developer and need to debug
+ a working system, without watchfrr pulling the rug out from under you.