Defined Type: docker::container

Defined in:
manifests/container.pp

Overview

Definition: docker::container

This class installs docker containers using a custom provider for service.

Requires docker version >=1.3.1

Parameters: Required parameters:

  • image - docker image name with optional tag “ubuntu:14.04”

Option parameters:

  • See ‘docker create’ options:

    http://docs.docker.com/reference/commandline/cli/#create
    
  • Accepts most options documented.

  • If an option is not avalible you can pass in additonal options with extra_parameters => [ ‘–option=foo’, ‘–other=bar’ ]

Yes this is a total cop out on the docs, but docker options are a fast moving target.

Actions:

Writes a “config” file to /etc/docker/$title.config with the various docker options, then creates a service with the provider “docker” to start, stop and maintain the container. The Service: enable => true - ‘docker create $title’ enable => false - ‘docker rm $title’ ensure => running - ‘docker start $title’ ensure => stopped - ‘docker stop $title’ refresh action - stop, rm, create, start

Requires:

  • docker class

Sample Usage:

require docker

docker::container { 'logspout':
  image    => 'progrium/logspout',
  command  => "syslog://logs.example.com:22000",
  volume   => [ '/var/run/docker.sock:/tmp/docker.sock' ],
  publish  => [ '127.0.0.1:8000:8000' ],
  hostname => $::fqdn,
  dns      => [ '8.8.8.8', '8.8.4.4' ],
}

Parameters:

  • image (Any)
  • ensure (Any) (defaults to: 'present')
  • attach (Any) (defaults to: [])
  • add_host (Any) (defaults to: [])
  • blkio_weight (Any) (defaults to: undef)
  • cap_add (Any) (defaults to: [])
  • cap_drop (Any) (defaults to: [])
  • cgroup_parent (Any) (defaults to: undef)
  • command (Any) (defaults to: undef)
  • cpu_period (Any) (defaults to: undef)
  • cpu_quota (Any) (defaults to: undef)
  • cpu_set (Any) (defaults to: undef)
  • cpuset_cpus (Any) (defaults to: undef)
  • cpuset_mems (Any) (defaults to: undef)
  • cpu_shares (Any) (defaults to: undef)
  • device (Any) (defaults to: [])
  • disable_content_trust (Any) (defaults to: true)
  • dns (Any) (defaults to: [])
  • dns_opt (Any) (defaults to: [])
  • dns_search (Any) (defaults to: [])
  • env (Any) (defaults to: [])
  • entrypoint (Any) (defaults to: undef)
  • env_file (Any) (defaults to: [])
  • expose (Any) (defaults to: [])
  • extra_parameters (Any) (defaults to: [])
  • hostname (Any) (defaults to: undef)
  • interactive (Any) (defaults to: false)
  • ipc (Any) (defaults to: undef)
  • kernel_memory (Any) (defaults to: undef)
  • label (Any) (defaults to: [])
  • lable_file (Any) (defaults to: [])
  • link (Any) (defaults to: [])
  • log_driver (Any) (defaults to: undef)
  • log_opt (Any) (defaults to: [])
  • lxc_conf (Any) (defaults to: [])
  • mac_address (Any) (defaults to: undef)
  • memory (Any) (defaults to: undef)
  • memory_limit (Any) (defaults to: undef)
  • memory_reservation (Any) (defaults to: undef)
  • memory_swap (Any) (defaults to: undef)
  • memory_swappiness (Any) (defaults to: undef)
  • net (Any) (defaults to: undef)
  • oom_kill_disable (Any) (defaults to: false)
  • pid (Any) (defaults to: undef)
  • publish (Any) (defaults to: [])
  • publish_all (Any) (defaults to: false)
  • privileged (Any) (defaults to: false)
  • read_only (Any) (defaults to: false)
  • restart (Any) (defaults to: 'always')
  • security_opt (Any) (defaults to: [])
  • stop_signal (Any) (defaults to: undef)
  • tty (Any) (defaults to: false)
  • ulimit (Any) (defaults to: [])
  • user (Any) (defaults to: undef)
  • uts (Any) (defaults to: undef)
  • volume (Any) (defaults to: [])
  • volumes_from (Any) (defaults to: [])
  • volume_driver (Any) (defaults to: undef)
  • workdir (Any) (defaults to: undef)


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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'manifests/container.pp', line 47

define docker::container (
  $image,
  $ensure = 'present',
  $attach = [],
  $add_host = [],
  $blkio_weight = undef,
  $cap_add = [],
  $cap_drop = [],
  $cgroup_parent = undef,
  $command = undef,
  $cpu_period = undef,
  $cpu_quota = undef,
  $cpu_set = undef,
  $cpuset_cpus = undef,
  $cpuset_mems = undef,
  $cpu_shares = undef,
  $device = [],
  $disable_content_trust = true,
  $dns = [],
  $dns_opt = [],
  $dns_search = [],
  $env = [],
  $entrypoint = undef,
  $env_file = [],
  $expose = [],
  $extra_parameters = [],
  $hostname = undef,
  $interactive = false,
  $ipc = undef,
  $kernel_memory = undef,
  $label = [],
  $lable_file = [],
  $link = [],
  $log_driver = undef,
  $log_opt = [],
  $lxc_conf = [],
  $mac_address = undef,
  $memory = undef,
  $memory_limit = undef,
  $memory_reservation = undef,
  $memory_swap = undef,
  $memory_swappiness = undef,
  $net = undef,
  $oom_kill_disable = false,
  $pid = undef,
  $publish = [],
  $publish_all = false,
  $privileged = false,
  $read_only = false,
  $restart = 'always',
  $security_opt = [],
  $stop_signal = undef,
  $tty = false,
  $ulimit = [],
  $user = undef,
  $uts = undef,
  $volume = [],
  $volumes_from = [],
  $volume_driver = undef,
  $workdir = undef,
) {

  validate_array($attach)
  validate_array($add_host)
  validate_string($blkio_weight)   #new docker 1.7.0
  validate_array($cap_add)
  validate_array($cap_drop)
  validate_string($cgroup_parent)  #new docker 1.6.0
  #cidfile not needed
  validate_string($command)
  validate_string($cpu_set)        #deprecated 1.6.0
  validate_string($cpuset_cpus)    #new docker 1.6.0
  validate_string($cpuset_mems)    #new docker 1.9.0
  validate_string($cpu_period)     #new docker 1.7.0
  validate_string($cpu_quota)      #new docker 1.7.0
  validate_string($cpu_shares)
  validate_array($device)
  validate_bool($disable_content_trust) #new docker 1.9.0
  validate_array($dns)
  validate_array($dns_opt)         #new docker 1.9.0
  validate_array($dns_search)
  validate_array($env)
  validate_string($entrypoint)
  validate_array($env_file)
  validate_array($expose)
  validate_string($hostname)
  validate_bool($interactive)
  validate_string($ipc)            #new docker 1.6.0
  validate_string($kernel_memory)  #new docker 1.9.0
  validate_array($label)           #new docker 1.6.0
  validate_array($lable_file)      #new docker 1.6.0
  validate_string($image)
  validate_array($link)
  validate_string($log_driver)     #new docker 1.6.0
  validate_array($log_opt)         #new docker 1.7.0
  validate_array($lxc_conf)
  validate_string($mac_address)    #new docker 1.6.0
  validate_string($memory)         #new docker 1.6.0
  validate_string($memory_limit)   #deprecated 1.6.0
  validate_string($memory_reservation) #new docker 1.9.0
  validate_string($memory_swap)    #new docker 1.6.0
  validate_string($memory_swappiness) #new docker 1.9.0
  #name is always defined as title
  validate_string($net)
  validate_bool($oom_kill_disable) #new docker 1.7.0
  validate_string($pid)
  validate_array($publish)
  validate_bool($publish_all)
  validate_bool($privileged)
  validate_bool($read_only)        #new docker 1.6.0
  validate_string($restart)
  validate_array($security_opt)
  validate_string($stop_signal)    #new docker 1.9.0
  validate_bool($tty)
  validate_array($ulimit)          #new docker 1.6.0
  validate_string($user)
  validate_string($uts)            #new docker 1.7.0
  validate_array($volume)
  validate_string($volume_driver)  #new docker 1.9.0
  validate_array($volumes_from)
  validate_string($workdir)

  #Other params that docker create might add
  validate_array($extra_parameters)

  $config_dir = '/etc/docker'
  $config_file = "${config_dir}/${title}.config"

  if ($ensure == 'present'){
    if (! defined(File[$config_dir])) {
      file { $config_dir:
        ensure => directory,
      }
    }
    file { $config_file:
      ensure  => file,
      mode    => '0600',
      content => template('docker/etc/docker/docker.config.erb'),
      require => File[$config_dir],
      notify  => Service[$title],
    }
    service { $title:
      ensure   => running,
      enable   => true,
      provider => 'docker',
      manifest => $config_file,
      require  => File[$config_file],
    }
  }
  if ($ensure == 'absent') {
    file{ $config_file:
      ensure => absent
    }
    service { $title:
      enable   => false,
      provider => 'docker',
    }
  }
}