From da91a57add1f364ba78c8da091ba919e032f3f46 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Wed, 8 Jan 2014 14:48:12 -0600 Subject: [PATCH 1/9] High: Introduces the docker agent to manage docker containers in an HA environment --- doc/man/Makefile.am | 1 + heartbeat/Makefile.am | 1 + heartbeat/docker | 262 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 264 insertions(+) create mode 100755 heartbeat/docker diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 3b4034d3ca..eafb2d10b6 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -98,6 +98,7 @@ man_MANS = ocf_heartbeat_AoEtarget.7 \ ocf_heartbeat_conntrackd.7 \ ocf_heartbeat_db2.7 \ ocf_heartbeat_dhcpd.7 \ + ocf_heartbeat_docker.7 \ ocf_heartbeat_eDir88.7 \ ocf_heartbeat_ethmonitor.7 \ ocf_heartbeat_exportfs.7 \ diff --git a/heartbeat/Makefile.am b/heartbeat/Makefile.am index 49208a915d..330b7f7edd 100644 --- a/heartbeat/Makefile.am +++ b/heartbeat/Makefile.am @@ -67,6 +67,7 @@ ocf_SCRIPTS = ClusterMon \ dhcpd \ Delay \ dnsupdate \ + docker \ eDir88 \ EvmsSCC \ Evmsd \ diff --git a/heartbeat/docker b/heartbeat/docker new file mode 100755 index 0000000000..6e2e55fd24 --- /dev/null +++ b/heartbeat/docker @@ -0,0 +1,262 @@ +#!/bin/sh +# +# The docker HA resource agent creates and launches a docker container +# based off a supplied docker image. Containers managed by this agent +# are both created and removed upon the agent's start and stop actions. +# +# Copyright (c) 2014 David Vossel +# All Rights Reserved. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of version 2 of the GNU General Public License as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it would be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# +# Further, this software is distributed without any warranty that it is +# free of the rightful claim of any third person regarding infringement +# or the like. Any license provided herein, whether implied or +# otherwise, applies only to this software file. Patent licenses, if +# any, provided herein do not apply to combinations of this program with +# other software, or any other product whatsoever. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write the Free Software Foundation, +# Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA. +# + +####################################################################### +# Initialization: + +: ${OCF_FUNCTIONS_DIR=${OCF_ROOT}/lib/heartbeat} +. ${OCF_FUNCTIONS_DIR}/ocf-shellfuncs + +####################################################################### + +meta_data() +{ + cat < + + +1.0 + + +The docker HA resource agent creates and launches a docker container +based off a supplied docker image. Containers managed by this agent +are both created and removed upon the agent's start and stop actions. + +Docker container resource agent. + + + + +The docker image to base this container off of. + +docker image + + + + + +The name to give the created container. By default this will +be that resource's instance name prefixed with 'HA-'. + +docker container name + + + + + +Allow the image to be pulled from the configured docker registry when +the image does not exist locally. NOTE, this can drastically increase +the time required to start the container if the image repository is +pulled over the network. + +Allow pulling non-local images + + + + + +Add options to be appended to the 'docker run' command which is used +when creating the container during the start action. This option allows +users to do things such as setting a custom entry point and injecting +environment variables into the newly created container. Note the '-d' +option is supplied regardless of this value to force containers to run +in the background. + +docker image + + + + + +Specifiy a command to launch within the container once +it has initialized. + +run command + + + + + + + + + + + + + +END +} + +####################################################################### + +docker_usage() +{ + cat <&1 | grep '^ *\"Running.*:.*true' > /dev/null 2>&1 + if [ $? -eq 0 ]; then + return $OCF_SUCCESS + fi + + # check for left over containers that may be inactive but left over after a reboot. + docker inspect $CONTAINER 2>&1 | grep '^ *\"Running.*:.*false' > /dev/null 2>&1 + if [ $? -eq 0 ]; then + ocf_log notice "Cleaning up inactive container, ${CONTAINER}. Container exists but is not running." + docker rm $CONTAINER > /dev/null 2>&1 + return $OCF_NOT_RUNNING + fi + + return $OCF_NOT_RUNNING +} + +docker_start() +{ + local run_opts="-d --name=${CONTAINER}" + # check to see if the container has already started + docker_monitor + if [ $? -eq $OCF_SUCCESS ]; then + return $OCF_SUCCESS + fi + + if [ -n "$OCF_RESKEY_run_opts" ]; then + run_opts="$run_opts $OCF_RESKEY_run_opts" + fi + + ocf_run docker run $run_opts $OCF_RESKEY_image $OCF_RESKEY_run_cmd + if [ $? -ne 0 ]; then + ocf_log err "docker run command failed to launch container" + return $OCF_ERR_GENERIC + fi + + docker_monitor + if [ $? -ne $OCF_SUCCESS ]; then + ocf_log err "Newly created docker container exited after start" + return $OCF_ERR_GENERIC + fi + + return $OCF_SUCCESS +} + +docker_stop() +{ + local timeout=60 + docker_monitor + if [ $? -eq $OCF_NOT_RUNNING ]; then + return $OCF_SUCCESS + fi + + if [ -n "$OCF_RESKEY_CRM_meta_timeout" ]; then + timeout=$((($OCF_RESKEY_CRM_meta_timeout/1000) -5 )) + if [ $timeout -lt 10 ]; then + timeout=10 + fi + fi + + ocf_log debug "waiting $timeout seconds before killing container" + + ocf_run docker stop -t=$timeout $CONTAINER + if [ $? -ne 0 ]; then + ocf_log err "Failed to stop container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." + return $OCF_ERR_GENERIC + fi + + ocf_run docker rm $CONTAINER + if [ $? -ne 0 ]; then + ocf_log err "Failed to remove stopped container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." + return $OCF_ERR_GENERIC + fi + + return $OCF_SUCCESS +} + +image_exists() +{ + local res=1 + docker images | awk '{print $1}' | grep "^${OCF_RESKEY_image}\$" > /dev/null 2>&1 + if [ $? -eq 0 ]; then + return 0 + fi + if ocf_is_true "$OCF_RESKEY_allow_pull"; then + docker search $OCF_RESKEY_image | awk '{print $1}' | grep "^${OCF_RESKEY_image}\$" > /dev/null 2>&1 + if [ $? -eq 0 ]; then + ocf_log notice "Image (${OCF_RESKEY_image}) does not exist locally, but has been found in the docker registry. This image will be pulled on start" + return 0 + fi + fi + return 1 +} + +docker_validate() +{ + check_binary docker + if [ -z "$OCF_RESKEY_image" ]; then + ocf_log err "'image' option is required" + exit $OCF_ERR_CONFIGURED + fi + + image_exists + if [ $? -ne 0 ]; then + ocf_log err "base image, ${OCF_RESKEY_image}, could not be found." + exit $OCF_ERR_CONFIGURED + fi + + return $OCF_SUCCESS +} + +: ${OCF_RESKEY_container=HA-${OCF_RESOURCE_INSTANCE}} +CONTAINER=$OCF_RESKEY_container + +case $__OCF_ACTION in +meta-data) meta_data + exit $OCF_SUCCESS;; +start) + docker_validate + docker_start;; +stop) docker_stop;; +monitor) docker_monitor;; +validate-all) docker_validate;; +usage|help) docker_usage + exit $OCF_SUCCESS + ;; +*) docker_usage + exit $OCF_ERR_UNIMPLEMENTED + ;; +esac +rc=$? +ocf_log debug "${OCF_RESOURCE_INSTANCE} $__OCF_ACTION : $rc" +exit $rc + From 2b18253f7dffb99d2976dae7987ab51774ed8077 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Fri, 3 Oct 2014 13:45:07 -0400 Subject: [PATCH 2/9] Low: docker: fixes run_opts short description --- heartbeat/docker | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/heartbeat/docker b/heartbeat/docker index 6e2e55fd24..94abbae13d 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -88,7 +88,7 @@ environment variables into the newly created container. Note the '-d' option is supplied regardless of this value to force containers to run in the background. -docker image +run options From e011f7bbd8ec4f6290b420643193c40075df5175 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Fri, 3 Oct 2014 14:18:14 -0400 Subject: [PATCH 3/9] Fix: docker: properly handle images with tags --- heartbeat/docker | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index 94abbae13d..138cfcead1 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -115,6 +115,7 @@ END } ####################################################################### +REQUIRE_IMAGE_PULL=0 docker_usage() { @@ -156,6 +157,15 @@ docker_start() run_opts="$run_opts $OCF_RESKEY_run_opts" fi + if [ $REQUIRE_IMAGE_PULL -eq 1 ]; then + ocf_log notice "Beginning pull of image, ${OCF_RESKEY_image}" + docker pull "${OCF_RESKEY_image}" + if [ $? -ne 0 ]; then + ocf_log err "failed to pull image ${OCF_RESKEY_image}" + return $OCF_ERR_GENERIC + fi + fi + ocf_run docker run $run_opts $OCF_RESKEY_image $OCF_RESKEY_run_cmd if [ $? -ne 0 ]; then ocf_log err "docker run command failed to launch container" @@ -206,17 +216,23 @@ docker_stop() image_exists() { local res=1 - docker images | awk '{print $1}' | grep "^${OCF_RESKEY_image}\$" > /dev/null 2>&1 + + + echo "${OCF_RESKEY_image}" | grep -q ":" + if [ $? -eq 0 ]; then + docker images | awk '{print $1 ":" $2}' | grep "^${OCF_RESKEY_image}\$" > /dev/null 2>&1 + else + docker images | awk '{print $1}' | grep "^${OCF_RESKEY_image}\$" > /dev/null 2>&1 + fi if [ $? -eq 0 ]; then return 0 fi if ocf_is_true "$OCF_RESKEY_allow_pull"; then - docker search $OCF_RESKEY_image | awk '{print $1}' | grep "^${OCF_RESKEY_image}\$" > /dev/null 2>&1 - if [ $? -eq 0 ]; then - ocf_log notice "Image (${OCF_RESKEY_image}) does not exist locally, but has been found in the docker registry. This image will be pulled on start" - return 0 - fi + REQUIRE_IMAGE_PULL=1 + ocf_log notice "Image (${OCF_RESKEY_image}) does not exist locally but will be pulled during start" + return 0 fi + # image not found. return 1 } From aeecaa8a893f11ce8fbae6bc77f69f19b675ab66 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Fri, 3 Oct 2014 14:24:55 -0400 Subject: [PATCH 4/9] Low: docker: increase recommended action timeouts --- heartbeat/docker | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index 138cfcead1..6dd83a259a 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -104,11 +104,11 @@ it has initialized. - - + + - + END From 5a32798410262d0d38a6ea5be47a959745de4309 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Fri, 3 Oct 2014 14:29:46 -0400 Subject: [PATCH 5/9] High: docker: force_kill option for immediately killing docker container on stop --- heartbeat/docker | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index 6dd83a259a..86711c1560 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -101,6 +101,15 @@ it has initialized. + + +Kill a container immediately rather than waiting for it to gracefully +shutdown + +force kill + + + @@ -190,15 +199,19 @@ docker_stop() fi if [ -n "$OCF_RESKEY_CRM_meta_timeout" ]; then - timeout=$((($OCF_RESKEY_CRM_meta_timeout/1000) -5 )) + timeout=$((($OCF_RESKEY_CRM_meta_timeout/1000) -10 )) if [ $timeout -lt 10 ]; then timeout=10 fi fi - ocf_log debug "waiting $timeout seconds before killing container" + if ocf_is_true "$OCF_RESKEY_force_kill"; then + ocf_run docker kill $CONTAINER + else + ocf_log debug "waiting $timeout second[s] before killing container" + ocf_run docker stop -t=$timeout $CONTAINER + fi - ocf_run docker stop -t=$timeout $CONTAINER if [ $? -ne 0 ]; then ocf_log err "Failed to stop container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." return $OCF_ERR_GENERIC From faad7c8fc4a3780d6e7a322615d57e540d09c1d1 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Fri, 3 Oct 2014 14:38:57 -0400 Subject: [PATCH 6/9] Low: docker: make use of exit reason string --- heartbeat/docker | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index 86711c1560..9f662c8336 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -170,20 +170,20 @@ docker_start() ocf_log notice "Beginning pull of image, ${OCF_RESKEY_image}" docker pull "${OCF_RESKEY_image}" if [ $? -ne 0 ]; then - ocf_log err "failed to pull image ${OCF_RESKEY_image}" + ocf_exit_reason "failed to pull image ${OCF_RESKEY_image}" return $OCF_ERR_GENERIC fi fi ocf_run docker run $run_opts $OCF_RESKEY_image $OCF_RESKEY_run_cmd if [ $? -ne 0 ]; then - ocf_log err "docker run command failed to launch container" + ocf_exit_reason "docker run command failed to launch container" return $OCF_ERR_GENERIC fi docker_monitor if [ $? -ne $OCF_SUCCESS ]; then - ocf_log err "Newly created docker container exited after start" + ocf_exit_reason "Newly created docker container exited after start" return $OCF_ERR_GENERIC fi @@ -213,13 +213,13 @@ docker_stop() fi if [ $? -ne 0 ]; then - ocf_log err "Failed to stop container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." + ocf_exit_reason "Failed to stop container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." return $OCF_ERR_GENERIC fi ocf_run docker rm $CONTAINER if [ $? -ne 0 ]; then - ocf_log err "Failed to remove stopped container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." + ocf_exit_reason "Failed to remove stopped container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." return $OCF_ERR_GENERIC fi @@ -253,13 +253,13 @@ docker_validate() { check_binary docker if [ -z "$OCF_RESKEY_image" ]; then - ocf_log err "'image' option is required" + ocf_exit_reason "'image' option is required" exit $OCF_ERR_CONFIGURED fi image_exists if [ $? -ne 0 ]; then - ocf_log err "base image, ${OCF_RESKEY_image}, could not be found." + ocf_exit_reason "base image, ${OCF_RESKEY_image}, could not be found." exit $OCF_ERR_CONFIGURED fi From 746e240dd152990b96275075e6183e61286b8a6e Mon Sep 17 00:00:00 2001 From: David Vossel Date: Mon, 6 Oct 2014 12:31:06 -0400 Subject: [PATCH 7/9] High: docker: Introducing the 'reuse' container option By default containers started with the docker OCF agent are dynamically created on start and removed after stop. By using the 'reuse' option, containers will never be destroyed after stop, allowing the same container to be reused. --- heartbeat/docker | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index 9f662c8336..1b05f842bd 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -110,6 +110,16 @@ shutdown + + +Allow the container to be reused after stopping the container. By default +containers are removed after stop. With the reuse option containers +will persist after the container stops. + +reuse container + + + @@ -135,8 +145,29 @@ Expects to have a fully populated OCF RA-compliant environment set. END } +container_exists() +{ + docker inspect $CONTAINER > /dev/null 2>&1 +} + +remove_container() +{ + if ocf_is_true "$OCF_RESKEY_reuse"; then + # never remove the container if we have reuse enabled. + return 0 + fi + + ocf_log notice "Cleaning up inactive container, ${CONTAINER}." + ocf_run docker rm $CONTAINER +} + docker_monitor() { + container_exists + if [ $? -ne 0 ]; then + return $OCF_NOT_RUNNING + fi + docker inspect $CONTAINER 2>&1 | grep '^ *\"Running.*:.*true' > /dev/null 2>&1 if [ $? -eq 0 ]; then return $OCF_SUCCESS @@ -145,8 +176,7 @@ docker_monitor() # check for left over containers that may be inactive but left over after a reboot. docker inspect $CONTAINER 2>&1 | grep '^ *\"Running.*:.*false' > /dev/null 2>&1 if [ $? -eq 0 ]; then - ocf_log notice "Cleaning up inactive container, ${CONTAINER}. Container exists but is not running." - docker rm $CONTAINER > /dev/null 2>&1 + remove_container return $OCF_NOT_RUNNING fi @@ -175,9 +205,16 @@ docker_start() fi fi - ocf_run docker run $run_opts $OCF_RESKEY_image $OCF_RESKEY_run_cmd + if ocf_is_true "$OCF_RESKEY_reuse" && container_exists; then + ocf_log info "starting existing container $CONTAINER." + ocf_run docker start $CONTAINER + else + ocf_log info "running container $CONTAINER for the first time" + ocf_run docker run $run_opts $OCF_RESKEY_image $OCF_RESKEY_run_cmd + fi + if [ $? -ne 0 ]; then - ocf_exit_reason "docker run command failed to launch container" + ocf_exit_reason "docker failed to launch container" return $OCF_ERR_GENERIC fi @@ -217,7 +254,7 @@ docker_stop() return $OCF_ERR_GENERIC fi - ocf_run docker rm $CONTAINER + remove_container if [ $? -ne 0 ]; then ocf_exit_reason "Failed to remove stopped container, ${CONTAINER}, based on image, ${OCF_RESKEY_image}." return $OCF_ERR_GENERIC From 2dcb04b5a2576f73ff892b6c0145685489281dbf Mon Sep 17 00:00:00 2001 From: David Vossel Date: Mon, 6 Oct 2014 14:38:04 -0400 Subject: [PATCH 8/9] Low: docker: use docker inspect --format instead of grep pattern --- heartbeat/docker | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index 1b05f842bd..b28c6ee204 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -163,21 +163,23 @@ remove_container() docker_monitor() { + local val + container_exists if [ $? -ne 0 ]; then return $OCF_NOT_RUNNING fi - docker inspect $CONTAINER 2>&1 | grep '^ *\"Running.*:.*true' > /dev/null 2>&1 - if [ $? -eq 0 ]; then - return $OCF_SUCCESS + # retrieve the 'Running' attribute for the container + val=$(docker inspect --format {{.State.Running}} $CONTAINER 2>/dev/null) + if [ $? -ne 0 ]; then + #not running as a result of container not being found + return $OCF_NOT_RUNNING fi - # check for left over containers that may be inactive but left over after a reboot. - docker inspect $CONTAINER 2>&1 | grep '^ *\"Running.*:.*false' > /dev/null 2>&1 - if [ $? -eq 0 ]; then - remove_container - return $OCF_NOT_RUNNING + if ocf_is_true "$val"; then + # container exists and is running + return $OCF_SUCCESS fi return $OCF_NOT_RUNNING From 7542b3f27026d1bedea0d4b6714b34088ac30366 Mon Sep 17 00:00:00 2001 From: David Vossel Date: Mon, 6 Oct 2014 15:15:26 -0400 Subject: [PATCH 9/9] High: docker: default container name to resource instance name originally the default container name was the resource instance name prefixed with 'HA-'. This is confusing and unncessary. Now the container name defaults directly to the resource instance name with no prefix. --- heartbeat/docker | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/heartbeat/docker b/heartbeat/docker index b28c6ee204..546c4238ea 100755 --- a/heartbeat/docker +++ b/heartbeat/docker @@ -62,7 +62,7 @@ The docker image to base this container off of. The name to give the created container. By default this will -be that resource's instance name prefixed with 'HA-'. +be that resource's instance name. docker container name @@ -305,7 +305,7 @@ docker_validate() return $OCF_SUCCESS } -: ${OCF_RESKEY_container=HA-${OCF_RESOURCE_INSTANCE}} +: ${OCF_RESKEY_container=${OCF_RESOURCE_INSTANCE}} CONTAINER=$OCF_RESKEY_container case $__OCF_ACTION in