From 0e34919dec9981dd46e930ad217e72daec93a7ed Mon Sep 17 00:00:00 2001 From: Quentin Armitage Date: Tue, 10 Nov 2015 07:57:01 +0000 Subject: Update man pages keepalived.conf.5 is updated to include all configuration parameters, and keepalived.8 is updated to document the signals that can be used with keepalived. Signed-off-by: Quentin Armitage (cherry picked from commit 4ceb6fe2c149a14ff17d69fad3f783030925f736) --- doc/man/man5/keepalived.conf.5 | 58 ++++++++++++++++++++++++++++++++++++++++-- doc/man/man8/keepalived.8 | 45 ++++++++++++++++++++++++++++++-- 2 files changed, 99 insertions(+), 4 deletions(-) diff --git a/doc/man/man5/keepalived.conf.5 b/doc/man/man5/keepalived.conf.5 index e40440d..076fe04 100644 --- a/doc/man/man5/keepalived.conf.5 +++ b/doc/man/man5/keepalived.conf.5 @@ -57,8 +57,10 @@ and vrrp_garp_master_refresh_repeat 2 # default 1 enable_traps # enable SNMP traps + plugin_dir # UNIMPLEMENTED } + linkbeat_use_polling # Poll to detect media link failure otherwise attempt to use ETHTOOL or MII interface .SH Static routes/addresses/rules .PP @@ -132,6 +134,8 @@ and # Send email notification during state transition, # using addresses in global_defs above. smtp_alert + + global_tracking # All VRRP share same tracking conf } .SH VRRP instance(s) @@ -160,6 +164,8 @@ which will transition together on any state change. # VMAC interface vmac_xmit_base + native_ipv6 # force instance to use IPv6 (when mixed IPv4 and IPv6 config). + # Ignore VRRP interface faults (default unset) dont_track_primary @@ -168,9 +174,16 @@ which will transition together on any state change. track_interface { eth0 eth1 + eth2 weight <-254..254> ... } + # add a tracking script to the interface + track_script { + + weight <-254..254> + } + # default IP for binding vrrpd is the primary IP # on interface. If you want to hide location of vrrpd, # use this IP as src_addr for multicast or unicast vrrp @@ -180,6 +193,8 @@ which will transition together on any state change. mcast_src_ip unicast_src_ip + version <2 or 3> # VRRP version to run on interface (default 2) + # Do not send VRRP adverts over VRRP multicast group. # Instead it sends adverts to the following list of # ip addresses using unicast design fashion. It can @@ -250,9 +265,19 @@ which will transition together on any state change. 192.168.110.0/24 via 192.168.200.254 dev eth1 192.168.111.0/24 dev eth2 192.168.112.0/24 via 192.168.100.254 - 192.168.113.0/24 via 192.168.200.254 or 192.168.100.254 dev eth1 - blackhole 192.168.114.0/24 + 192.168.113.0/24 via 192.168.200.254 or 192.168.100.254 dev eth1 + blackhole 192.168.114.0/24 + 0.0.0.0/0 gw 192.168.0.1 table 100 # To set a default gateway into table 100. + } + + # rules add|del when changing to MASTER, to BACKUP + virtual_rules { + from 192.168.2.0/24 table 1 + to 192.168.2.0/24 table 1 } + + accept # Allow the non-master owner to process the packets destined to VIP + # rules add|del when changing to MASTER, to BACKUP static_rules { from 192.168.2.0/24 table 1 @@ -267,6 +292,7 @@ which will transition together on any state change. # NOTE: For this to work, the initial state of this # entry must be BACKUP. nopreempt + preempt # for backwards compatibility # Seconds after startup until preemption # (if not disabled by "nopreempt"). @@ -282,10 +308,32 @@ which will transition together on any state change. notify_master | notify_backup | notify_fault | + notify_stop | # run when stopping vrrp notify | smtp_alert } +# Adds a script to be executed periodically. Its exit code will be +# recorded for all VRRP instances which are monitoring it with +# non-zero weight. +vrrp_script { + script # path of script to execute + interval # seconds between script invocations, default 1 second + timeout # seconds after which script is considered to have failed + weight # adjust priority by this weight, default 2 + rise # required number of successes for OK transition + fall # required number of successes for KO transition +} + +# Parameters used for SSL GET check. +# If none of the parameters are specified, the SSL context will be auto generated +SSL { + password # password + ca # ca file + certificate # certificate file + key # key file +} + .SH LVS CONFIGURATION contains subblocks of .B Virtual server group(s) @@ -356,6 +404,9 @@ A virtual_server can be a declaration of one of # suspend healthchecker's activity ha_suspend + lvs_sched # synonym for lb_algo + lvs_method # synonym for lb_kind + # VirtualHost string for HTTP_GET or SSL_GET # eg virtualhost www.firewall.loc virtualhost @@ -412,6 +463,9 @@ A virtual_server can be a declaration of one of # considers service as down. notify_down | + uthreshold # maximum number of connections to server + lthreshold # minimum number of connections to server + # pick one healthchecker # HTTP_GET|SSL_GET|TCP_CHECK|SMTP_CHECK|MISC_CHECK diff --git a/doc/man/man8/keepalived.8 b/doc/man/man8/keepalived.8 index 5ae1c73..5d9d8b3 100644 --- a/doc/man/man8/keepalived.8 +++ b/doc/man/man8/keepalived.8 @@ -34,8 +34,8 @@ well\-known and widely used Linux Virtual Server (IPVS) kernel module providing Layer4 load\-balancing. Keepalived implements a set of checkers to dynamically and adaptively maintain and manage load\-balanced server pool according their health. Keepalived also -implements the VRRPv2 protocol to achieve high\-availability with -director failover. +implements the VRRPv2 and VRRPv3 protocols to achieve high\-availability +with director failover. .SH "OPTIONS" .TP @@ -61,6 +61,9 @@ Detailed log messages. \fB -S, --log-facility\fP=[0-7] Set syslog facility to LOG_LOCAL[0-7]. The default syslog facility is LOG_DAEMON. .TP +\fB -X, --release-vips\fP +Drop VIP on transition from signal. +.TP \fB -V, --dont-release-vrrp\fP Don't remove VRRP VIPs and VROUTEs on daemon stop. The default behavior is to remove all VIPs and VROUTEs when keepalived exits @@ -105,6 +108,44 @@ Display the version and exit. \fB -h, --help\fP Display this help message and exit. +.SH SIGNALS +.B keepalived +reacts to a set of signals. You may easily send a signal to +the parent +.B keepalived +process using the following: +.IP +.nf +kill -SIGNAL $(cat /var/run/keepalived.pid) +.fi +.PP +Note that -SIGNAL must be replaced with the actual signal +you are trying to send, e.g. with HUP. So it then becomes: +.IP +.nf +kill -HUP $(cat /var/run/keepalived.pid) +.fi +.PP +.TP +.B HUP +This causes +.B keepalived +to close down all interfaces, reload its configuration, and start up the +new configuration. +.TP +.B TERM, INT +.B keepalived +will die. +.TP +.B USR1 +Write configuration data to +.B /tmp/keepalived.data +.TP +.B USR2 +Write statistics info to +.B /tmp/keepalived.stats +.LP + .SH "SEE ALSO" \fBkeepalived.conf\fP(5), \fBipvsadm\fP(8) -- 1.7.12.1