Class: Docker::Container

Inherits:
Object
  • Object
show all
Includes:
Base
Defined in:
lib/docker/container.rb

Overview

This class represents a Docker Container. It’s important to note that nothing is cached so that the information is always up to date.

Instance Attribute Summary

Attributes included from Base

#connection, #id, #info

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Base

#initialize, #normalize_hash

Class Method Details

.all(opts = {}, conn = Docker.connection) ⇒ Object

Return all of the Containers.



342
343
344
345
 
# File 'lib/docker/container.rb', line 342

def self.all(opts = {}, conn = Docker.connection)
  hashes = Docker::Util.parse_json(conn.get('/containers/json', opts)) || []
  hashes.map { |hash| new(conn, hash) }
end

.create(opts = {}, conn = Docker.connection) ⇒ Object

Create a new Container.



326
327
328
329
330
331
332
 
# File 'lib/docker/container.rb', line 326

def self.create(opts = {}, conn = Docker.connection)
  query = opts.select {|key| ['name', :name].include?(key) }
  clean_opts = opts.reject {|key| ['name', :name].include?(key) }
  resp = conn.post('/containers/create', query, :body => MultiJson.dump(clean_opts))
  hash = Docker::Util.parse_json(resp) || {}
  new(conn, hash)
end

.get(id, opts = {}, conn = Docker.connection) ⇒ Object

Return the container with specified ID



335
336
337
338
339
 
# File 'lib/docker/container.rb', line 335

def self.get(id, opts = {}, conn = Docker.connection)
  container_json = conn.get("/containers/#{id}/json", opts)
  hash = Docker::Util.parse_json(container_json) || {}
  new(conn, hash)
end

.prune(conn = Docker.connection) ⇒ Object

Prune images



348
349
350
351
 
# File 'lib/docker/container.rb', line 348

def self.prune(conn = Docker.connection)
  conn.post("/containers/prune", {})
  nil
end

Instance Method Details

#archive_in(inputs, output_path, opts = {}) ⇒ Object 



278
279
280
281
282
283
284
 
# File 'lib/docker/container.rb', line 278

def archive_in(inputs, output_path, opts = {})
  file_hash = Docker::Util.file_hash_from_paths([*inputs])
  tar = StringIO.new(Docker::Util.create_tar(file_hash))
  archive_in_stream(output_path, opts) do
    tar.read(Excon.defaults[:chunk_size]).to_s
  end
end

#archive_in_stream(output_path, opts = {}, &block) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/docker/container.rb', line 286

def archive_in_stream(output_path, opts = {}, &block)
  overwrite = opts[:overwrite] || opts['overwrite'] || false

  connection.put(
    path_for(:archive),
    { 'path' => output_path, 'noOverwriteDirNonDir' => !overwrite },
    :headers => {
      'Content-Type' => 'application/x-tar'
    },
    &block
  )
  self
end

#archive_out(path, &block) ⇒ Object 



269
270
271
272
273
274
275
276
 
# File 'lib/docker/container.rb', line 269

def archive_out(path, &block)
  connection.get(
    path_for(:archive),
    { 'path' => path },
    :response_block => block
  )
  self
end

#attach(options = {}, excon_params = {}, &block) ⇒ Object

Attach to a container’s standard streams / logs.



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
 
# File 'lib/docker/container.rb', line 103

def attach(options = {}, excon_params = {}, &block)
  stdin = options.delete(:stdin)
  tty   = options.delete(:tty)

  opts = {
    :stream => true, :stdout => true, :stderr => true
  }.merge(options)
  # Creates list to store stdout and stderr messages
  msgs = Docker::Messages.new

  if stdin
    # If attaching to stdin, we must hijack the underlying TCP connection
    # so we can stream stdin to the remote Docker process
    opts[:stdin] = true
    excon_params[:hijack_block] = Docker::Util.hijack_for(stdin, block,
      msgs, tty)
  else
    excon_params[:response_block] = Docker::Util.attach_for(block, msgs, tty)
  end

  connection.post(
    path_for(:attach),
    opts,
    excon_params
  )
  [msgs.stdout_messages, msgs.stderr_messages]
end

#commit(options = {}) ⇒ Object

Create an Image from a Container’s change.s



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/docker/container.rb', line 132

def commit(options = {})
  options.merge!('container' => self.id[0..7])
  # [code](https://github.com/dotcloud/docker/blob/v0.6.3/commands.go#L1115)
  # Based on the link, the config passed as run, needs to be passed as the
  # body of the post so capture it, remove from the options, and pass it via
  # the post body
  config = MultiJson.dump(options.delete('run'))
  hash = Docker::Util.parse_json(
    connection.post('/commit', options, body: config)
  )
  Docker::Image.send(:new, self.connection, hash)
end

#exec(command, options = {}, &block) ⇒ Docker::Exec

Create an Exec instance inside the container



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
 
# File 'lib/docker/container.rb', line 55

def exec(command, options = {}, &block)
  # Establish values
  tty = options.delete(:tty) || false
  detach = options.delete(:detach) || false
  user = options.delete(:user)
  stdin = options.delete(:stdin)
  stdout = options.delete(:stdout) || !detach
  stderr = options.delete(:stderr) || !detach
  wait = options.delete(:wait)

  opts = {
    'Container' => self.id,
    'User' => user,
    'AttachStdin' => !!stdin,
    'AttachStdout' => stdout,
    'AttachStderr' => stderr,
    'Tty' => tty,
    'Cmd' => command
  }.merge(options)

  # Create Exec Instance
  instance = Docker::Exec.create(
    opts,
    self.connection
  )

  start_opts = {
    :tty => tty,
    :stdin => stdin,
    :detach => detach,
    :wait => wait
  }

  if detach
    instance.start!(start_opts)
    return instance
  else
    instance.start!(start_opts, &block)
  end
end

#export(&block) ⇒ Object

Export the Container as a tar.



97
98
99
100
 
# File 'lib/docker/container.rb', line 97

def export(&block)
  connection.get(path_for(:export), {}, :response_block => block)
  self
end

#kill!(opts = {}) ⇒ Object 



206
207
208
209
 
# File 'lib/docker/container.rb', line 206

def kill!(opts = {})
  connection.post(path_for(:kill), opts)
  self
end

#logs(opts = {}) ⇒ Object 



158
159
160
 
# File 'lib/docker/container.rb', line 158

def logs(opts = {})
  connection.get(path_for(:logs), opts)
end

#read_file(path) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/docker/container.rb', line 300

def read_file(path)
  content = StringIO.new
  archive_out(path) do |chunk|
    content.write chunk
  end

  content.rewind

  Gem::Package::TarReader.new(content) do |tar|
    tar.each do |tarfile|
      return tarfile.read
    end
  end
end

#refresh! ⇒ Object

Update the @info hash, which is the only mutable state in this object.

e.g. if you would like a live status from the #info hash, call #refresh! first.



8
9
10
11
12
13
14
15
16
 
# File 'lib/docker/container.rb', line 8

def refresh!
  other = Docker::Container.all({all: true}, connection).find { |c|
    c.id.start_with?(self.id) || self.id.start_with?(c.id)
  }

  info.merge!(self.json)
  other && info.merge!(other.info) { |key, info_value, other_value| info_value }
  self
end

#remove(options = {}) ⇒ Object Also known as: delete

remove container



248
249
250
251
 
# File 'lib/docker/container.rb', line 248

def remove(options = {})
  connection.delete("/containers/#{self.id}", options)
  nil
end

#rename(new_name) ⇒ Object 



181
182
183
184
185
 
# File 'lib/docker/container.rb', line 181

def rename(new_name)
  query = {}
  query['name'] = new_name
  connection.post(path_for(:rename), query)
end

#run(cmd, time = 1000) ⇒ Object

Given a command and an optional number of seconds to wait for the currently executing command, creates a new Container to run the specified command. If the command that is currently executing does not return a 0 status code, an UnexpectedResponseError is raised.



41
42
43
44
45
46
47
 
# File 'lib/docker/container.rb', line 41

def run(cmd, time = 1000)
  if (code = tap(&:start).wait(time)['StatusCode']).zero?
    commit.run(cmd)
  else
    raise UnexpectedResponseError, "Command returned status code #{code}."
  end
end

#start!(opts = {}) ⇒ Object 



201
202
203
204
 
# File 'lib/docker/container.rb', line 201

def start!(opts = {})
  connection.post(path_for(:start), {}, body: MultiJson.dump(opts))
  self
end

#stats(options = {}) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/docker/container.rb', line 162

def stats(options = {})
  if block_given?
    options[:read_timeout] ||= 10
    options[:idempotent] ||= false
    parser = lambda do |chunk, remaining_bytes, total_bytes|
      yield Docker::Util.parse_json(chunk)
    end
    begin
      connection.get(path_for(:stats), nil, {response_block: parser}.merge(options))
    rescue Docker::Error::TimeoutError
      # If the container stops, the docker daemon will hold the connection
      # open forever, but stop sending events.
      # So this Timeout indicates the stream is over.
    end
  else
    Docker::Util.parse_json(connection.get(path_for(:stats), {stream: 0}.merge(options)))
  end
end

#store_file(path, file_content) ⇒ Object 



315
316
317
318
319
320
321
322
323
 
# File 'lib/docker/container.rb', line 315

def store_file(path, file_content)
  output_io = StringIO.new(
    Docker::Util.create_tar(
      path => file_content
    )
  )

  archive_in_stream("/", overwrite: true) { output_io.read }
end

#streaming_logs(opts = {}, &block) ⇒ Object 



191
192
193
194
195
196
197
198
199
 
# File 'lib/docker/container.rb', line 191

def streaming_logs(opts = {}, &block)
  stack_size = opts.delete('stack_size') || opts.delete(:stack_size) || -1
  tty = opts.delete('tty') || opts.delete(:tty) || false
  msgs = Docker::MessagesStack.new(stack_size)
  excon_params = {response_block: Docker::Util.attach_for(block, msgs, tty), idempotent: false}

  connection.get(path_for(:logs), opts, excon_params)
  msgs.messages.join
end

#to_s ⇒ Object

Return a String representation of the Container.



146
147
148
 
# File 'lib/docker/container.rb', line 146

def to_s
  "Docker::Container { :id => #{self.id}, :connection => #{self.connection} }"
end

#top(opts = {}) ⇒ Object

Return a List of Hashes that represents the top running processes.



19
20
21
22
23
24
25
26
27
 
# File 'lib/docker/container.rb', line 19

def top(opts = {})
  format = opts.delete(:format) { :array }
  resp = Docker::Util.parse_json(connection.get(path_for(:top), opts))
  if resp['Processes'].nil?
    format == :array ? [] : {}
  else
    format == :array ? resp['Processes'].map { |ary| Hash[resp['Titles'].zip(ary)] } : resp
  end
end

#update(opts) ⇒ Object 



187
188
189
 
# File 'lib/docker/container.rb', line 187

def update(opts)
  connection.post(path_for(:update), {}, body: MultiJson.dump(opts))
end

#wait(time = nil) ⇒ Object

Wait for the current command to finish executing. Default wait time is ‘Excon.options`.



31
32
33
34
35
 
# File 'lib/docker/container.rb', line 31

def wait(time = nil)
  excon_params = { :read_timeout => time }
  resp = connection.post(path_for(:wait), nil, excon_params)
  Docker::Util.parse_json(resp)
end