capistrano-docker_cluster 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444ef3fec5be6c32f7f8cf8e2ee1c1bfb89a153372c6213ff8b505ba46ee4ba7
-  data.tar.gz: e36145b530ac39683213d08aff2111930cc5a7a0a75094dfd2a6a15f6fffa7d7
+  metadata.gz: ebbb1defa7363b3977d59a8086513972c4a0258a4e3766b4de6c306f5beee4ed
+  data.tar.gz: 49e0318d6ef793cbe74351bfcce166e456aabd28347c430917b44bd836fca518
 SHA512:
-  metadata.gz: b9dfeb4a4e6d4b4d97c4a31d5aaf8c1f5e3df7df51e54c3248793d6675bf7616e7c7f3bd25ade0d264db63ef9d076249ac754b609bd3477997c062bab240ef41
-  data.tar.gz: ff8957d0fba36b8b62fd65127aae9419943da6ff3208cc80484234f5e1f3ef61b3f261ee62515b31690b5876348c42a75ec7178c8b11a1add69ada8f3ee183fb
+  metadata.gz: 44497d8dd8ab30ac78b15362e7ecf8e5081a238804034273e183d5811a6ba4e5189a93f9db486672bd1708ce7b325ad6ec5e1894bddda4d5e6d6b6a117789e43
+  data.tar.gz: 7cdd4315f6a9cface2ee10216f7e7376a9d1dbbd21efd20b6a6b104b21c72ca4635e3bd0829bdf77e3f1dae6dc9117b5bb340f75d4e7f14e4755032e9dd3f8f0

data/CHANGE_LOG.md

@@ -1,3 +1,8 @@
+# 1.0.5
+
+* Add "--no-" prefix on arguments to remove them.
+* Add ability to turn off healthcheck entirely.
+
 # 1.0.4
 
 * Add --clear-command argument to clear the docker command buffer.

data/bin/docker-cluster

@@ -17,15 +17,18 @@
 # port is the exposed port to map from the containers. The base host port is the port number to start mapping
 # the container ports to. If the base host port is not specified, then the container port will be used as the
 # base host port. For instance, `--port=80:8000 --count=2` will start two containers with the first one mapping
-# host port 8000 to container port 80 and the second mapping host port 8001 to container port 80.
+# host port 8000 to container port 80 and the second mapping host port 8001 to container port 80. You can use
+# --no-port to clear all port bindings.
 #
 # The --hostname parameter can be used to specify a base host name for the containers. The host name for each
 # container will be "container_name.base_host_name" where container name uses a hyphen instead of a period as
-# the delimiter.
+# the delimiter. You can use --no-hostname to clear the hostname to use the default.
 #
 # The --healthcheck parameter can be used to specify either a command to run inside the container or a URL
 # to ping from within the container to determine if the container is up. The next container will not be shutdown
-# until the previous one is determined to be up when this parameter is specified.
+# until the previous one is determined to be up when this parameter is specified. If this is not specified,
+# or if the value is "docker", the docker engine health check will be used. You can remove the healthcheck
+# altogether with --no-healthcheck.
 #
 # The --timeout parameter can be used to specify a timeout for how long to wait for a container to stop or start
 # before assuming something is wrong. In the case of stopping the container, the container will be force killed
@@ -39,10 +42,7 @@
 # The --command parameter can be used to specify the command each docker container should run. If multiple command parameters
 # are specified, they will be concatenated together. You can use this to specify a command and arguments separately.
 # You can also specify the command by using --. Anything after a double hyphen will be appended to the docker
-# command line verbatim.
-#
-# The --clear-command flag can be used to clear the docker run command. Use this if you need to completely override
-# command that has already been set on the command line.
+# command line verbatim. You can clear the command buffer with --no-command.
 #
 # The --force parameter can be used to specify that containers should always be restarted. The default behavior
 # is to only restart containers if they are not running the specified image.
@@ -64,13 +64,14 @@ usage() {
   echo "  --name CONTAINER_NAME_PREFIX (or --one-off)"
   echo "  [--count CONTAINER_COUNT] (default 1)"
   echo "  [--image DOCKER_IMAGE] (image tag or id; required if --count > 0)"
-  echo "  [--port CONTAINER_PORT[:BASE_HOST_PORT]]"
-  echo "  [--hostname CONTAINER_BASE_HOST_NAME]"
-  echo "  [--healthcheck COMMAND|CURL_URL]"
+  echo "  [--[no-]port CONTAINER_PORT[:BASE_HOST_PORT]]"
+  echo "  [--[no-]hostname CONTAINER_BASE_HOST_NAME]"
+  echo "  [--[no-]healthcheck COMMAND|CURL_URL]"
   echo "  [--timeout SECONDS] (default 120)"
   echo "  [--config CONFIG_FILE_PATH]"
-  echo "  [--command DOCKER_RUN_COMMAND]"
-  echo "  [--verbose]"
+  echo "  [--[no-]command DOCKER_RUN_COMMAND]"
+  echo "  [--[no-]verbose]"
+  echo "  [--] docker command arguments"
   echo "  All other options are passed through to 'docker run'"
 }
 
@@ -103,10 +104,16 @@ read_arguments() {
         [[ -z $val ]] && shift && val=$1
         PORT_MAPPING+=($val)
         ;;
+      --no-port )
+        PORT_MAPPING=()
+        ;;
       --hostname )
         [[ -z $val ]] && shift && val=$1
         CONTAINER_BASE_HOST_NAME=$val
         ;;
+      --hostname )
+        CONTAINER_BASE_HOST_NAME=
+        ;;
       --config )
         [[ -z $val ]] && shift && val=$1
         cat "$val" > /dev/null
@@ -119,6 +126,9 @@ read_arguments() {
         [[ -z $val ]] && shift && val=$1
         DOCKER_RUN_COMMAND="$DOCKER_RUN_COMMAND $val"
         ;;
+      --no-command )
+        DOCKER_RUN_COMMAND=""
+        ;;
       --clear-command )
         DOCKER_RUN_COMMAND=""
         ;;
@@ -133,6 +143,9 @@ read_arguments() {
         [[ -z $val ]] && shift && val=$1
         HEALTHCHECK=$val
         ;;
+      --no-healthcheck )
+        HEALTHCHECK=
+        ;;
       --timeout )
         [[ -z $val ]] && shift && val=$1
         TIMEOUT=$val
@@ -140,6 +153,9 @@ read_arguments() {
       --force )
         FORCE_RESTART="1"
         ;;
+      --no-force )
+        FORCE_RESTART=
+        ;;
       --help )
         usage
         exit
@@ -148,6 +164,10 @@ read_arguments() {
         set -o xtrace
         CMD_OUT=/dev/stdout
         ;;
+      --no-verbose )
+        set +o xtrace
+        CMD_OUT=/dev/null
+        ;;
       -- )
         shift
         DOCKER_RUN_COMMAND="$DOCKER_RUN_COMMAND $@"
@@ -323,13 +343,8 @@ start_container() {
 
     typeset status=${info_arr[3]}
     if [[ $status == "Up"* ]]; then
-      if [[ $HEALTHCHECK != "" ]]; then
-        healthy=`docker_healthcheck $container_id "$HEALTHCHECK"`
-        if [[ $healthy == "0" ]]; then
-          success=0
-          break
-        fi
-      else
+      if [[ $HEALTHCHECK == "docker" ]]; then
+        # use built in docker health check
         if [[ $status == *"health"* ]]; then
           if [[ $status == *"healthy"* ]]; then
             success=0
@@ -339,6 +354,17 @@ start_container() {
           success=0
           break
         fi
+      elif [[ $HEALTHCHECK != "" ]]; then
+        # custom container command
+        healthy=`docker_healthcheck $container_id "$HEALTHCHECK"`
+        if [[ $healthy == "0" ]]; then
+          success=0
+          break
+        fi
+      else
+        # no health check
+        success=0
+        break
       fi
     fi
 
@@ -381,7 +407,7 @@ CONTAINER_NAME_PREFIX=
 CONTAINER_COUNT=1
 PORT_MAPPING=()
 DOCKER_RUN_COMMAND=
-HEALTHCHECK=
+HEALTHCHECK=docker
 TIMEOUT=120
 CMD_OUT=/dev/null
 DOCKER_RUN_ARGS=

data/lib/capistrano/docker_cluster/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module DockerCluster
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-docker_cluster
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano