@@ -7,7 +7,7 @@
[hub]: https://hub.docker.com/r/osixia/keepalived/
Latest release: 0.2.1 - Keepalived 1.2.19 - [Changelog ](CHANGELOG.md ) | [Docker Hub ](https://hub.docker.com/r/osixia/keepalived/ )
Latest release: 0.2.2 - Keepalived 1.2.23 - [Changelog ](CHANGELOG.md ) | [Docker Hub ](https://hub.docker.com/r/osixia/keepalived/ )
A docker image to run Keepalived.
> [keepalived.org](http://keepalived.org/)
@@ -23,7 +23,7 @@ A docker image to run Keepalived.
- [Link environment file ](#link-environment-file )
- [Make your own image or extend this image ](#make-your-own-image-or-extend-this-image )
- [Advanced User Guide ](#advanced-user-guide )
- [Extend osixia/keepalived:0.2.1 image ](#extend-osixiakeepalived021 -image )
- [Extend osixia/keepalived:0.2.2 image ](#extend-osixiakeepalived022 -image )
- [Make your own keepalived image ](#make-your-own-keepalived-image )
- [Tests ](#tests )
- [Under the hood: osixia/light-baseimage ](#under-the-hood-osixialight-baseimage )
@@ -33,7 +33,7 @@ A docker image to run Keepalived.
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:0.2.1
docker run --cap-add=NET_ADMIN --net=host -d osixia/keepalived:0.2.2
## Beginner Guide
@@ -43,7 +43,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:0.2.1
docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:0.2.2
- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide ](#advanced-user-guide )
@@ -53,7 +53,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:0.2.1 --copy-service
docker run [your options] osixia/keepalived:0.2.2 --copy-service
### Debug
@@ -62,11 +62,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:0.2.1 --loglevel debug
docker run --detach osixia/keepalived:0.2.2 --loglevel debug
See all command line options:
docker run osixia/keepalived:0.2.1 --help
docker run osixia/keepalived:0.2.2 --help
## Environment Variables
@@ -86,7 +86,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:0.2.1
docker run --env KEEPALIVED_UNICAST_PEERS="#PYTHON2BASH: ['192.168.1.10', '192.168.1.11']" --detach osixia/keepalived:0.2.2
To convert yaml to python online : http://yaml-online-parser.appspot.com/
@@ -102,25 +102,13 @@ See how to [set your own environment variables](#set-your-own-environment-variab
- **KEEPALIVED_COMMAND_LINE_ARGUMENTS** Keepalived command line arguments; Defaults to `--log-detail --dump-conf`
### Set environment variables at run time :
Environment variable can be set directly by adding the -e argument in the command line, for example :
docker run --env KEEPALIVED_INTERFACE="eno1" --env KEEPALIVED_PASSWORD="password!" \
--env KEEPALIVED_PRIORITY="100" --detach osixia/keepalived
Or by setting your own `env.yaml` file as a docker volume to `/container/environment/env.yaml`
docker run --volume /data/my-env.yaml:/container/environment/env.yaml \
--detach osixia/keepalived
### Set your own environment variables
#### Use command line argument
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:0.2.1
--env KEEPALIVED_PRIORITY="100" --detach osixia/keepalived:0.2.2
#### Link environment file
@@ -128,7 +116,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:0.2.1
--detach osixia/keepalived:0.2.2
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).
@@ -138,13 +126,13 @@ This is the best solution if you have a private registry. Please refer to the [A
## Advanced User Guide
### Extend osixia/keepalived:0.2.1 image
### Extend osixia/keepalived:0.2.2 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/osixia/keepalived:0.2.1
FROM osixia/osixia/keepalived:0.2.2
MAINTAINER Your Name <your@name .com>
ADD keepalived.conf /container/service/keepalived/assets/keepalived.conf
@@ -163,7 +151,7 @@ Clone this project :
Adapt Makefile, set your image NAME and VERSION, for example :
NAME = osixia/keepalived
VERSION = 0.2.1
VERSION = 0.2.2
becomes :
NAME = billy-the-king/keepalived
Bertrand Gouny
osixia