diff --git a/CHANGELOG.md b/CHANGELOG.md index 633a7ea..89dad79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 0.1.6 + - Better way to add custom config + - Improve documentation + ## 0.1.5 - Upgrade baseimage: osixia/light-baseimage:0.1.1 diff --git a/Makefile b/Makefile index 2b83fc9..4a29c50 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ NAME = osixia/keepalived -VERSION = 0.1.5 +VERSION = 0.1.6 .PHONY: all build test tag_latest release diff --git a/README.md b/README.md index 0c64573..ee685cf 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,77 @@ A docker image to run Keepalived. This image require the kernel module ip_vs loaded on the host and need to be run with : --privileged --net=host docker run --privileged --net=host -d osixia/keepalived + +## Environment Variables + +Environement variables defaults are set in **image/env.yaml**. You can modify environment variable values directly in this file and rebuild the image ([see manual build](#manual-build)). You can also override those values at run time with -e argument or by setting your own env.yaml file as a docker volume to `/etc/env.yaml`. See examples below. + +- **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 + + If you want to set this variable at docker run command convert the yaml in python : + + docker run -e KEEPALIVED_UNICAST_PEERS="[192.168.1.10', '192.168.1.11']" -d osixia/phpldapadmin + + To convert yaml to python online : http://yaml-online-parser.appspot.com/ + + +- **KEEPALIVED_VIRTUAL_IPS** Add a read only user. Defaults to : + + - 192.168.1.231 + - 192.168.1.232 + + 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 `/container/service/keepalived/assets/notify.sh` + +### 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 -e KEEPALIVED_INTERFACE="eno1" -e KEEPALIVED_PASSWORD="password!" \ + -e KEEPALIVED_PRIORITY="100" -d osixia/keepalived + +Or by setting your own `env.yaml` file as a docker volume to `/etc/env.yaml` + + docker run -v /data/my-env.yaml:/etc/env.yaml \ + -d osixia/keepalived + +## Manual build + +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 = 0.1.6 + + becomes : + NAME = billy-the-king/keepalived + VERSION = 0.1.0 + +Build your image : + + make build + +Run your image : + + docker run -d billy-the-king/keepalived:0.1.0 + +## Tests + +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 diff --git a/image/service/keepalived/assets/README.md b/image/service/keepalived/assets/README.md index a4695d4..bcc08b9 100644 --- a/image/service/keepalived/assets/README.md +++ b/image/service/keepalived/assets/README.md @@ -1 +1 @@ -Add your custom keepalived.conf file here or mount one at docker run to /etc/keepalived/keepalived.conf +Add your custom keepalived.conf file here or mount one at docker run to /container/service/keepalived/assets/keepalived.conf diff --git a/image/service/keepalived/container-start.sh b/image/service/keepalived/container-start.sh index c843cc9..d6e60e6 100755 --- a/image/service/keepalived/container-start.sh +++ b/image/service/keepalived/container-start.sh @@ -5,62 +5,51 @@ FIRST_START_DONE="/etc/docker-keepalived-first-start-done" # container first start if [ ! -e "$FIRST_START_DONE" ]; then - # config folder is empty use bootstrap config if available - if [ ! -e /etc/keepalived/keepalived.conf ]; then - echo "No keepalived.conf provided using image default one" - if [ ! -e /container/service/keepalived/assets/keepalived.conf ]; then - echo "Error: No default keepalived.conf found in /container/service/keepalived/assets/keepalived.conf" - exit 1 - else + ln -s /container/service/keepalived/assets/keepalived.conf /etc/keepalived/keepalived.conf - ln -s /container/service/keepalived/assets/keepalived.conf /etc/keepalived/keepalived.conf - - # - # bootstrap config - # - sed -i "s|{{ keepalived_interface }}|$KEEPALIVED_INTERFACE|g" /etc/keepalived/keepalived.conf - sed -i "s|{{ keepalived_priority }}|$KEEPALIVED_PRIORITY|g" /etc/keepalived/keepalived.conf - sed -i "s|{{ keepalived_password }}|$KEEPALIVED_PASSWORD|g" /etc/keepalived/keepalived.conf - - if [ -n "$KEEPALIVED_NOTIFY" ]; then - sed -i "s|{{ keepalived_notify }}|notify \"$KEEPALIVED_NOTIFY\"|g" /etc/keepalived/keepalived.conf - else - sed -i "/{{ keepalived_notify }}/d" /etc/keepalived/keepalived.conf - fi - - # unicast peers - KEEPALIVED_UNICAST_PEERS=($KEEPALIVED_UNICAST_PEERS) - for peer in "${KEEPALIVED_UNICAST_PEERS[@]}" - do - # it's just a peer - # stored in a variable - if [ -n "${!peer}" ]; then - sed -i "s|{{ keepalived_unicast_peers }}|${!peer}\n {{ keepalived_unicast_peers }}|g" /etc/keepalived/keepalived.conf - # directly - else - sed -i "s|{{ keepalived_unicast_peers }}|${peer}\n {{ keepalived_unicast_peers }}|g" /etc/keepalived/keepalived.conf - fi - done - sed -i "/{{ keepalived_unicast_peers }}/d" /etc/keepalived/keepalived.conf - - # virtual ips - KEEPALIVED_VIRTUAL_IPS=($KEEPALIVED_VIRTUAL_IPS) - for vip in "${KEEPALIVED_VIRTUAL_IPS[@]}" - do - # it's just a peer - # stored in a variable - if [ -n "${!vip}" ]; then - sed -i "s|{{ keepalived_virtual_ips }}|${!vip}\n {{ keepalived_virtual_ips }}|g" /etc/keepalived/keepalived.conf - # directly - else - sed -i "s|{{ keepalived_virtual_ips }}|${vip}\n {{ keepalived_virtual_ips }}|g" /etc/keepalived/keepalived.conf - fi - done - sed -i "/{{ keepalived_virtual_ips }}/d" /etc/keepalived/keepalived.conf - fi + # + # bootstrap config + # + sed -i "s|{{ keepalived_interface }}|$KEEPALIVED_INTERFACE|g" /etc/keepalived/keepalived.conf + sed -i "s|{{ keepalived_priority }}|$KEEPALIVED_PRIORITY|g" /etc/keepalived/keepalived.conf + sed -i "s|{{ keepalived_password }}|$KEEPALIVED_PASSWORD|g" /etc/keepalived/keepalived.conf + if [ -n "$KEEPALIVED_NOTIFY" ]; then + sed -i "s|{{ keepalived_notify }}|notify \"$KEEPALIVED_NOTIFY\"|g" /etc/keepalived/keepalived.conf + else + sed -i "/{{ keepalived_notify }}/d" /etc/keepalived/keepalived.conf fi + # unicast peers + KEEPALIVED_UNICAST_PEERS=($KEEPALIVED_UNICAST_PEERS) + for peer in "${KEEPALIVED_UNICAST_PEERS[@]}" + do + # it's just a peer + # stored in a variable + if [ -n "${!peer}" ]; then + sed -i "s|{{ keepalived_unicast_peers }}|${!peer}\n {{ keepalived_unicast_peers }}|g" /etc/keepalived/keepalived.conf + # directly + else + sed -i "s|{{ keepalived_unicast_peers }}|${peer}\n {{ keepalived_unicast_peers }}|g" /etc/keepalived/keepalived.conf + fi + done + sed -i "/{{ keepalived_unicast_peers }}/d" /etc/keepalived/keepalived.conf + + # virtual ips + KEEPALIVED_VIRTUAL_IPS=($KEEPALIVED_VIRTUAL_IPS) + for vip in "${KEEPALIVED_VIRTUAL_IPS[@]}" + do + # it's just a peer + # stored in a variable + if [ -n "${!vip}" ]; then + sed -i "s|{{ keepalived_virtual_ips }}|${!vip}\n {{ keepalived_virtual_ips }}|g" /etc/keepalived/keepalived.conf + # directly + else + sed -i "s|{{ keepalived_virtual_ips }}|${vip}\n {{ keepalived_virtual_ips }}|g" /etc/keepalived/keepalived.conf + fi + done + sed -i "/{{ keepalived_virtual_ips }}/d" /etc/keepalived/keepalived.conf + touch $FIRST_START_DONE fi