Module: Docker

Defined in:
lib/docker.rb,
lib/docker/version.rb

Overview

The top-level module for this gem. It’s purpose is to hold global configuration variables that are used as defaults in other classes.

Defined Under Namespace

Modules: Error, Util Classes: Connection, Container, Image

Constant Summary collapse

VERSION =

The version of the docker-api gem.

'1.5.4'
API_VERSION =

The version of the compatible Docker remote API.

'1.4'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#creds ⇒ Object (readonly)

Returns the value of attribute creds.



11
12
13
 
# File 'lib/docker.rb', line 11

def creds
  @creds
end

Class Method Details

.authenticate!(options = {}) ⇒ Object

Login to the Docker registry.



51
52
53
54
55
 
# File 'lib/docker.rb', line 51

def authenticate!(options = {})
  @creds = options.to_json
  connection.post(:path => '/auth', :body => @creds)
  true
end

.connection ⇒ Object 



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

def connection
  @connection ||= Connection.new(url, options)
end

.info ⇒ Object

Get more information about the Docker server.



46
47
48
 
# File 'lib/docker.rb', line 46

def info
  Util.parse_json(connection.get('/info'))
end

.options ⇒ Object 



17
18
19
20
 
# File 'lib/docker.rb', line 17

def options
  port = (ENV['DOCKER_PORT'].nil? ? 4243 : ENV['DOCKER_PORT']).to_i
  @options ||= { :port => port.to_i }
end

.options=(new_options) ⇒ Object 



27
28
29
30
 
# File 'lib/docker.rb', line 27

def options=(new_options)
  @options = { :port => 4243 }.merge(new_options)
  reset_connection!
end

.reset_connection! ⇒ Object 



36
37
38
 
# File 'lib/docker.rb', line 36

def reset_connection!
  @connection = nil
end

.url ⇒ Object 



13
14
15
 
# File 'lib/docker.rb', line 13

def url
  @url ||= "http://#{ENV['DOCKER_HOST'] || 'localhost'}"
end

.url=(new_url) ⇒ Object 



22
23
24
25
 
# File 'lib/docker.rb', line 22

def url=(new_url)
  @url = new_url
  reset_connection!
end

.validate_version! ⇒ Object

When the correct version of Docker is installed, returns true. Otherwise, raises a VersionError.



59
60
61
62
63
64
 
# File 'lib/docker.rb', line 59

def validate_version!
  Docker.info
  true
rescue Docker::Error::DockerError
  raise Docker::Error::VersionError, "Expected API Version: #{API_VERSION}"
end

.version ⇒ Object

Get the version of Go, Docker, and optionally the Git commit.



41
42
43
 
# File 'lib/docker.rb', line 41

def version
  Util.parse_json(connection.get('/version'))
end