docker-keepalived/README.md

188 lines
6.8 KiB
Markdown
Raw Normal View History

2015-06-16 09:13:22 +00:00
# osixia/keepalived
2016-02-01 12:42:50 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/osixia/keepalived.svg)][hub]
[![Docker Stars](https://img.shields.io/docker/stars/osixia/keepalived.svg)][hub]
2016-09-18 09:58:20 +00:00
[![](https://images.microbadger.com/badges/image/osixia/keepalived.svg)](http://microbadger.com/images/osixia/keepalived "Get your own image badge on microbadger.com")
2016-02-01 12:42:50 +00:00
[hub]: https://hub.docker.com/r/osixia/keepalived/
2016-11-29 10:31:58 +00:00
Latest release: 1.3.2 - Keepalived 1.3.2 - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/keepalived/) 
2015-07-23 12:39:49 +00:00
2016-09-18 09:58:20 +00:00
**A docker image to run Keepalived.**
2015-06-16 09:13:22 +00:00
> [keepalived.org](http://keepalived.org/)
2016-01-18 21:17:29 +00:00
- [Quick start](#quick-start)
- [Beginner Guide](#beginner-guide)
- [Use your own Backup Manager config](#use-your-own-backup-manager-config)
2016-01-29 11:54:00 +00:00
- [Fix docker mounted file problems](#fix-docker-mounted-file-problems)
2016-01-18 21:17:29 +00:00
- [Debug](#debug)
- [Environment Variables](#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-file)
- [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)
- [Advanced User Guide](#advanced-user-guide)
2016-11-29 10:31:58 +00:00
- [Extend osixia/keepalived:1.3.2 image](#extend-osixiakeepalived132-image)
2016-01-18 21:17:29 +00:00
- [Make your own keepalived image](#make-your-own-keepalived-image)
- [Tests](#tests)
- [Under the hood: osixia/light-baseimage](#under-the-hood-osixialight-baseimage)
- [Changelog](#changelog)
2015-06-16 09:13:22 +00:00
## Quick start
2015-08-24 17:46:29 +00:00
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
2015-06-16 09:13:22 +00:00
2016-11-29 10:31:58 +00:00
docker run --cap-add=NET_ADMIN --net=host -d osixia/keepalived:1.3.2
2015-08-21 09:21:46 +00:00
2016-01-18 20:38:30 +00:00
## Beginner Guide
### Use your own Keepalived config
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 `/container/service/keepalived/assets/keepalived.conf` :
2016-11-29 10:31:58 +00:00
docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:1.3.2
2016-01-18 20:38:30 +00:00
- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide](#advanced-user-guide)
2016-01-29 11:54:00 +00:00
### Fix docker mounted file problems
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](https://docs.docker.com/v1.4/userguide/dockervolumes/#mount-a-host-file-as-a-data-volume).
To fix that run the container with `--copy-service` argument :
2016-11-29 10:31:58 +00:00
docker run [your options] osixia/keepalived:1.3.2 --copy-service
2016-01-29 11:54:00 +00:00
2016-01-18 20:38:30 +00:00
### Debug
The container default log level is **info**.
Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.
Example command to run the container in `debug` mode:
2016-11-29 10:31:58 +00:00
docker run --detach osixia/keepalived:1.3.2 --loglevel debug
2016-01-18 20:38:30 +00:00
See all command line options:
2016-11-29 10:31:58 +00:00
docker run osixia/keepalived:1.3.2 --help
2016-01-18 20:38:30 +00:00
2015-08-21 09:21:46 +00:00
## Environment Variables
2016-01-17 11:36:32 +00:00
Environment variables defaults are set in **image/environment/default.yaml**
See how to [set your own environment variables](#set-your-own-environment-variables)
2015-08-21 09:21:46 +00:00
- **KEEPALIVED_INTERFACE**: Keepalived network interface. Defaults to `eth0`
- **KEEPALIVED_PASSWORD**: Keepalived password. Defaults to `d0cker`
- **KEEPALIVED_PRIORITY** Keepalived node priority. Defaults to `150`
- **KEEPALIVED_UNICAST_PEERS** Keepalived unicast peers. Defaults to :
- 192.168.1.10
- 192.168.1.11
2016-01-17 11:36:32 +00:00
If you want to set this variable at docker run command add the tag `#PYTHON2BASH:` and convert the yaml in python:
2015-08-21 09:21:46 +00:00
2016-11-29 10:31:58 +00:00
docker run --env KEEPALIVED_UNICAST_PEERS="#PYTHON2BASH:['192.168.1.10', '192.168.1.11']" --detach osixia/keepalived:1.3.2
2015-08-21 09:21:46 +00:00
To convert yaml to python online : http://yaml-online-parser.appspot.com/
2015-12-28 19:50:35 +00:00
- **KEEPALIVED_VIRTUAL_IPS** Keepalived virtual IPs. Defaults to :
2015-08-21 09:21:46 +00:00
- 192.168.1.231
- 192.168.1.232
2016-01-17 11:36:32 +00:00
If you want to set this variable at docker run command convert the yaml in python, see above.
2015-08-21 09:21:46 +00:00
- **KEEPALIVED_NOTIFY** Script to execute when node state change. Defaults to `/container/service/keepalived/assets/notify.sh`
2016-01-20 08:48:53 +00:00
- **KEEPALIVED_COMMAND_LINE_ARGUMENTS** Keepalived command line arguments; Defaults to `--log-detail --dump-conf`
2016-01-17 11:36:32 +00:00
### 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!" \
2016-11-29 10:31:58 +00:00
--env KEEPALIVED_PRIORITY="100" --detach osixia/keepalived:1.3.2
2016-01-17 11:36:32 +00:00
#### Link environment file
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 \
2016-11-29 10:31:58 +00:00
--detach osixia/keepalived:1.3.2
2016-01-17 11:36:32 +00:00
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).
#### Make your own image or extend this image
This is the best solution if you have a private registry. Please refer to the [Advanced User Guide](#advanced-user-guide) just below.
## Advanced User Guide
2016-11-29 10:31:58 +00:00
### Extend osixia/keepalived:1.3.2 image
2016-01-17 11:36:32 +00:00
If you need to add your custom TLS certificate, bootstrap config or environment files the easiest way is to extends this image.
Dockerfile example:
2016-11-29 10:31:58 +00:00
FROM osixia/osixia/keepalived:1.3.2
2016-01-17 11:36:32 +00:00
MAINTAINER Your Name <your@name.com>
2016-01-18 20:38:30 +00:00
ADD keepalived.conf /container/service/keepalived/assets/keepalived.conf
2016-01-17 11:36:32 +00:00
ADD environment /container/environment/01-custom
ADD scripts.sh /container/service/keepalived/assets/notify.sh
### Make your own keepalived image
2015-08-21 09:21:46 +00:00
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
2016-11-29 10:31:58 +00:00
VERSION = 1.3.2
2015-08-21 09:21:46 +00:00
becomes :
NAME = billy-the-king/keepalived
VERSION = 0.1.0
2016-01-18 20:38:30 +00:00
Add your custom scripts, environment files, config ...
2015-08-21 09:21:46 +00:00
Build your image :
make build
Run your image :
docker run -d billy-the-king/keepalived:0.1.0
2016-01-17 11:36:32 +00:00
### Tests
2015-08-21 09:21:46 +00:00
We use **Bats** (Bash Automated Testing System) to test this image:
> [https://github.com/sstephenson/bats](https://github.com/sstephenson/bats)
Install Bats, and in this project directory run :
make test
2016-01-17 11:36:32 +00:00
### Under the hood: osixia/light-baseimage
This image is based on osixia/light-baseimage.
More info: https://github.com/osixia/docker-light-baseimage
## Changelog
Please refer to: [CHANGELOG.md](CHANGELOG.md)