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, Exec, Image, ImageTask, Messages
Constant Summary collapse
- VERSION =
The version of the docker-api gem.
'1.19.0'
- API_VERSION =
The version of the compatible Docker remote API.
'1.16'
Class Method Summary collapse
-
.authenticate!(options = {}, connection = self.connection) ⇒ Object
Login to the Docker registry.
- .connection ⇒ Object
-
.creds ⇒ Object
Returns the value of attribute creds.
-
.creds=(value) ⇒ Object
Sets the attribute creds.
- .default_socket_url ⇒ Object
- .env_options ⇒ Object
- .env_url ⇒ Object
-
.info(connection = self.connection) ⇒ Object
Get more information about the Docker server.
-
.logger ⇒ Object
Returns the value of attribute logger.
-
.logger=(value) ⇒ Object
Sets the attribute logger.
- .options ⇒ Object
- .options=(new_options) ⇒ Object
- .reset! ⇒ Object
- .reset_connection! ⇒ Object
- .url ⇒ Object
- .url=(new_url) ⇒ Object
-
.validate_version! ⇒ Object
When the correct version of Docker is installed, returns true.
-
.version(connection = self.connection) ⇒ Object
Get the version of Go, Docker, and optionally the Git commit.
Class Method Details
.authenticate!(options = {}, connection = self.connection) ⇒ Object
Login to the Docker registry.
103 104 105 106 107 108 109 110 |
# File 'lib/docker.rb', line 103 def authenticate!( = {}, connection = self.connection) creds = .to_json connection.post('/auth', {}, :body => creds) @creds = creds true rescue Docker::Error::ServerError, Docker::Error::UnauthorizedError raise Docker::Error::AuthenticationError end |
.connection ⇒ Object
78 79 80 |
# File 'lib/docker.rb', line 78 def connection @connection ||= Connection.new(url, ) 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
20 21 22 |
# File 'lib/docker.rb', line 20 def creds=(value) @creds = value end |
.default_socket_url ⇒ Object
34 35 36 |
# File 'lib/docker.rb', line 34 def default_socket_url 'unix:///var/run/docker.sock' end |
.env_options ⇒ Object
42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/docker.rb', line 42 def if cert_path = ENV['DOCKER_CERT_PATH'] { client_cert: File.join(cert_path, 'cert.pem'), client_key: File.join(cert_path, 'key.pem'), ssl_ca_file: File.join(cert_path, 'ca.pem'), scheme: 'https' } else {} end end |
.env_url ⇒ Object
38 39 40 |
# File 'lib/docker.rb', line 38 def env_url ENV['DOCKER_URL'] || ENV['DOCKER_HOST'] end |
.info(connection = self.connection) ⇒ Object
Get more information about the Docker server.
98 99 100 |
# File 'lib/docker.rb', line 98 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
20 21 22 |
# File 'lib/docker.rb', line 20 def logger=(value) @logger = value end |
.options ⇒ Object
64 65 66 |
# File 'lib/docker.rb', line 64 def @options ||= end |
.options=(new_options) ⇒ Object
73 74 75 76 |
# File 'lib/docker.rb', line 73 def () @options = .merge( || {}) reset_connection! end |
.reset! ⇒ Object
82 83 84 85 86 |
# File 'lib/docker.rb', line 82 def reset! @url = nil @options = nil reset_connection! end |
.reset_connection! ⇒ Object
88 89 90 |
# File 'lib/docker.rb', line 88 def reset_connection! @connection = nil end |
.url ⇒ Object
55 56 57 58 59 60 61 62 |
# File 'lib/docker.rb', line 55 def url @url ||= env_url || 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
68 69 70 71 |
# File 'lib/docker.rb', line 68 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.
114 115 116 117 118 119 |
# File 'lib/docker.rb', line 114 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.
93 94 95 |
# File 'lib/docker.rb', line 93 def version(connection = self.connection) Util.parse_json(connection.get('/version')) end |