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: Base, Error, Util Classes: Connection, Container, Event, Image, ImageTask, Messages

Constant Summary collapse

VERSION =

The version of the docker-api gem.

'1.13.3'
API_VERSION =

The version of the compatible Docker remote API.

'1.12'

Class Method Summary collapse

Class Method Details

.authenticate!(options = {}) ⇒ Object

Login to the Docker registry.



83
84
85
86
87
88
89
90
 
# File 'lib/docker.rb', line 83

def authenticate!(options = {})
  creds = options.to_json
  connection.post('/auth', {}, :body => creds)
  @creds = creds
  true
rescue Docker::Error::ServerError, Docker::Error::UnauthorizedError
  raise Docker::Error::AuthenticationError
end

.connection ⇒ Object 



64
65
66
 
# File 'lib/docker.rb', line 64

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

.creds ⇒ Object

Returns the value of attribute creds.



20
21
22
 
# File 'lib/docker.rb', line 20

def creds
  @creds
end

.creds=(value) ⇒ Object

Sets the attribute creds

Parameters:

  • value —

    the value to set the attribute creds to.



20
21
22
 
# File 'lib/docker.rb', line 20

def creds=(value)
  @creds = value
end

.default_socket_url ⇒ Object 



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

def default_socket_url
  'unix:///var/run/docker.sock'
end

.env_url ⇒ Object 



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

def env_url
  ENV['DOCKER_URL']
end

.info(connection = self.connection) ⇒ Object

Get more information about the Docker server.



78
79
80
 
# File 'lib/docker.rb', line 78

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

.logger ⇒ Object

Returns the value of attribute logger.



20
21
22
 
# File 'lib/docker.rb', line 20

def logger
  @logger
end

.logger=(value) ⇒ Object

Sets the attribute logger

Parameters:

  • value —

    the value to set the attribute logger to.



20
21
22
 
# File 'lib/docker.rb', line 20

def logger=(value)
  @logger = value
end

.options ⇒ Object 



50
51
52
 
# File 'lib/docker.rb', line 50

def options
  @options ||= {}
end

.options=(new_options) ⇒ Object 



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

def options=(new_options)
  @options = new_options
  reset_connection!
end

.reset_connection! ⇒ Object 



68
69
70
 
# File 'lib/docker.rb', line 68

def reset_connection!
  @connection = nil
end

.url ⇒ Object 



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

def url
  @url ||= ENV['DOCKER_URL'] || ENV['DOCKER_HOST'] || default_socket_url
  # docker uses a default notation tcp:// which means tcp://localhost:2375
  if @url == 'tcp://'
    @url = 'tcp://localhost:2375'
  end
  @url
end

.url=(new_url) ⇒ Object 



54
55
56
57
 
# File 'lib/docker.rb', line 54

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.



94
95
96
97
98
99
 
# File 'lib/docker.rb', line 94

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

.version(connection = self.connection) ⇒ Object

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



73
74
75
 
# File 'lib/docker.rb', line 73

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