Class: DockerRegistry2::Registry

Inherits:
Object
  • Object
show all
Defined in:
lib/registry/registry.rb

Overview

rubocop:disable Metrics/ClassLength

Instance Method Summary collapse

Constructor Details

#initialize(uri, options = {}) ⇒ Registry

Returns a new instance of Registry.

Parameters:

  • base_uri (#to_s) —

    Docker registry base URI

  • options (Hash) (defaults to: {}) —

    Client options

Options Hash (options):

  • :user (#to_s) —

    User name for basic authentication

  • :password (#to_s) —

    Password for basic authentication

  • :open_timeout (#to_s) —

    Time to wait for a connection with a registry. It is ignored if http_options is also specified.

  • :read_timeout (#to_s) —

    Time to wait for data from a registry. It is ignored if http_options is also specified.

  • :http_options (Hash) —

    Extra options for RestClient::Request.execute.



18
19
20
21
22
23
24
25
26
 
# File 'lib/registry/registry.rb', line 18

def initialize(uri, options = {})
  @uri = URI.parse(uri)
  @base_uri = "#{@uri.scheme}://#{@uri.host}:#{@uri.port}"
  @user = options[:user]
  @password = options[:password]
  @http_options = options[:http_options] || {}
  @http_options[:open_timeout] ||= options[:open_timeout] || 2
  @http_options[:read_timeout] ||= options[:read_timeout] || 5
end

Instance Method Details

#_pull_v1(repo, manifest, dir) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/registry/registry.rb', line 189

def _pull_v1(repo, manifest, dir)
  # make sure the directory exists
  FileUtils.mkdir_p dir
  return false unless manifest['schemaVersion'] == 1

  # pull each of the layers
  manifest['fsLayers'].each do |layer|
    # define path of file to save layer in
    layer_file = "#{dir}/#{layer['blobSum']}"
    # skip layer if we already got it
    next if File.file? layer_file

    # download layer
    # puts "getting layer (v1) #{layer['blobSum']}"
    blob(repo, layer['blobSum'], layer_file)
    # return layer file
    layer_file
  end
end

#_pull_v2(repo, manifest, dir) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/registry/registry.rb', line 170

def _pull_v2(repo, manifest, dir)
  # make sure the directory exists
  FileUtils.mkdir_p dir
  return false unless manifest['schemaVersion'] == 2

  # pull each of the layers
  manifest['layers'].each do |layer|
    # define path of file to save layer in
    layer_file = "#{dir}/#{layer['digest']}"
    # skip layer if we already got it
    next if File.file? layer_file

    # download layer
    # puts "getting layer (v2) #{layer['digest']}"
    blob(repo, layer['digest'], layer_file)
    layer_file
  end
end

#blob(repo, digest, outpath = nil) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/registry/registry.rb', line 127

def blob(repo, digest, outpath = nil)
  blob_url = "/v2/#{repo}/blobs/#{digest}"
  if outpath.nil?
    response = doget(blob_url)
    DockerRegistry2::Blob.new(response.headers, response.body)
  else
    File.open(outpath, 'w') do |fd|
      doreq('get', blob_url, fd)
    end

    outpath
  end
end

#blob_size(repo, blobSum) ⇒ Object

gets the size of a particular blob, given the repo and the content-addressable hash usually unneeded, since manifest includes it



223
224
225
226
 
# File 'lib/registry/registry.rb', line 223

def blob_size(repo, blobSum)
  response = dohead "/v2/#{repo}/blobs/#{blobSum}"
  Integer(response.headers[:content_length], 10)
end

#copy(repo, tag, newregistry, newrepo, newtag) ⇒ Object 



219
 
# File 'lib/registry/registry.rb', line 219

def copy(repo, tag, newregistry, newrepo, newtag); end

#digest(repo, tag) ⇒ Object 



141
142
143
144
145
146
147
 
# File 'lib/registry/registry.rb', line 141

def digest(repo, tag)
  tag_path = "/v2/#{repo}/manifests/#{tag}"
  dohead(tag_path).headers[:docker_content_digest]
rescue DockerRegistry2::InvalidMethod
  # Pre-2.3.0 registries didn't support manifest HEAD requests
  doget(tag_path).headers[:docker_content_digest]
end

#dodelete(url) ⇒ Object 



36
37
38
 
# File 'lib/registry/registry.rb', line 36

def dodelete(url)
  doreq 'delete', url
end

#doget(url) ⇒ Object 



28
29
30
 
# File 'lib/registry/registry.rb', line 28

def doget(url)
  doreq 'get', url
end

#dohead(url) ⇒ Object 



40
41
42
 
# File 'lib/registry/registry.rb', line 40

def dohead(url)
  doreq 'head', url
end

#doput(url, payload = nil) ⇒ Object 



32
33
34
 
# File 'lib/registry/registry.rb', line 32

def doput(url, payload = nil)
  doreq 'put', url, nil, payload
end

#last(header) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/registry/registry.rb', line 246

def last(header)
  links = parse_link_header(header)
  if links[:next]
    query = URI(links[:next]).query
    link_key = @uri.host.eql?('quay.io') ? 'next_page' : 'last'
    last = URI.decode_www_form(query).to_h[link_key]

  end
  last
end

#manifest(repo, tag) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/registry/registry.rb', line 117

def manifest(repo, tag)
  # first get the manifest
  response = doget "/v2/#{repo}/manifests/#{tag}"
  parsed = JSON.parse response.body
  manifest = DockerRegistry2::Manifest[parsed]
  manifest.body = response.body
  manifest.headers = response.headers
  manifest
end

#manifest_sum(manifest) ⇒ Object 



257
258
259
260
261
262
263
 
# File 'lib/registry/registry.rb', line 257

def manifest_sum(manifest)
  size = 0
  manifest['layers'].each do |layer|
    size += layer['size']
  end
  size
end

#paginate_doget(url) ⇒ Object

When a result set is too large, the Docker registry returns only the first items and adds a Link header in the response with the URL of the next page. See <docs.docker.com/registry/spec/api/#pagination>. This method iterates over the pages and calls the given block with each response.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/registry/registry.rb', line 47

def paginate_doget(url)
  loop do
    response = doget(url)
    yield response

    link_header = response.headers[:link]
    break unless link_header

    url = parse_link_header(link_header)[:next]
  end
end

#parse_link_header(header) ⇒ Object

Parse the value of the Link HTTP header and return a Hash whose keys are the rel values turned into symbols, and the values are URLs. For example, ‘{ next: ’/v2/_catalog?n=100&last=x’ }‘.



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/registry/registry.rb', line 230

def parse_link_header(header)
  last = ''
  parts = header.split(',')
  links = {}

  # Parse each part into a named link
  parts.each do |part, _index|
    section = part.split(';')
    url = section[0][/<(.*)>/, 1]
    name = section[1][/rel="?([^"]*)"?/, 1].to_sym
    links[name] = url
  end

  links
end

#pull(repo, tag, dir) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/registry/registry.rb', line 156

def pull(repo, tag, dir)
  # make sure the directory exists
  FileUtils.mkdir_p dir
  # get the manifest
  m = manifest repo, tag
  # puts "pulling #{repo}:#{tag} into #{dir}"
  # manifest can contain multiple manifests one for each API version
  downloaded_layers = []
  downloaded_layers += _pull_v2(repo, m, dir) if m['schemaVersion'] == 2
  downloaded_layers += _pull_v1(repo, m, dir) if m['schemaVersion'] == 1
  # return downloaded_layers
  downloaded_layers
end

#push(manifest, dir) ⇒ Object 



209
 
# File 'lib/registry/registry.rb', line 209

def push(manifest, dir); end

#rmtag(image, tag) ⇒ Object 



149
150
151
152
153
154
 
# File 'lib/registry/registry.rb', line 149

def rmtag(image, tag)
  # TODO: Need full response back. Rewrite other manifests() calls without JSON?
  reference = doget("/v2/#{image}/manifests/#{tag}").headers[:docker_content_digest]

  dodelete("/v2/#{image}/manifests/#{reference}").code
end

#search(query = '') ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/registry/registry.rb', line 59

def search(query = '')
  all_repos = []
  paginate_doget('/v2/_catalog') do |response|
    repos = JSON.parse(response)['repositories']
    repos.select! { |repo| repo.match?(/#{query}/) } unless query.empty?
    all_repos += repos
  end
  all_repos
end

#tag(repo, tag, newrepo, newtag) ⇒ Object

Raises:



211
212
213
214
215
216
217
 
# File 'lib/registry/registry.rb', line 211

def tag(repo, tag, newrepo, newtag)
  manifest = manifest(repo, tag)

  raise DockerRegistry2::RegistryVersionException unless manifest['schemaVersion'] == 2

  doput "/v2/#{newrepo}/manifests/#{newtag}", manifest.to_json
end

#tags(repo, count = nil, last = '', withHashes = false, auto_paginate: false) ⇒ Object 



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
 
# File 'lib/registry/registry.rb', line 69

def tags(repo, count = nil, last = '', withHashes = false, auto_paginate: false)
  # create query params
  params = []
  params.push(['last', last]) if last && last != ''
  params.push(['n', count]) unless count.nil?

  query_vars = ''
  query_vars = "?#{URI.encode_www_form(params)}" if params.length.positive?

  response = doget "/v2/#{repo}/tags/list#{query_vars}"
  # parse the response
  resp = JSON.parse response
  # parse out next page link if necessary
  resp['last'] = last(response.headers[:link]) if response.headers[:link]

  # do we include the hashes?
  if withHashes
    useGet = false
    resp['hashes'] = {}
    resp['tags'].each do |tag|
      if useGet
        head = doget "/v2/#{repo}/manifests/#{tag}"
      else
        begin
          head = dohead "/v2/#{repo}/manifests/#{tag}"
        rescue DockerRegistry2::InvalidMethod
          # in case we are in a registry pre-2.3.0, which did not support manifest HEAD
          useGet = true
          head = doget "/v2/#{repo}/manifests/#{tag}"
        end
      end
      resp['hashes'][tag] = head.headers[:docker_content_digest]
    end
  end

  return resp unless auto_paginate

  while (last_tag = resp.delete('last'))
    additional_tags = tags(repo, count, last_tag, withHashes)
    resp['last'] = additional_tags['last']
    resp['tags'] += additional_tags['tags']
    resp['tags'] = resp['tags'].uniq
    resp['hashes'].merge!(additional_tags['hashes']) if withHashes
  end

  resp
end