Class Docker::Container
In: lib/docker/container.rb
Parent: Object

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

Methods

all   archive_in   archive_in_stream   archive_out   attach   commit   copy   create   delete   exec   export   get   kill!   logs   prune   read_file   refresh!   remove   rename   run   start!   stats   store_file   streaming_logs   to_s   top   update   wait  

Included Modules

Docker::Base

Public Class methods

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

Return the container with specified ID

Public Instance methods

attach(options = {}, excon_params = {}, &block)

Attach to a container‘s standard streams / logs.

commit(options = {})

Create an Image from a Container‘s change.s

delete(options = {})

Alias for remove

exec(command, options = {}, &block)

Create an Exec instance inside the container

@param command [String, Array] The command to run inside the Exec instance @param options [Hash] The options to pass to Docker::Exec

@return [Docker::Exec] The Exec instance

export(&block)

Export the Container as a tar.

refresh!()

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.
run(cmd, time = 1000)

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.

to_s()

Return a String representation of the Container.

top(opts = {})

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

wait(time = nil)

Wait for the current command to finish executing. Default wait time is `Excon.options[:read_timeout]`.

[Validate]