Keepalived Documentation

https://www.keepalived.org/documentation/
Admin
The complete Keepalived manual covers installation, configuration, and load balancing and high...
Tokens:142,093
Snippets:2,021
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Directory Layout for Multiple Keepalived Versions

Source: https://www.keepalived.org/documentation/user-guide/installing

Illustrates a directory structure for managing multiple Keepalived versions installed from source, using symlinks to point to the active version.

```bash
[root@lvs1 ~]# cd /usr/local
[root@lvs1 local]# ls -l
total 12
lrwxrwxrwx. 1 root root   16 Feb 24 20:23 keepalived -> keepalived-2.3.4
drwxr-xr-x. 2 root root 4096 Feb 24 20:22 keepalived-2.3.2
drwxr-xr-x. 2 root root 4096 Feb 24 20:22 keepalived-2.3.3
drwxr-xr-x. 2 root root 4096 Feb 24 20:22 keepalived-2.3.4
```

--------------------------------

### Install Prerequisites on Debian/Ubuntu

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs essential build tools and development libraries for compiling Keepalived on Debian/Ubuntu systems.

```bash
apt-get install build-essential pkg-config curl gcc autoconf automake libssl-dev \
    libnl-3-dev libnl-genl-3-dev libsnmp-dev libnl-route-3-dev libnfnetlink-dev \
    iptables-dev* libipset-dev libsnmp-dev libmagic-dev libglib2.0-dev libpcre2-dev \
    libnftnl-dev libmnl-dev libsystemd-dev libkmod-dev
```

--------------------------------

### Download, Build, and Install Keepalived from Source

Source: https://www.keepalived.org/documentation/user-guide/installing

Downloads Keepalived source, extracts it, configures, compiles, and installs the package. Use wget as an alternative to curl.

```bash
curl --location --progress https://www.keepalived.org/software/keepalived-2.3.4.tar.gz | tar xz
cd keepalived-2.3.4
./configure
make
sudo make install
```

--------------------------------

### Enable and Start Keepalived Service with systemd

Source: https://www.keepalived.org/documentation/user-guide/installing

Enables the keepalived service to start on boot and starts it immediately using systemctl.

```bash
# systemctl enable --now keepalived
```

--------------------------------

### Install Prerequisites on Archlinux

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs required libraries for Keepalived on Archlinux.

```bash
pacman -S ipset libnfnetlink libnl1 pcre-2
```

--------------------------------

### Install Prerequisites on Alpine Linux

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs necessary build tools and development libraries for compiling Keepalived on Alpine Linux.

```bash
autoconf automake iptables-dev ipset-dev libnfnetlink-dev libnl3-dev musl-dev 
    libnftnl-dev file-dev pcre2-dev
    openssl-dev or libressl-dev
```

--------------------------------

### Enable and Start Keepalived Service with systemd

Source: https://www.keepalived.org/documentation/user-guide/installing?q=

Enables the keepalived service to start automatically on boot and starts it immediately using systemd.

```bash
systemctl enable --now keepalived
```

--------------------------------

### Enable and Start Keepalived Service

Source: https://www.keepalived.org/documentation/user-guide/quick-start?q=

Enables Keepalived to start on boot and starts the service immediately. This command should be run on both master and backup nodes.

```bash
# systemctl enable --now keepalived

```

--------------------------------

### Install DBUS Support Prerequisites on Debian/Ubuntu

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs the libglib2.0-dev package for DBUS support on Debian/Ubuntu systems.

```bash
dnf install libglib2.0-dev
```

--------------------------------

### Install DBUS Support Prerequisites on RHEL/CentOS/Fedora

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs the glib2-devel package for DBUS support on RHEL-based systems.

```bash
dnf install glib2-devel
```

--------------------------------

### Install Prerequisites on RHEL/CentOS/Fedora

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs necessary build tools and development libraries for compiling Keepalived on RHEL-based systems. Replace dnf with yum on older systems.

```bash
dnf install gcc make autoconf automake openssl-devel libnl3-devel \
    iptables-devel ipset-devel net-snmp-devel libnfnetlink-devel file-devel \
    glib2-devel pcre2-devel libnftnl-devel libmnl-devel systemd-devel kmod-devel
```

--------------------------------

### Keepalived Configuration Summary Example

Source: https://www.keepalived.org/documentation/user-guide/snmp-support

An example of the configuration summary output during the Keepalived build process on a CentOS machine, highlighting SNMP support and related libraries.

```text
./configure --prefix=/usr/local/keepalived-2.3.4 --enable-snmp
Keepalived configuration
------------------------
Keepalived version       : 2.3.4
Compiler                 : gcc
Compiler flags           : -g -O2 -I/usr/include/libnl3
Extra Lib                : -Wl,-z,relro -Wl,-z,now -L/usr/lib64
-lnetsnmpagent -lnetsnmphelpers -lnetsnmpmibs -lnetsnmp -Wl,-E
-Wl,-rpath,/usr/lib64/perl5/CORE -lssl -lcrypto -lcrypt  -lnl-genl-3 -lnl-3
Use IPVS Framework       : Yes
IPVS sync daemon support : Yes
IPVS use libnl           : Yes
fwmark socket support    : Yes
Use VRRP Framework       : Yes
Use VRRP VMAC            : Yes
SNMP support             : Yes
SHA1 support             : No
Use Debug flags          : No


```

--------------------------------

### Configure Startup and Notification Behavior

Source: https://www.keepalived.org/documentation/keepalived-conf

Control real server notifications, email alerts, and file creation permissions.

```text
rs_init_notifies
no_checker_emails
umask [NUMBER|BITS]
```

--------------------------------

### Conditional Configuration Example

Source: https://www.keepalived.org/documentation/keepalived-conf?q=

Use '@' for positive matching against the config-id and '@^' for negative matching to include or exclude configuration lines based on the system role.

```text
    global_defs {
        @main   router_id main_router
        @backup router_id backup_router
    }
    ...
    vrrp_instance VRRP {
        ...
        @main    unicast_src_ip 1.2.3.4
        @backup  unicast_src_ip 1.2.3.5
        @backup2 unicast_src_ip 1.2.3.6
        unicast_peer {
            @^main    1.2.3.4
            @^backup  1.2.3.5
            @^backup2 1.2.3.6
        }
        ...
    }
```

--------------------------------

### Install SNMP Support on Archlinux

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs net-snmp for SNMP support on Archlinux.

```bash
pacman -S net-snmp
```

--------------------------------

### Conditional Configuration with Parameters

Source: https://www.keepalived.org/documentation/keepalived-conf?q=

Shows how parameter substitution interacts with conditional configuration blocks.

```text
    @main $PRIORITY=240
    @backup $PRIORITY=200
    ...
    vrrp_instance VI_0 {
        priority $PRIORITY
    }

    will produce:
        ...
        vrrp_instance VI_0 {
            priority 240
        }
        if the config_id is main.

    $IF_MAIN=@main
    $IF_MAIN priority 240

    will produce:
        priority 240
        if the config_id is main and nothing if the config_id is not main,
        although why anyone would want to use this rather than simply the
        following is not known (but still possible):
            @main priority 240
```

--------------------------------

### Install Keepalived on Debian/Ubuntu

Source: https://www.keepalived.org/documentation/user-guide/installing

Installs the keepalived package and its dependencies using apt-get.

```bash
apt-get install keepalived
```

--------------------------------

### Configure Global Startup and Shutdown Scripts

Source: https://www.keepalived.org/documentation/keepalived-conf?q=

Defines scripts to execute during Keepalived startup and shutdown, with optional timeouts to prevent hanging.

```conf
startup_script SCRIPT_NAME [username [groupname]]
startup_script_timeout SECONDS    # range [1,1000]
shutdown_script SCRIPT_NAME [username [groupname]]
shutdown_script_timeout SECONDS   # range [1,1000]
```

--------------------------------

### Start Keepalived Daemon

Source: https://www.keepalived.org/documentation/user-guide/programs-synopsis

Use this command to start the Keepalived service on systems using systemd.

```bash
# systemctl start keepalived

```

--------------------------------

### Configure VRRP Startup Delays

Source: https://www.keepalived.org/documentation/keepalived-conf

Manage startup timing to ensure network interfaces are ready before VRRP instances begin operation.

```text
vrrp_startup_delay 5.5
vrrp_delay_after_boot 15.23
```
Tokens:
Raw