-
Notifications
You must be signed in to change notification settings - Fork 288
/
image.rb
374 lines (323 loc) · 11.8 KB
/
image.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# This class represents a Docker Image.
class Docker::Image
include Docker::Base
# 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
def run(cmd = nil, options = {})
opts = {'Image' => self.id}.merge(options)
opts["Cmd"] = cmd.is_a?(String) ? cmd.split(/\s+/) : cmd
begin
Docker::Container.create(opts, connection)
.tap(&:start!)
rescue ServerError, ClientError => ex
if cmd
raise ex
else
raise ex, "No command specified."
end
end
end
# Push the Image to the Docker registry.
def push(creds = nil, options = {}, &block)
repo_tag = options.delete(:repo_tag) || ensure_repo_tags.first
raise ArgumentError, "Image is untagged" if repo_tag.nil?
repo, tag = Docker::Util.parse_repo_tag(repo_tag)
raise ArgumentError, "Image does not have a name to push." if repo.nil?
body = ""
credentials = creds || Docker.creds || {}
headers = Docker::Util.build_auth_header(credentials)
opts = {:tag => tag}.merge(options)
connection.post("/images/#{repo}/push", opts, :headers => headers,
:response_block => self.class.response_block(body, &block))
self
end
# Tag the Image.
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
# Given a path of a local file and the path it should be inserted, creates
# a new Image that has that file.
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
# Remove the Image from the server.
def remove(opts = {})
name = opts.delete(:name)
unless name
if ::Docker.podman?(connection)
name = self.id.split(':').last
else
name = self.id
end
end
connection.delete("/images/#{name}", opts)
end
alias_method :delete, :remove
# Return a String representation of the Image.
def to_s
"Docker::Image { :id => #{self.id}, :info => #{self.info.inspect}, "\
":connection => #{self.connection} }"
end
# #json returns extra information about an Image, #history returns its
# history.
[:json, :history].each do |method|
define_method(method) do |opts = {}|
Docker::Util.parse_json(connection.get(path_for(method), opts))
end
end
# Save the image as a tarball
def save(filename = nil)
self.class.save(self.id, filename, connection)
end
# Save the image as a tarball to an IO object.
def save_stream(opts = {}, &block)
self.class.save_stream(self.id, opts, connection, &block)
end
# Update the @info hash, which is the only mutable state in this object.
def refresh!
img = Docker::Image.all({:all => true}, connection).find { |image|
image.id.start_with?(self.id) || self.id.start_with?(image.id)
}
info.merge!(self.json)
img && info.merge!(img.info)
self
end
class << self
# Create a new Image.
def create(opts = {}, creds = nil, conn = Docker.connection, &block)
credentials = creds.nil? ? Docker.creds : MultiJson.dump(creds)
headers = credentials && Docker::Util.build_auth_header(credentials) || {}
body = ''
conn.post(
'/images/create',
opts,
:headers => headers,
:response_block => response_block(body, &block)
)
# NOTE: see associated tests for why we're looking at image#end_with?
image = opts['fromImage'] || opts[:fromImage]
tag = opts['tag'] || opts[:tag]
image = "#{image}:#{tag}" if tag && !image.end_with?(":#{tag}")
get(image, {}, conn)
end
# Return a specific image.
def get(id, opts = {}, conn = Docker.connection)
image_json = conn.get("/images/#{id}/json", opts)
hash = Docker::Util.parse_json(image_json) || {}
new(conn, hash)
end
# Delete a specific image
def remove(id, opts = {}, conn = Docker.connection)
conn.delete("/images/#{id}", opts)
end
alias_method :delete, :remove
# Prune images
def prune(conn = Docker.connection)
conn.post("/images/prune", {})
end
# Save the raw binary representation or one or more Docker images
#
# @param names [String, Array#String] The image(s) you wish to save
# @param filename [String] The file to export the data to.
# @param conn [Docker::Connection] The Docker connection to use
#
# @return [NilClass, String] If filename is nil, return the string
# representation of the binary data. If the filename is not nil, then
# return nil.
def save(names, filename = nil, conn = Docker.connection)
if filename
File.open(filename, 'wb') do |file|
save_stream(names, {}, conn, &response_block_for_save(file))
end
nil
else
string = ''
save_stream(names, {}, conn, &response_block_for_save(string))
string
end
end
# Stream the contents of Docker image(s) to a block.
#
# @param names [String, Array#String] The image(s) you wish to save
# @param conn [Docker::Connection] The Docker connection to use
# @yield chunk [String] a chunk of the Docker image(s).
def save_stream(names, opts = {}, conn = Docker.connection, &block)
# By using compare_by_identity we can create a Hash that has
# the same key multiple times.
query = {}.tap(&:compare_by_identity)
Array(names).each { |name| query['names'.dup] = name }
conn.get(
'/images/get',
query,
opts.merge(:response_block => block)
)
nil
end
# Load a tar Image
def load(tar, opts = {}, conn = Docker.connection, creds = nil, &block)
headers = build_headers(creds)
io = tar.is_a?(String) ? File.open(tar, 'rb') : tar
body = ""
conn.post(
'/images/load',
opts,
:headers => headers,
:response_block => response_block(body, &block)
) { io.read(Excon.defaults[:chunk_size]).to_s }
end
# Check if an image exists.
def exist?(id, opts = {}, conn = Docker.connection)
get(id, opts, conn)
true
rescue Docker::Error::NotFoundError
false
end
# Return every Image.
def all(opts = {}, conn = Docker.connection)
hashes = Docker::Util.parse_json(conn.get('/images/json', opts)) || []
hashes.map { |hash| new(conn, hash) }
end
# Given a query like `{ :term => 'sshd' }`, queries the Docker Registry for
# a corresponding Image.
def search(query = {}, connection = Docker.connection, creds = nil)
credentials = creds.nil? ? Docker.creds : creds.to_json
headers = credentials && Docker::Util.build_auth_header(credentials) || {}
body = connection.get(
'/images/search',
query,
:headers => headers,
)
hashes = Docker::Util.parse_json(body) || []
hashes.map { |hash| new(connection, 'id' => hash['name']) }
end
# Import an Image from the output of Docker::Container#export. The first
# argument may either be a File or URI.
def import(imp, opts = {}, conn = Docker.connection)
require 'open-uri'
# This differs after Ruby 2.4
if URI.public_methods.include?(:open)
munged_open = URI.method(:open)
else
munged_open = self.method(:open)
end
munged_open.call(imp) do |io|
import_stream(opts, conn) do
io.read(Excon.defaults[:chunk_size]).to_s
end
end
rescue StandardError
raise Docker::Error::IOError, "Could not import '#{imp}'"
end
def import_stream(options = {}, connection = Docker.connection, &block)
body = connection.post(
'/images/create',
options.merge('fromSrc' => '-'),
:headers => { 'Content-Type' => 'application/tar',
'Transfer-Encoding' => 'chunked' },
&block
)
new(connection, 'id'=> Docker::Util.parse_json(body)['status'])
end
# Given a Dockerfile as a string, builds an Image.
def build(commands, opts = {}, connection = Docker.connection, &block)
body = ""
connection.post(
'/build', opts,
:body => Docker::Util.create_tar('Dockerfile' => commands),
:response_block => response_block(body, &block)
)
new(connection, 'id' => Docker::Util.extract_id(body))
rescue Docker::Error::ServerError
raise Docker::Error::UnexpectedResponseError
end
# Given File like object containing a tar file, builds an Image.
#
# If a block is passed, chunks of output produced by Docker will be passed
# to that block.
def build_from_tar(tar, opts = {}, connection = Docker.connection,
creds = nil, &block)
headers = build_headers(creds)
# The response_block passed to Excon will build up this body variable.
body = ""
connection.post(
'/build', opts,
:headers => headers,
:response_block => response_block(body, &block)
) { tar.read(Excon.defaults[:chunk_size]).to_s }
new(connection,
'id' => Docker::Util.extract_id(body),
:headers => headers)
end
# 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.
def build_from_dir(dir, opts = {}, connection = Docker.connection,
creds = nil, &block)
tar = Docker::Util.create_dir_tar(dir)
build_from_tar tar, opts, connection, creds, &block
ensure
unless tar.nil?
tar.close
FileUtils.rm(tar.path, force: true)
end
end
end
private
# A method to build the config header and merge it into the
# headers sent by build_from_dir.
def self.build_headers(creds=nil)
credentials = creds || Docker.creds || {}
config_header = Docker::Util.build_config_header(credentials)
headers = { 'Content-Type' => 'application/tar',
'Transfer-Encoding' => 'chunked' }
headers = headers.merge(config_header) if config_header
headers
end
# Convenience method to return the path for a particular resource.
def path_for(resource)
"/images/#{self.id}/#{resource}"
end
# Convience method to get the Dockerfile for a file hash and a path to
# output to.
def dockerfile_for(file_hash, output_path)
dockerfile = "from #{self.id}\n"
file_hash.keys.each do |basename|
dockerfile << "add #{basename} #{output_path}\n"
end
dockerfile
end
def ensure_repo_tags
refresh! unless info.has_key?('RepoTags')
info['RepoTags']
end
# Generates the block to be passed as a reponse block to Excon. The returned
# lambda will append Docker output to the first argument, and yield output to
# the passed block, if a block is given.
def self.response_block(body)
lambda do |chunk, remaining, total|
body << chunk
yield chunk if block_given?
end
end
# Generates the block to be passed in to the save request. This lambda will
# append the streaming data to the file provided.
def self.response_block_for_save(file)
lambda do |chunk, remianing, total|
file << chunk
end
end
end