Merge branch 'release-0.2.0' into stable

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.2.0
+  - Upgrade baseimage: light-baseimage:0.2.1
+  - Makefile with build no cache
+
+## 0.1.9
+  - Upgrade baseimage: light-baseimage:0.1.5
+
+## 0.1.8
+  - Upgrade baseimage: light-baseimage:0.1.4
+
+## 0.1.7
+  - Upgrade baseimage: light-baseimage:0.1.2
+
+## 0.1.6
+  - Better way to add custom config
+  - Improve documentation
+
+## 0.1.5
+  - Upgrade baseimage: 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 :

Makefile

@@ -1,13 +1,16 @@
 NAME = osixia/keepalived
-VERSION = 0.1.2
+VERSION = 0.2.0
 
-.PHONY: all build test tag_latest release
+.PHONY: all build build-nocache test tag_latest release
 
 all: build
 
 build:
 	docker build -t $(NAME):$(VERSION) --rm image
 
+build-nocache:
+	docker build -t $(NAME):$(VERSION) --no-cache --rm image
+
 test:
 	env NAME=$(NAME) VERSION=$(VERSION) bats test/test.bats
 

README.md

@@ -1,10 +1,184 @@
 # osixia/keepalived
 
+[![](https://badge.imagelayers.io/osixia/keepalived:latest.svg)](https://imagelayers.io/?images=osixia/keepalived:latest 'Get your own badge on imagelayers.io') | Latest release: 0.2.0 - Keepalived 1.2.19 - [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)
+	- [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)
+	- [Extend osixia/keepalived:0.2.0 image](#extend-osixiakeepalived020-image)
+	- [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)
+
 ## Quick start
 
-This image require the kernel module ip_vs loaded on the host and need to be run with : --privileged --net=host
+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 --privileged --net=host -d osixia/keepalived
+    docker run --cap-add=NET_ADMIN --net=host -d osixia/keepalived:0.2.0
+
+## 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` :
+
+      docker run --volume /data/my-keepalived.conf:/container/service/keepalived/assets/keepalived.conf --detach osixia/keepalived:0.2.0
+
+- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide](#advanced-user-guide)
+
+### 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:
+
+	docker run --detach osixia/keepalived:0.2.0 --loglevel debug
+
+See all command line options:
+
+	docker run osixia/keepalived:0.2.0 --help
+
+
+## Environment Variables
+
+Environment variables defaults are set in **image/environment/default.yaml**
+
+See how to [set your own environment variables](#set-your-own-environment-variables)
+
+
+- **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 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.0
+
+  To convert yaml to python online : http://yaml-online-parser.appspot.com/
+
+
+- **KEEPALIVED_VIRTUAL_IPS** Keepalived virtual IPs. 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`
+
+- **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.0
+
+
+#### 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 \
+	--detach osixia/keepalived:0.2.0
+
+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
+
+### Extend osixia/keepalived:0.2.0 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.0
+    MAINTAINER Your Name <your@name.com>
+
+    ADD keepalived.conf /container/service/keepalived/assets/keepalived.conf
+    ADD environment /container/environment/01-custom
+    ADD scripts.sh /container/service/keepalived/assets/notify.sh
+
+
+### Make your own keepalived image
+
+
+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.2.0
+
+	becomes :
+	NAME = billy-the-king/keepalived
+	VERSION = 0.1.0
+
+Add your custom scripts, environment files, config ...
+
+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
+
+
+### 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)

image/Dockerfile

@@ -1,35 +1,40 @@
-FROM osixia/baseimage:0.10.4
+# Use osixia/light-baseimage
+# sources: https://github.com/osixia/docker-light-baseimage
+FROM osixia/light-baseimage:0.2.1
 MAINTAINER Bertrand Gouny <bertrand.gouny@osixia.net>
 
 # Keepalived version
 ENV KEEPALIVED_VERSION 1.2.19
 
-# Use baseimage-docker's init system.
-CMD ["/sbin/my_init"]
-
-# Install Keepalived
+# Download, build and install Keepalived
 RUN apt-get -y update \
-    && LC_ALL=C DEBIAN_FRONTEND=noninteractive apt-get install -y \
-    make gcc pkg-config libssl-dev libnl-dev \
+    && LC_ALL=C DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+       curl \
+       gcc \
+       libnl-3-dev \
+       libnl-genl-3-dev \
+       libssl-dev \
+       make \
+       pkg-config \
     && 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 pkg-config libssl-dev libnl-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 environment /container/environment/99-default

image/environment/default.yaml

@@ -1,7 +1,7 @@
 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
 
@@ -13,4 +13,6 @@ KEEPALIVED_VIRTUAL_IPS:
   - 192.168.1.231
   - 192.168.1.232
 
-KEEPALIVED_NOTIFY: /osixia/keepalived/notify.sh
+KEEPALIVED_NOTIFY: /container/service/keepalived/assets/notify.sh
+
+KEEPALIVED_COMMAND_LINE_ARGUMENTS: --log-detail --dump-conf

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/notify.sh

@@ -16,16 +16,16 @@ NAME=$2
 STATE=$3
 
 case $STATE in
-        "MASTER") logger "I'm the MASTER! Whup whup."
+        "MASTER") logger -s -t keepalived-notify "I'm the MASTER! Whup whup."
                   exit 0
                   ;;
-        "BACKUP") logger "Ok, i'm just a backup, great."
+        "BACKUP") logger -s -t keepalived-notify "Ok, i'm just a backup, great."
                   exit 0
                   ;;
-        "FAULT")  logger "Fault, what ?"
+        "FAULT")  logger -s -t keepalived-notify "Fault, what ?"
                   exit 0
                   ;;
-        *)        logger "Unknown state"
+        *)        logger -s -t keepalived-notify "Unknown state"
                   exit 1
                   ;;
 esac

image/service/keepalived/container-start.sh

@@ -1,67 +0,0 @@
-#!/bin/bash -e
-
-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 /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
-
-      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
-
-  fi
-
-  touch $FIRST_START_DONE
-fi
-
-exit 0

image/service/keepalived/daemon.sh

@@ -1,2 +0,0 @@
-#!/bin/bash -e
-exec /usr/local/sbin/keepalived -f /etc/keepalived/keepalived.conf --dont-fork --log-console -D -d

image/service/keepalived/process.sh

@@ -0,0 +1,7 @@
+#!/bin/bash -e
+
+# set -x (bash debug) if log level is trace
+# https://github.com/osixia/docker-light-baseimage/blob/stable/image/tool/log-helper
+log-helper level eq trace && set -x
+
+exec /usr/local/sbin/keepalived -f /etc/keepalived/keepalived.conf --dont-fork --log-console ${KEEPALIVED_COMMAND_LINE_ARGUMENTS}

image/service/keepalived/startup.sh

@@ -0,0 +1,46 @@
+#!/bin/bash -e
+
+# set -x (bash debug) if log level is trace
+# https://github.com/osixia/docker-light-baseimage/blob/stable/image/tool/log-helper
+log-helper level eq trace && set -x
+
+FIRST_START_DONE="${CONTAINER_STATE_DIR}/docker-keepalived-first-start-done"
+# container first start
+if [ ! -e "$FIRST_START_DONE" ]; then
+
+  #
+  # bootstrap config
+  #
+  sed -i --follow-symlinks "s|{{ keepalived_interface }}|$KEEPALIVED_INTERFACE|g" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+  sed -i --follow-symlinks "s|{{ keepalived_priority }}|$KEEPALIVED_PRIORITY|g" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+  sed -i --follow-symlinks "s|{{ keepalived_password }}|$KEEPALIVED_PASSWORD|g" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+
+  if [ -n "$KEEPALIVED_NOTIFY" ]; then
+    sed -i --follow-symlinks "s|{{ keepalived_notify }}|notify \"$KEEPALIVED_NOTIFY\"|g" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+    chmod +x $KEEPALIVED_NOTIFY
+  else
+    sed -i --follow-symlinks "/{{ keepalived_notify }}/d" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+  fi
+
+  # unicast peers
+  for peer in $(complex-bash-env iterate KEEPALIVED_UNICAST_PEERS)
+  do
+    sed -i --follow-symlinks "s|{{ keepalived_unicast_peers }}|${!peer}\n    {{ keepalived_unicast_peers }}|g" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+  done
+  sed -i --follow-symlinks "/{{ keepalived_unicast_peers }}/d" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+
+  # virtual ips
+  for vip in $(complex-bash-env iterate KEEPALIVED_VIRTUAL_IPS)
+  do
+    sed -i --follow-symlinks "s|{{ keepalived_virtual_ips }}|${!vip}\n    {{ keepalived_virtual_ips }}|g" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+  done
+  sed -i --follow-symlinks "/{{ keepalived_virtual_ips }}/d" ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf
+
+  touch $FIRST_START_DONE
+fi
+
+if [ ! -e "/etc/backup-manager.conf" ]; then
+  ln -sf ${CONTAINER_SERVICE_DIR}/keepalived/assets/keepalived.conf /etc/keepalived/keepalived.conf
+fi
+
+exit 0

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,14 +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 $2 > /dev/null 2>&1
+}
+
 wait_service_by_cid() {
 
   cid=$1
 
   # first wait image init end
-  while ! is_service_running_by_cid $cid syslog-ng
+  while ! is_file_exists_by_cid $cid /container/run/state/startup-done
   do
-    sleep 1
+    sleep 0.5
   done
 
   for service in "${@:2}"
@@ -93,9 +101,7 @@ wait_service_by_cid() {
     # wait service
     while ! is_service_running_by_cid $cid $service
     do
-      sleep 1
+      sleep 0.5
     done
   done
-
-  sleep 5
-}
+}