@@ -6,34 +6,35 @@
[hub]: https://hub.docker.com/r/osixia/keepalived/
Latest release: 1.4.5 - Keepalived 1.4.5 - [Changelog ](CHANGELOG.md ) | [Docker Hub ](https://hub.docker.com/r/osixia/keepalived/ )
Latest release: 2.0.10 - Keepalived 2.0.10 - [Changelog ](CHANGELOG.md ) | [Docker Hub ](https://hub.docker.com/r/osixia/keepalived/ )
**A docker image to run Keepalived. **
> [keepalived.org](http://keepalived.org/)
- [Quick start ]( #quick-start )
- [Beginner Guide ]( #beginner-guide )
- [Use your own Backup Manager config ]( #use-your-own-backup-manager-config )
- [Fix docker mounted file problems ]( #fix-docker-mounted-file-problems )
- [Debug ](#debug )
- [Environment Variables ]( #environment-variables )
- [Set your own e nvironment v ariables ](#set-your-own- environment-variables )
- [Use command line argument ](#u se-command-line-argument )
- [Link environment file ]( #link-environment-file )
- [Make your own image or extend this image ]( #make-your-own-image-or-extend-this-imag e )
- [Advanced User Guide ]( #advanced-user-guid e )
- [Extend osixia/keepalived:1.4.5 image ]( #extend-osixiakeepalived145-imag e )
- [Make your own keepalived image ](#make-your-own- keepalived-image )
- [Tests ](#tests )
- [Under the hood: osixia/light-baseimage ]( #under-the-hood-osixialight-baseimage )
- [Security ](#security )
- [Changelog ](#changelog )
- [osixia/keepalived ]( #osixiakeepalived )
- [Quick start ]( #quick-start )
- [Beginner Guide ]( #beginner-guide )
- [Use your own Keepalived config ]( #use-your-own-keepalived-config )
- [Fix docker mounted file problems ]( #fix-docker-mounted-file-problems )
- [Debug ](#debug )
- [E nvironment V ariables ](#environment-variables )
- [Set your own environment variables ](#set-your-own-environment-variables )
- [Use command line argument ]( #use-command-line-argument )
- [Link environment file ]( #link-environment-fil e )
- [Make your own image or extend this image ]( #make-your-own-image-or-extend-this-imag e )
- [Advanced User Guide ]( #advanced-user-guid e )
- [Extend osixia/ keepalived:2.0.10 image ](#extend-osixia keepalived2010 -image )
- [Make your own keepalived image ]( #make-your-own-keepalived-image )
- [Tests ](#tests )
- [Under the hood: osixia/light-baseimage ]( #under-the-hood-osixialight-baseimage )
- [Security ](#security )
- [Changelog ](#changelog )
## 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:1.4.5
docker run --cap-add=NET_ADMIN --net=host -d osixia/keepalived:2.0.10
## Beginner Guide
@@ -43,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:1.4.5
docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:2.0.10
- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide ](#advanced-user-guide )
@@ -53,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:1.4.5 --copy-service
docker run [your options] osixia/keepalived:2.0.10 --copy-service
### Debug
@@ -62,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:1.4.5 --loglevel debug
docker run --detach osixia/keepalived:2.0.10 --loglevel debug
See all command line options:
docker run osixia/keepalived:1.4.5 --help
docker run osixia/keepalived:2.0.10 --help
## Environment Variables
@@ -87,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:1.4.5
docker run --env KEEPALIVED_UNICAST_PEERS="#PYTHON2BASH: ['192.168.1.10', '192.168.1.11']" --detach osixia/keepalived:2.0.10
To convert yaml to python online : http://yaml-online-parser.appspot.com/
@@ -109,7 +110,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:1.4.5
--env KEEPALIVED_PRIORITY="100" --detach osixia/keepalived:2.0.10
#### Link environment file
@@ -117,7 +118,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:1.4.5
--detach osixia/keepalived:2.0.10
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).
@@ -127,13 +128,13 @@ This is the best solution if you have a private registry. Please refer to the [A
## Advanced User Guide
### Extend osixia/keepalived:1.4.5 image
### Extend osixia/keepalived:2.0.10 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:1.4.5
FROM osixia/keepalived:2.0.10
MAINTAINER Your Name <your@name .com>
ADD keepalived.conf /container/service/keepalived/assets/keepalived.conf