Defined Type: docker::exec

Defined in:
manifests/exec.pp

Summary

A define which executes a command inside a container.

Overview

Parameters:

  • detach (Boolean) (defaults to: false)
  • interactive (Boolean) (defaults to: false)
  • env (Array) (defaults to: [])
  • tty (Boolean) (defaults to: false)
  • container (Optional[String]) (defaults to: undef)
  • command (Optional[String]) (defaults to: undef)
  • unless (Optional[String]) (defaults to: undef)
  • sanitise_name (Boolean) (defaults to: true)
  • refreshonly (Boolean) (defaults to: false)
  • onlyif (Optional[String]) (defaults to: undef) 


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'manifests/exec.pp', line 15

define docker::exec (
  Boolean $detach               = false,
  Boolean $interactive          = false,
  Array   $env                  = [],
  Boolean $tty                  = false,
  Optional[String]  $container  = undef,
  Optional[String]  $command    = undef,
  Optional[String]  $unless     = undef,
  Boolean $sanitise_name        = true,
  Boolean $refreshonly          = false,
  Optional[String]  $onlyif     = undef,
) {
  include docker::params

  $docker_command = $docker::params::docker_command

  if $facts['os']['family'] == 'windows' {
    $exec_environment = "PATH=${facts['docker_program_files_path']}/Docker/"
    $exec_timeout     = 3000
    $exec_path        = ["${facts['docker_program_files_path']}/Docker/",]
    $exec_provider    = 'powershell'
  } else {
    $exec_environment = 'HOME=/root'
    $exec_path        = ['/bin', '/usr/bin',]
    $exec_timeout     = 0
    $exec_provider    = undef
  }

  $docker_exec_flags = docker_exec_flags({
      detach      => $detach,
      interactive => $interactive,
      tty         => $tty,
      env         => any2array($env),
    }
  )

  if $sanitise_name {
    $sanitised_container = regsubst($container, '[^0-9A-Za-z.\-_]', '-', 'G')
  } else {
    $sanitised_container = $container
  }

  $exec = "${docker_command} exec ${docker_exec_flags} ${sanitised_container} ${command}"

  $unless_command = $unless ? {
    undef   => undef,
    ''      => undef,
    default => "${docker_command} exec ${docker_exec_flags} ${sanitised_container} ${$unless}",
  }

  $onlyif_command = $onlyif ? {
    undef     => undef,
    ''        => undef,
    'running' => "${docker_command} ps --no-trunc --format='table {{.Names}}' | grep '^${sanitised_container}$'",
    default   => $onlyif
  }

  exec { $exec:
    environment => $exec_environment,
    onlyif      => $onlyif_command,
    path        => $exec_path,
    refreshonly => $refreshonly,
    timeout     => $exec_timeout,
    provider    => $exec_provider,
    unless      => $unless_command,
  }
}