Class: Docker::Image
Overview
This class represents a Docker Image.
Instance Attribute Summary
Attributes inherited from Base
Class Method Summary collapse
-
.all(opts = {}, conn = Docker.connection) ⇒ Object
Return every Image.
-
.build(commands, opts = {}, connection = Docker.connection, &block) ⇒ Object
Given a Dockerfile as a string, builds an Image.
-
.build_from_dir(dir, opts = {}, connection = Docker.connection, &block) ⇒ Object
Given a directory that contains a Dockerfile, builds an Image.
-
.create(opts = {}, creds = nil, conn = Docker.connection) ⇒ Object
Create a new Image.
-
.get(id, opts = {}, conn = Docker.connection) ⇒ Object
Return a specific image.
-
.import(file, options = {}, connection = Docker.connection) ⇒ Object
Import an Image from the output of Docker::Container#export.
-
.search(query = {}, connection = Docker.connection) ⇒ Object
Given a query like ‘{ :term => ’sshd’ }‘, queries the Docker Registry for a corresponding Image.
Instance Method Summary collapse
-
#insert(query = {}) ⇒ Object
Insert a file into the Image, returns a new Image that has that file.
-
#insert_local(opts = {}) ⇒ Object
Given a path of a local file and the path it should be inserted, creates a new Image that has that file.
-
#push(creds = nil, options = {}) ⇒ Object
Push the Image to the Docker registry.
-
#remove ⇒ Object
(also: #delete)
Remove the Image from the server.
-
#run(cmd = nil) ⇒ Object
Given a command and optional list of streams to attach to, run a command on an Image.
-
#tag(opts = {}) ⇒ Object
Tag the Image.
-
#to_s ⇒ Object
Return a String representation of the Image.
Methods inherited from Base
Constructor Details
This class inherits a constructor from Docker::Base
Class Method Details
.all(opts = {}, conn = Docker.connection) ⇒ Object
Return every Image.
118 119 120 121 |
# File 'lib/docker/image.rb', line 118 def all(opts = {}, conn = Docker.connection) hashes = Docker::Util.parse_json(conn.get('/images/json', opts)) || [] hashes.map { |hash| new(conn, hash) } end |
.build(commands, opts = {}, connection = Docker.connection, &block) ⇒ Object
Given a Dockerfile as a string, builds an Image.
145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/docker/image.rb', line 145 def build(commands, opts = {}, connection = Docker.connection, &block) body = "" connection.post( '/build', opts, :body => Docker::Util.create_tar('Dockerfile' => commands), :response_block => response_block_for_build(body, &block) ) new(connection, 'id' => Docker::Util.extract_id(body)) rescue Docker::Error::ServerError raise Docker::Error::UnexpectedResponseError end |
.build_from_dir(dir, opts = {}, connection = Docker.connection, &block) ⇒ Object
Given a directory that contains a Dockerfile, builds an Image.
If a block is passed, chunks of output produced by Docker will be passed to that block.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/docker/image.rb', line 161 def build_from_dir(dir, opts = {}, connection = Docker.connection, &block) tar = Docker::Util.create_dir_tar(dir) # The response_block passed to Excon will build up this body variable. body = "" connection.post( '/build', opts, :headers => { 'Content-Type' => 'application/tar', 'Transfer-Encoding' => 'chunked' }, :response_block => response_block_for_build(body, &block) ) { tar.read(Excon.defaults[:chunk_size]).to_s } new(connection, 'id' => Docker::Util.extract_id(body)) ensure tar.close unless tar.nil? end |
.create(opts = {}, creds = nil, conn = Docker.connection) ⇒ Object
Create a new Image.
98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/docker/image.rb', line 98 def create(opts = {}, creds = nil, conn = Docker.connection) credentials = (creds.nil?) ? creds.to_json : Docker.creds headers = if credentials.nil? Docker::Util.build_auth_header(credentials) else {} end body = conn.post('/images/create', opts) id = Docker::Util.fix_json(body).last['id'] new(conn, 'id' => id, :headers => headers) end |
.get(id, opts = {}, conn = Docker.connection) ⇒ Object
Return a specific image.
111 112 113 114 115 |
# File 'lib/docker/image.rb', line 111 def get(id, opts = {}, conn = Docker.connection) image_json = conn.get("/images/#{URI.encode(id)}/json", opts) hash = Docker::Util.parse_json(image_json) || {} new(conn, hash) end |
.import(file, options = {}, connection = Docker.connection) ⇒ Object
Import an Image from the output of Docker::Container#export.
132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/docker/image.rb', line 132 def import(file, = {}, connection = Docker.connection) File.open(file, 'r') do |io| body = connection.post( '/images/create', .merge('fromSrc' => '-'), :headers => { 'Content-Type' => 'application/tar', 'Transfer-Encoding' => 'chunked' } ) { io.read(Excon.defaults[:chunk_size]).to_s } new(connection, 'id'=> Docker::Util.parse_json(body)['status']) end end |
.search(query = {}, connection = Docker.connection) ⇒ Object
Given a query like ‘{ :term => ’sshd’ }‘, queries the Docker Registry for a corresponding Image.
125 126 127 128 129 |
# File 'lib/docker/image.rb', line 125 def search(query = {}, connection = Docker.connection) body = connection.get('/images/search', query) hashes = Docker::Util.parse_json(body) || [] hashes.map { |hash| new(connection, 'id' => hash['name']) } end |
Instance Method Details
#insert(query = {}) ⇒ Object
Insert a file into the Image, returns a new Image that has that file.
49 50 51 52 53 54 55 56 |
# File 'lib/docker/image.rb', line 49 def insert(query = {}) body = connection.post(path_for(:insert), query) if id = Docker::Util.fix_json(body).last['status'] self.class.send(:new, connection, 'id' => id) else raise UnexpectedResponseError, "Could not find Id in '#{body}'" end end |
#insert_local(opts = {}) ⇒ Object
Given a path of a local file and the path it should be inserted, creates a new Image that has that file.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/docker/image.rb', line 60 def insert_local(opts = {}) local_paths = opts.delete('localPath') output_path = opts.delete('outputPath') local_paths = [ local_paths ] unless local_paths.is_a?(Array) file_hash = Docker::Util.file_hash_from_paths(local_paths) file_hash['Dockerfile'] = dockerfile_for(file_hash, output_path) tar = Docker::Util.create_tar(file_hash) body = connection.post('/build', opts, :body => tar) self.class.send(:new, connection, 'id' => Docker::Util.extract_id(body)) end |
#push(creds = nil, options = {}) ⇒ Object
Push the Image to the Docker registry.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/docker/image.rb', line 24 def push(creds = nil, = {}) repository = self.info['RepoTags'].first.split(/:/)[0] rescue nil raise ArgumentError, "Image does not have a name to push." unless repository credentials = creds || Docker.creds headers = Docker::Util.build_auth_header(credentials) connection.post( "/images/#{repository}/push", , :headers => headers ) self end |
#remove ⇒ Object Also known as: delete
Remove the Image from the server.
76 77 78 |
# File 'lib/docker/image.rb', line 76 def remove connection.delete("/images/#{self.id}") end |
#run(cmd = nil) ⇒ Object
Given a command and optional list of streams to attach to, run a command on an Image. This will not modify the Image, but rather create a new Container to run the Image. If the image has an embedded config, no command is necessary, but it will fail with 500 if no config is saved with the image
8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
# File 'lib/docker/image.rb', line 8 def run(cmd=nil) opts = { 'Image' => self.id } opts["Cmd"] = cmd.is_a?(String) ? cmd.split(/\s+/) : cmd begin Docker::Container.create(opts, connection) .tap(&:start!) rescue ServerError => ex if cmd raise ex else raise ServerError, "No command specified." end end end |
#tag(opts = {}) ⇒ Object
Tag the Image.
40 41 42 43 44 45 46 |
# File 'lib/docker/image.rb', line 40 def tag(opts = {}) self.info['RepoTags'] ||= [] connection.post(path_for(:tag), opts) repo = opts['repo'] || opts[:repo] tag = opts['tag'] || opts[:tag] || 'latest' self.info['RepoTags'] << "#{repo}:#{tag}" end |
#to_s ⇒ Object
Return a String representation of the Image.
82 83 84 85 |
# File 'lib/docker/image.rb', line 82 def to_s "Docker::Image { :id => #{self.id}, :info => #{self.info.inspect}, "\ ":connection => #{self.connection} }" end |