Merge pull request #279 from MWilsonPuppet/CLOUD-2018-Add-health-check-interval

CLOUD-2018-Add-health-check-interval

Author: davejrt

README.md

@@ -386,14 +386,15 @@ docker::run { 'helloworld':
 }
 ```
 
-To enable the restart of an unhealthy container add the following code to the manifest file.
+To enable the restart of an unhealthy container add the following code to the manifest file.In order to set the health check interval time set the optional health_check_interval parameter, the default health check interval is 30 seconds.
 
 ```puppet
 docker::run { 'helloworld':
   image => 'base',
   command => 'command',
-  health_check_command => '<command_to_execute_to_check_your_containers_health>',
+  health_check_cmd => '<command_to_execute_to_check_your_containers_health>',
   restart_on_unhealthy => true,
+  health_check_interval => '<time between running docker healthcheck>',
 ```
 
 To run command on Windows 2016 requires the `restart` parameter to be set:

lib/puppet/parser/functions/docker_run_flags.rb

@@ -50,6 +50,10 @@ module Puppet::Parser::Functions
       flags << "--health-cmd='#{opts['health_check_cmd']}'"
     end
 
+    if opts['health_check_interval'].to_s != 'undef'
+      flags << "--health-interval=#{opts['health_check_interval']}s"
+    end
+
     if opts['tty']
       flags << '-t'
     end

manifests/run.pp

@@ -52,6 +52,10 @@
 # (optional) Specifies the command to execute to check that the container is healthy using the docker health check functionality. 
 # Default: undef
 #
+# [*health_check_interval*]
+# (optional) Specifies the interval that the health check command will execute in seconds.
+# Default: undef 
+#
 # [*restart_on_unhealthy*]
 # (optional) Checks the health status of Docker container and if it is unhealthy the service will be restarted.
 # The health_check_cmd parameter must be set to true to use this functionality.
@@ -121,6 +125,7 @@
   Optional[Boolean] $read_only                          = false,
   Optional[String]  $health_check_cmd                   = undef,
   Optional[Boolean] $restart_on_unhealthy               = false,
+  Optional[Integer] $health_check_interval              = undef,
 ) {
   include docker::params
   if ($socket_connect != []) {
@@ -193,6 +198,7 @@
     read_only             => $read_only,
     health_check_cmd      => $health_check_cmd,
     restart_on_unhealthy  => $restart_on_unhealthy,
+    health_check_interval => $health_check_interval,
   })
 
   $sanitised_title = regsubst($title, '[^0-9A-Za-z.\-_]', '-', 'G')

spec/defines/run_spec.rb

@@ -132,7 +132,8 @@
             'command' => 'command',
             'image'   => 'base',
             'health_check_cmd' => 'pwd',
-            'restart_on_unhealthy' => true
+            'restart_on_unhealthy' => true,
+            'health_check_interval' => 60,
           }}
           if (systemd)
             it { should contain_file(initscript).with_content(/ExecStop=-\/usr\/bin\/docker stop --time=0 /) }