A docker image to run Keepalived 🐳
A docker image to run Keepalived.
This image require the kernel module ipvs loaded on the host (`modprobe ipvs`) and need to be run with : --cap-add=NET_ADMIN --net=host
docker run --cap-add=NET_ADMIN --cap-add=NET_BROADCAST --cap-add=NET_RAW --net=host -d osixia/keepalived:2.0.20
This image comes with a keepalived config file that can be easily customized via environment variables for a quick bootstrap, but setting your own keepalived.conf is possible. 2 options:
Link your config file at run time to
docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:2.0.20
Add your config file by extending or cloning this image, please refer to the Advanced User Guide
You may have some problems with mounted files on some systems. The startup script try to make some file adjustment and fix files owner and permissions, this can result in multiple errors. See Docker documentation.
To fix that run the container with
docker run [your options] osixia/keepalived:2.0.20 --copy-service
The container default log level is info. Available levels are:
Example command to run the container in
docker run --detach osixia/keepalived:2.0.20 --loglevel debug
See all command line options:
docker run osixia/keepalived:2.0.20 --help
Environment variables defaults are set in image/environment/default.yaml
See how to set your own environment variables
KEEPALIVEDROUTERID Keepalived virtual router ID. Defaults to
KEEPALIVEDUNICASTPEERS Keepalived unicast peers. Defaults to :
If you want to set this variable at docker run command add the tag
#PYTHON2BASH:and convert the yaml in python:
docker run --env KEEPALIVED_UNICAST_PEERS="#PYTHON2BASH:['192.168.1.10', '192.168.1.11']" --detach osixia/keepalived:2.0.20
To convert yaml to python online : http://yaml-online-parser.appspot.com/
KEEPALIVEDVIRTUALIPS Keepalived virtual IPs. Defaults to :
If you want to set this variable at docker run command convert the yaml in python, see above.
KEEPALIVED_NOTIFY Script to execute when node state change. Defaults to
KEEPALIVEDCOMMANDLINE_ARGUMENTS Keepalived command line arguments; Defaults to
KEEPALIVED_STATE The starting state of keepalived; it can either be MASTER or BACKUP.
Environment variables can be set by adding the --env argument in the command line, for example:
docker run --env KEEPALIVED_INTERFACE="eno1" --env KEEPALIVED_PASSWORD="password!" \ --env KEEPALIVED_PRIORITY="100" --detach osixia/keepalived:2.0.20
For example if your environment file is in : /data/environment/my-env.yaml
docker run --volume /data/environment/my-env.yaml:/container/environment/01-custom/env.yaml \ --detach osixia/keepalived:2.0.20
Take care to link your environment file to
/container/environment/XX-somedir(with XX < 99 so they will be processed before default environment files) and not directly to
/container/environmentbecause this directory contains predefined baseimage environment files to fix container environment (INITRD, LANG, LANGUAGE and LC_CTYPE).
This is the best solution if you have a private registry. Please refer to the Advanced User Guide just below.
If you need to add your custom TLS certificate, bootstrap config or environment files the easiest way is to extends this image.
FROM osixia/keepalived:2.0.20 MAINTAINER Your Name
ADD keepalived.conf /container/service/keepalived/assets/keepalived.conf ADD environment /container/environment/01-custom ADD scripts.sh /container/service/keepalived/assets/notify.sh
Clone this project :
git clone https://github.com/osixia/docker-keepalived cd docker-keepalived
Adapt Makefile, set your image NAME and VERSION, for example :
NAME = osixia/keepalived VERSION = 1.3.5
becomes : NAME = billy-the-king/keepalived VERSION = 0.1.0
Add your custom scripts, environment files, config ...
Build your image :
Run your image :
docker run -d billy-the-king/keepalived:0.1.0
We use Bats (Bash Automated Testing System) to test this image:
Install Bats, and in this project directory run :
This image is based on osixia/light-baseimage. More info: https://github.com/osixia/docker-light-baseimage
If you discover a security vulnerability within this docker image, please send an email to the Osixia! team at [email protected] For minor vulnerabilities feel free to add an issue here on github.
Please include as many details as possible.
Please refer to: CHANGELOG.md