Merge branch 'hotfix-0.1.6' into stable

CHANGELOG.md

@@ -1,4 +1,25 @@
 # Changelog
 
+## 0.1.6
+  - Better way to add custom config
+  - Improve documentation
+
+## 0.1.5
+  - Upgrade baseimage: osixia/light-baseimage:0.1.1
+
+## 0.1.4
+  - Use light-baseimage
+
+## 0.1.3
+  - Fix libnl dependency
+
+## 0.1.2
+  - Keepalived version 1.2.19
+  - Update default config :
+    - Set start state to BACKUP
+
+## 0.1.1
+  - Add notify script
+
 ## 0.1.0
   - Initial release

Makefile

@@ -1,5 +1,5 @@
 NAME = osixia/keepalived
-VERSION = 0.1.0
+VERSION = 0.1.6
 
 .PHONY: all build test tag_latest release
 

README.md

@@ -1,10 +1,86 @@
 # osixia/keepalived
 
+[![](https://badge.imagelayers.io/osixia/keepalived:latest.svg)](https://imagelayers.io/?images=osixia/keepalived:latest 'Get your own badge on imagelayers.io')
+
 A docker image to run Keepalived.
 > [keepalived.org](http://keepalived.org/)
 
 ## Quick start
 
-This image need to be run with : --privileged --net=host
+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

image/Dockerfile

@@ -1,35 +1,42 @@
-FROM osixia/baseimage:0.10.4
+FROM osixia/light-baseimage:0.1.1
 MAINTAINER Bertrand Gouny <bertrand.gouny@osixia.net>
 
 # Keepalived version
-ENV KEEPALIVED_VERSION 1.2.17
+ENV KEEPALIVED_VERSION 1.2.19
 
-# Use baseimage-docker's init system.
-CMD ["/sbin/my_init"]
+# Use baseimage's init system.
+# https://github.com/osixia/docker-light-baseimage/blob/stable/image/tool/run
+CMD ["/container/tool/run"]
 
 # Install Keepalived
 RUN apt-get -y update \
     && LC_ALL=C DEBIAN_FRONTEND=noninteractive apt-get install -y \
-    make gcc libssl-dev \
+      curl \
+      make \
+      gcc \
+      pkg-config \
+      libssl-dev \
+      libnl-3-dev \
+      libnl-genl-3-dev \
     && curl -o keepalived.tar.gz -SL http://keepalived.org/software/keepalived-${KEEPALIVED_VERSION}.tar.gz \
-    && mkdir -p /osixia/keepalived-sources \
-    && tar -xzf keepalived.tar.gz --strip 1 -C /osixia/keepalived-sources \
-    && cd osixia/keepalived-sources \
+    && mkdir -p /container/keepalived-sources \
+    && tar -xzf keepalived.tar.gz --strip 1 -C /container/keepalived-sources \
+    && cd container/keepalived-sources \
     && ./configure --with-kernel-dir=/lib/modules/$(uname -r)/build \
     && make && make install \
     && cd - && mkdir -p /etc/keepalived \
-    && apt-get remove -y --purge --auto-remove make gcc libssl-dev
+    && apt-get remove -y --purge --auto-remove curl make gcc pkg-config libssl-dev
 
-# Add Keepalived assets
-ADD service/keepalived/assets /osixia/keepalived
+# Add service directory to /container/service
+ADD service /container/service
 
-# Clean all
-RUN rm keepalived.tar.gz \
-  && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+# Use baseimage install-service script and clean all
+# https://github.com/osixia/docker-light-baseimage/blob/stable/image/tool/install-service
+RUN /container/tool/install-service \
+    && rm -f keepalived.tar.gz \
+    && rm -rf /container/keepalived-sources \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 # Add default env variables
-ADD env.yml /etc/env.yml
-
-# Add Keepalived container start config & daemon
-ADD service/keepalived/container-start.sh /etc/my_init.d/keepalived
-ADD service/keepalived/daemon.sh /etc/service/keepalived/run
+ADD env.yaml /etc/env.yaml

image/env.yaml

@@ -1,12 +1,16 @@
-KEEPALIVED_INTERFACE: p4p1
+KEEPALIVED_INTERFACE: eth0
 KEEPALIVED_PASSWORD: d0cker
 
-# for electing MASTER, highest priority wins.
+# For electing MASTER, highest priority wins.
 # to be MASTER, make 50 more than other machines
 KEEPALIVED_PRIORITY: 150
 
 KEEPALIVED_UNICAST_PEERS:
   - 192.168.1.10
+  - 192.168.1.11
 
 KEEPALIVED_VIRTUAL_IPS:
   - 192.168.1.231
+  - 192.168.1.232
+
+KEEPALIVED_NOTIFY: /container/service/keepalived/assets/notify.sh

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

image/service/keepalived/assets/keepalived.conf

@@ -1,11 +1,19 @@
-vrrp_instance vip-1 {
+vrrp_sync_group VG_1 {
+  group {
+    VI_1
+  }
+
+  {{ keepalived_notify }}
+}
+
+vrrp_instance VI_1 {
   interface {{ keepalived_interface }}
 
   track_interface {
     {{ keepalived_interface }}
   }
 
-  state MASTER
+  state BACKUP
   virtual_router_id 51
   priority {{ keepalived_priority }}
   nopreempt

image/service/keepalived/assets/notify.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# for ANY state transition.
+# "notify" script is called AFTER the
+# notify_* script(s) and is executed
+# with 3 arguments provided by keepalived
+# (ie don't include parameters in the notify line).
+# arguments
+# $1 = "GROUP"|"INSTANCE"
+# $2 = name of group or instance
+# $3 = target state of transition
+#     ("MASTER"|"BACKUP"|"FAULT")
+
+TYPE=$1
+NAME=$2
+STATE=$3
+
+case $STATE in
+        "MASTER") logger -s -t keepalived-notify "I'm the MASTER! Whup whup."
+                  exit 0
+                  ;;
+        "BACKUP") logger -s -t keepalived-notify "Ok, i'm just a backup, great."
+                  exit 0
+                  ;;
+        "FAULT")  logger -s -t keepalived-notify "Fault, what ?"
+                  exit 0
+                  ;;
+        *)        logger -s -t keepalived-notify "Unknown state"
+                  exit 1
+                  ;;
+esac

image/service/keepalived/container-start.sh

@@ -5,56 +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 /osixia/keepalived/keepalived.conf ]; then
-      echo "Error: No default keepalived.conf found in /osixia/keepalived/keepalived.conf"
-      exit 1
-    else
+  ln -s /container/service/keepalived/assets/keepalived.conf /etc/keepalived/keepalived.conf
 
-      ln -s /osixia/keepalived/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
-
-      # 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
 

test/test_helper.bash

@@ -2,7 +2,7 @@ setup() {
   IMAGE_NAME="$NAME:$VERSION"
 }
 
-# function relative to the current container / image  
+# function relative to the current container / image
 build_image() {
   #disable outputs
   docker build -t $IMAGE_NAME $BATS_TEST_DIRNAME/../image &> /dev/null
@@ -34,12 +34,16 @@ is_service_running() {
   is_service_running_by_cid $CONTAINER_ID $1
 }
 
+is_file_exists() {
+  is_file_exists_by_cid $CONTAINER_ID $1
+}
+
 wait_service() {
   wait_service_by_cid $CONTAINER_ID $@
 }
 
 
-# generic functions 
+# generic functions
 get_container_ip_by_cid() {
   local IP=$(docker inspect -f "{{ .NetworkSettings.IPAddress }}" $1)
   echo "$IP"
@@ -50,7 +54,7 @@ start_containers_by_cid() {
   do
     #disable outputs
     docker start $cid &> /dev/null
-  done 
+  done
 }
 
 stop_containers_by_cid() {
@@ -58,7 +62,7 @@ stop_containers_by_cid() {
   do
     #disable outputs
     docker stop $cid &> /dev/null
-  done 
+  done
 }
 
 remove_containers_by_cid() {
@@ -66,7 +70,7 @@ remove_containers_by_cid() {
   do
     #disable outputs
     docker rm $cid &> /dev/null
-  done 
+  done
 }
 
 clear_containers_by_cid() {
@@ -78,12 +82,18 @@ is_service_running_by_cid() {
   docker exec $1 ps cax | grep $2  > /dev/null
 }
 
+is_file_exists_by_cid() {
+  docker exec $1 cat "/etc/my_init_startup_files_completed" > /dev/null 2>&1
+}
+
 wait_service_by_cid() {
 
   cid=$1
 
+  sleep 1
+
   # first wait image init end
-  while ! is_service_running_by_cid $cid syslog-ng
+  while ! is_file_exists_by_cid $cid /etc/my_init_startup_files_completed
   do
     sleep 1
   done
@@ -98,4 +108,4 @@ wait_service_by_cid() {
   done
 
   sleep 5
-}
+}