Add short desciprtion of BFD to man page

Signed-off-by: Quentin Armitage <quentin@armitage.org.uk>
acassen · Dec 31, 2017 · f4d5448 · f4d5448
1 parent 8316ff9
commit f4d5448
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/doc/keepalived.conf.SYNOPSIS b/doc/keepalived.conf.SYNOPSIS
@@ -505,6 +505,15 @@ Likewise, if the vrrp instance is the address owner, weight 0 must also be set.
 
     2.3. BFD Configuration
 
+    This is an implementation of RFC5880 (Bidirectional forwarding detection),
+    and this can be configured to work between 2 keepalived instances, but using
+    unweighted track_bfds between a master/backup pair of VRRP instances means that
+    the VRRP instance will only be able to come up if both VRRP instance are running,
+    which somewhat defeats the purpose of VRRP.
+
+    This imlpementation has been tested with OpenBFDD (available at
+    https://github.com/dyninc/OpenBFDD).
+
     The configuration block looks like :
 
 bfd_instance <STRING> {

diff --git a/doc/man/man5/keepalived.conf.5 b/doc/man/man5/keepalived.conf.5
@@ -522,6 +522,15 @@ and
 .PP
 .SH BFD Configuration
 .PP
+This is an implementation of RFC5880 (Bidirectional forwarding detection),
+and this can be configured to work between 2 keepalived instances, but using
+unweighted track_bfds between a master/backup pair of VRRP instances means that
+the VRRP instance will only be able to come up if both VRRP instance are running,
+which somewhat defeats the purpose of VRRP.
+.PP
+This imlpementation has been tested with OpenBFDD (available at
+https://github.com/dyninc/OpenBFDD).
+.PP
 The configuration block looks like:
 .PP
 bfd_instance <STRING> {
@@ -543,7 +552,7 @@ bfd_instance <STRING> {
                                        #  in received packet (default 0)
                                        #  (255 disables hop count checking)
     weight                             # Default tracking weight
-}
+ }
 .SH VRRP synchronization group(s)
 .PP
  #string, name of group of IPs that failover together

diff --git a/keepalived/bfd/bfd_daemon.c b/keepalived/bfd/bfd_daemon.c
@@ -288,7 +288,7 @@ start_bfd_child(void)
 	signal_handler_destroy();
 
 #ifdef _MEM_CHECK_
-	mem_log_init(PROG_CHECK, "Healthcheck child process");
+	mem_log_init(PROG_CHECK, "BFD child process");
 #endif
 
 	free_parent_mallocs_startup(true);

diff --git a/keepalived/core/main.c b/keepalived/core/main.c
@@ -753,7 +753,7 @@ usage(const char *prog)
 	fprintf(stderr, "  -C, --check                  Only run with Health-checker subsystem\n");
 #endif
 #ifdef _WITH_BFD_
-	fprintf(stderr, "  -B, --no_bfd                    Don't run BFD subsystem\n");
+	fprintf(stderr, "  -B, --no_bfd                 Don't run BFD subsystem\n");
 #endif
 	fprintf(stderr, "  -l, --log-console            Log messages to local console\n");
 	fprintf(stderr, "  -D, --log-detail             Detailed log messages\n");