@@ -6,35 +6,35 @@
[hub]: https://hub.docker.com/r/osixia/keepalived/
Latest release: 2.0.12 - Keepalived 2.0.12 - [Changelog ](CHANGELOG.md ) | [Docker Hub ](https://hub.docker.com/r/osixia/keepalived/ )
Latest release: 2.0.17 - Keepalived 2.0.17 - [Changelog ](CHANGELOG.md ) | [Docker Hub ](https://hub.docker.com/r/osixia/keepalived/ )
**A docker image to run Keepalived. **
> [keepalived.org](http://keepalived.org/)
- [osixia/keepalived ](#osixiakeepalived )
- [Quick start ](#q uick-start )
- [Beginner Guide ](#b eginner-g uide )
- [Use your own Keepalived config ](#u se-your-own-k eepalived-config )
- [Fix docker mounted file problems ](#f ix-docker-mounted-file-problems )
- [Debug ](#d ebug )
- [Environment Variables ](#e nvironment-v ariables )
- [Set your own environment variables ](#s et-your-own-environment-variables )
- [Use command line argument ](#u se-command-line-argument )
- [Link environment file ](#l ink-environment-file )
- [Make your own image or extend this image ](#m ake-your-own-image-or-extend-this-image )
- [Advanced User Guide ](#a dvanced-u ser-g uide )
- [Extend osixia/keepalived:2.0.12 image ](#e xtend-osixiakeepalived2012 -image )
- [Make your own keepalived image ](#m ake-your-own-keepalived-image )
- [Tests ](#t ests )
- [Under the hood: osixia/light-baseimage ](#u nder-the-hood-osixialight-baseimage )
- [Security ](#s ecurity )
- [Changelog ](#c hangelog )
- [Quick start ](#Q uick-start )
- [Beginner Guide ](#B eginner-G uide )
- [Use your own Keepalived config ](#U se-your-own-K eepalived-config )
- [Fix docker mounted file problems ](#F ix-docker-mounted-file-problems )
- [Debug ](#D ebug )
- [Environment Variables ](#E nvironment-V ariables )
- [Set your own environment variables ](#S et-your-own-environment-variables )
- [Use command line argument ](#U se-command-line-argument )
- [Link environment file ](#L ink-environment-file )
- [Make your own image or extend this image ](#M ake-your-own-image-or-extend-this-image )
- [Advanced User Guide ](#A dvanced-U ser-G uide )
- [Extend osixia/keepalived:2.0.17 image ](#E xtend-osixiakeepalived2017 -image )
- [Make your own keepalived image ](#M ake-your-own-keepalived-image )
- [Tests ](#T ests )
- [Under the hood: osixia/light-baseimage ](#U nder-the-hood-osixialight-baseimage )
- [Security ](#S ecurity )
- [Changelog ](#C hangelog )
## Quick start
This image require the kernel module ip_vs loaded on the host (`modprobe ip_vs` ) and need to be run with : --cap-add=NET_ADMIN --net=host
docker run --cap-add=NET_ADMIN --net=host -d osixia/keepalived:2.0.12
docker run --cap-add=NET_ADMIN --cap-add=NET_BROADCAST --cap-add=NET_RAW --net=host -d osixia/keepalived:2.0.17
## Beginner Guide
@@ -44,7 +44,7 @@ but setting your own keepalived.conf is possible. 2 options:
- Link your config file at run time to `/container/service/keepalived/assets/keepalived.conf` :
docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:2.0.12
docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:2.0.17
- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide ](#advanced-user-guide )
@@ -54,7 +54,7 @@ You may have some problems with mounted files on some systems. The startup scrip
To fix that run the container with `--copy-service` argument :
docker run [your options] osixia/keepalived:2.0.12 --copy-service
docker run [your options] osixia/keepalived:2.0.17 --copy-service
### Debug
@@ -63,11 +63,11 @@ Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.
Example command to run the container in `debug` mode:
docker run --detach osixia/keepalived:2.0.12 --loglevel debug
docker run --detach osixia/keepalived:2.0.17 --loglevel debug
See all command line options:
docker run osixia/keepalived:2.0.12 --help
docker run osixia/keepalived:2.0.17 --help
## Environment Variables
@@ -88,7 +88,7 @@ See how to [set your own environment variables](#set-your-own-environment-variab
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.12
docker run --env KEEPALIVED_UNICAST_PEERS="#PYTHON2BASH: ['192.168.1.10', '192.168.1.11']" --detach osixia/keepalived:2.0.17
To convert yaml to python online : http://yaml-online-parser.appspot.com/
@@ -112,7 +112,7 @@ See how to [set your own environment variables](#set-your-own-environment-variab
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.12
--env KEEPALIVED_PRIORITY="100" --detach osixia/keepalived:2.0.17
#### Link environment file
@@ -120,7 +120,7 @@ Environment variables can be set by adding the --env argument in the command lin
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.12
--detach osixia/keepalived:2.0.17
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/environment` because this directory contains predefined baseimage environment files to fix container environment (INITRD, LANG, LANGUAGE and LC_CTYPE).
@@ -130,13 +130,13 @@ This is the best solution if you have a private registry. Please refer to the [A
## Advanced User Guide
### Extend osixia/keepalived:2.0.12 image
### Extend osixia/keepalived:2.0.17 image
If you need to add your custom TLS certificate, bootstrap config or environment files the easiest way is to extends this image.
Dockerfile example:
FROM osixia/keepalived:2.0.12
FROM osixia/keepalived:2.0.17
MAINTAINER Your Name <your@name .com>
ADD keepalived.conf /container/service/keepalived/assets/keepalived.conf