Class: Dockly::Docker

Inherits:
Object
  • Object
show all
Includes:
Util::DSL, Util::Logger::Mixin
Defined in:
lib/dockly/docker.rb

Defined Under Namespace

Classes: Registry

Instance Method Summary collapse

Instance Method Details

#add_build_env(image) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/dockly/docker.rb', line 154

def add_build_env(image)
  return image if build_env.empty?
  info "Setting the following environment variables in the docker image: #{build_env.keys}"
  dockerfile = [
    "FROM #{image.id}",
    *build_env.map { |key, val| "ENV #{key.to_s.shellescape}=#{val.to_s.shellescape}" }
  ].join("\n")
  out_image = ::Docker::Image.build(dockerfile)
  info "Successfully set the environment variables in the dockerfile"
  out_image
end

#add_git_archive(image) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/dockly/docker.rb', line 166

def add_git_archive(image)
  return image if git_archive.nil?
  info "adding the git archive"
  new_image = image.insert_local(
    'localPath' => git_archive_tar,
    'outputPath' => '/'
  )
  info "successfully added the git archive"
  new_image
end

#build_env(hash = nil) ⇒ Object 



31
32
33
 
# File 'lib/dockly/docker.rb', line 31

def build_env(hash = nil)
  (@build_env ||= {}).tap { |env| env.merge!(hash) if hash.is_a?(Hash) }
end

#build_image(image) ⇒ Object 



177
178
179
180
181
182
183
 
# File 'lib/dockly/docker.rb', line 177

def build_image(image)
  ensure_present! :name, :build
  info "running custom build steps, starting with id: #{image.id}"
  out_image = ::Docker::Image.build("from #{image.id}\n#{build}")
  info "finished running custom build steps, result id: #{out_image.id}"
  out_image.tap { |img| img.tag(:repo => repo, :tag => tag) }
end

#cleanup(images) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/dockly/docker.rb', line 75

def cleanup(images)
  info 'Cleaning up intermediate images'
  images ||= []
  images = images.compact
  ::Docker::Container.all(:all => true).each do |container|
    image_id = container.json['Image']
    if images.any? { |image| image.id.start_with?(image_id) || image_id.start_with?(image.id) }
      container.kill
      container.delete
    end
  end
  images.each { |image| image.remove rescue nil }
  info 'Done cleaning images'
end

#ensure_tar(file_name) ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/dockly/docker.rb', line 108

def ensure_tar(file_name)
  if Dockly::Util::Tar.is_tar?(file_name)
    file_name
  elsif Dockly::Util::Tar.is_gzip?(file_name)
    file_name
  else
    raise "Expected a (possibly gzipped) tar: #{file_name}"
  end
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/dockly/docker.rb', line 316

def exists?
  return false unless s3_bucket
  debug "#{name}: checking for package: #{s3_url}"
  Dockly::AWS.s3.head_object(s3_bucket, s3_object)
  info "#{name}: found package: #{s3_url}"
  true
rescue
  info "#{name}: could not find package: " +
       "#{s3_url}"
  false
end

#export_filename ⇒ Object 



90
91
92
 
# File 'lib/dockly/docker.rb', line 90

def export_filename
  "#{name}-image.tgz"
end

#export_image(image) ⇒ Object 



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
 
# File 'lib/dockly/docker.rb', line 200

def export_image(image)
  ensure_present! :name
  if registry.nil?
    ensure_present! :build_dir
    info "Exporting the image with id #{image.id} to file #{File.expand_path(tar_path)}"
    container = image.run('true')
    info "created the container: #{container.id}"

    unless s3_bucket.nil?
      output = Dockly::AWS::S3Writer.new(connection, s3_bucket, s3_object)
    else
      output = File.open(tar_path, 'wb')
    end

    gzip_output = Zlib::GzipWriter.new(output)

    if tar_diff
      export_image_diff(container, gzip_output)
    else
      export_image_whole(container, gzip_output)
    end
  else
    push_to_registry(image)
  end
rescue
  if output && !s3_bucket.nil?
    output.abort_unless_closed
  end
  raise
ensure
  gzip_output.close if gzip_output
end

#export_image_diff(container, output) ⇒ Object 



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
 
# File 'lib/dockly/docker.rb', line 239

def export_image_diff(container, output)
  rd, wr = IO.pipe(Encoding::ASCII_8BIT)

  rd.binmode
  wr.binmode

  thread = Thread.new do
    begin
      if Dockly::Util::Tar.is_tar?(fetch_import)
        base = File.open(fetch_import, 'rb')
      else
        base = Zlib::GzipReader.new(File.open(fetch_import, 'rb'))
      end
      td = Dockly::TarDiff.new(base, rd, output)
      td.process
      info "done writing the docker tar: #{export_filename}"
    ensure
      base.close if base
      rd.close
    end
  end

  begin
    container.export do |chunk, remaining, total|
      wr.write(chunk)
    end
  ensure
    wr.close
    thread.join
  end
end

#export_image_whole(container, output) ⇒ Object 



233
234
235
236
237
 
# File 'lib/dockly/docker.rb', line 233

def export_image_whole(container, output)
  container.export do |chunk, remaining, total|
    output.write(chunk)
  end
end

#fetch_import ⇒ Object 



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
 
# File 'lib/dockly/docker.rb', line 288

def fetch_import
  ensure_present! :import
  path = "/tmp/dockly-docker-import.#{name}.#{File.basename(import)}"

  if File.exist?(path)
    debug "already fetched #{import}"
  else
    debug "fetching #{import}"
    File.open("#{path}.tmp", 'wb') do |file|
      case import
        when /^s3:\/\/(?<bucket_name>.+?)\/(?<object_path>.+)$/
          connection.get_object(Regexp.last_match[:bucket_name],
                                Regexp.last_match[:object_path]) do |chunk, remaining, total|
            file.write(chunk)
          end
        when /^https?:\/\//
          Excon.get(import, :response_block => lambda { |chunk, remaining, total|
            file.write(chunk)
          })
        else
          raise "You can only import from S3 or a public url"
      end
    end
    FileUtils.mv("#{path}.tmp", path, :force => true)
  end
  path
end

#generate! ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/dockly/docker.rb', line 35

def generate!
  image = generate_build
  export_image(image)
ensure
  cleanup([image]) if cleanup_images
end

#generate_build ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/dockly/docker.rb', line 42

def generate_build
  Docker.options = { :read_timeout => timeout, :write_timeout => timeout }
  images = {}

  if registry_import.nil?
    docker_tar = File.absolute_path(ensure_tar(fetch_import))
    images[:one] = import_base(docker_tar)
  else
    registry.authenticate! unless registry.nil?
    full_name = "#{registry_import[:name]}:#{registry_import[:tag]}"
    info "Pulling #{full_name}"
    images[:one] = ::Docker::Image.create('fromImage' => registry_import[:name], 'tag' => registry_import[:tag])
    info "Successfully pulled #{full_name}"
  end

  images[:two] = add_build_env(images[:one])
  images[:three] = add_git_archive(images[:two])
  images[:four] = run_build_caches(images[:three])
  build_image(images[:four])
ensure
  cleanup(images.values.compact) if cleanup_images
end

#git_archive_dir ⇒ Object 



135
136
137
 
# File 'lib/dockly/docker.rb', line 135

def git_archive_dir
  @git_archive_dir ||= File.join(build_dir, "gitarc")
end

#git_archive_path ⇒ Object 



139
140
141
 
# File 'lib/dockly/docker.rb', line 139

def git_archive_path
  "#{git_archive_dir}/#{name}.tar"
end

#git_archive_tar ⇒ Object 



143
144
145
 
# File 'lib/dockly/docker.rb', line 143

def git_archive_tar
  git_archive && File.absolute_path(make_git_archive)
end

#import_base(docker_tar) ⇒ Object 



147
148
149
150
151
152
 
# File 'lib/dockly/docker.rb', line 147

def import_base(docker_tar)
  info "importing the docker image from #{docker_tar}"
  image = ::Docker::Image.import(docker_tar)
  info "imported initial docker image: #{image.id}"
  image
end

#make_git_archive ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/dockly/docker.rb', line 118

def make_git_archive
  ensure_present! :git_archive
  info "initializing"

  prefix = git_archive
  prefix += '/' unless prefix.end_with?('/')

  FileUtils.rm_rf(git_archive_dir)
  FileUtils.mkdir_p(git_archive_dir)
  info "archiving #{Dockly::Util::Git.git_sha}"
  Grit::Git.with_timeout(120) do
    Dockly::Util::Git.git_repo.archive_to_file(Dockly::Util::Git.git_sha, prefix, git_archive_path, 'tar', 'cat')
  end
  info "made the git archive for sha #{Dockly::Util::Git.git_sha}"
  git_archive_path
end

#push_to_registry(image) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
 
# File 'lib/dockly/docker.rb', line 277

def push_to_registry(image)
  ensure_present! :registry
  info "Exporting #{image.id} to Docker registry at #{registry.server_address}"
  registry.authenticate!
  image = Docker::Image.all(:all => true).find { |img|
    img.id.start_with?(image.id) || image.id.start_with?(img.id)
  }
  raise "Could not find image after authentication" if image.nil?
  image.push(registry.to_h, :registry => registry.server_address)
end

#registry_import(img_name = nil, opts = {}) ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'lib/dockly/docker.rb', line 65

def registry_import(img_name = nil, opts = {})
  if img_name
    @registry_import ||= {}
    @registry_import[:name] = img_name
    @registry_import[:tag] = opts[:tag] || 'latest'
  else
    @registry_import
  end
end

#repo ⇒ Object 



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/dockly/docker.rb', line 185

def repo
  @repo ||= case
  when registry.nil?
    name
  when registry.default_server_address?
    "#{registry.username}/#{name}"
  else
    "#{registry.server_address}/#{name}"
  end
end

#repository(value = nil) ⇒ Object 



328
329
330
 
# File 'lib/dockly/docker.rb', line 328

def repository(value = nil)
  name(value)
end

#run_build_caches(image) ⇒ Object 



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

def run_build_caches(image)
  info "starting build caches"
  (build_cache || []).each do |cache|
    cache.image = image
    image = cache.execute!
  end
  info "finished build caches"
  image
end

#s3_object ⇒ Object 



271
272
273
274
275
 
# File 'lib/dockly/docker.rb', line 271

def s3_object
  output = "#{s3_object_prefix}"
  output << "#{Dockly::Util::Git.git_sha}/"
  output << "#{export_filename}"
end

#s3_url ⇒ Object 



196
197
198
 
# File 'lib/dockly/docker.rb', line 196

def s3_url
  "s3://#{s3_bucket}/#{s3_object}"
end

#tar_path ⇒ Object 



104
105
106
 
# File 'lib/dockly/docker.rb', line 104

def tar_path
  File.join(build_dir, export_filename)
end