The top-level module for this gem. It's purpose is to hold global configuration variables that are used as defaults in other classes.
The version of the compatible Docker remote API.
The version of the docker-api gem.
Login to the Docker registry.
# File lib/docker.rb, line 103 def authenticate!(options = {}, connection = connection) creds = options.to_json connection.post('/auth', {}, :body => creds) @creds = creds true rescue Docker::Error::ServerError, Docker::Error::UnauthorizedError raise Docker::Error::AuthenticationError end
# File lib/docker.rb, line 78 def connection @connection ||= Connection.new(url, options) end
# File lib/docker.rb, line 34 def default_socket_url 'unix:///var/run/docker.sock' end
# File lib/docker.rb, line 42 def env_options 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
# File lib/docker.rb, line 38 def env_url ENV['DOCKER_URL'] || ENV['DOCKER_HOST'] end
Get more information about the Docker server.
# File lib/docker.rb, line 98 def info(connection = self.connection) Util.parse_json(connection.get('/info')) end
# File lib/docker.rb, line 64 def options @options ||= env_options end
# File lib/docker.rb, line 73 def options=(new_options) @options = env_options.merge(new_options || {}) reset_connection! end
# File lib/docker.rb, line 82 def reset! @url = nil @options = nil reset_connection! end
# File lib/docker.rb, line 88 def reset_connection! @connection = nil end
# 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
# File lib/docker.rb, line 68 def url=(new_url) @url = new_url reset_connection! end
When the correct version of Docker is installed, returns true. Otherwise, raises a VersionError.
# 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
Get the version of Go, Docker, and optionally the Git commit.
# File lib/docker.rb, line 93 def version(connection = self.connection) Util.parse_json(connection.get('/version')) end
Generated with the Darkfish Rdoc Generator 2.