Class: DockerRegistry2::Registry
- Inherits:
-
Object
- Object
- DockerRegistry2::Registry
- Defined in:
- lib/registry/registry.rb
Instance Method Summary collapse
- #_pull_v1(repo, manifest, dir) ⇒ Object
- #_pull_v2(repo, manifest, dir) ⇒ Object
- #blob(repo, digest, outpath = nil) ⇒ Object
-
#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.
- #copy(repo, tag, newregistry, newrepo, newtag) ⇒ Object
- #digest(repo, tag) ⇒ Object
- #dodelete(url) ⇒ Object
- #doget(url) ⇒ Object
- #dohead(url) ⇒ Object
- #doput(url, payload = nil) ⇒ Object
-
#initialize(uri, options = {}) ⇒ Registry
constructor
A new instance of Registry.
- #last(header) ⇒ Object
- #manifest(repo, tag) ⇒ Object
- #manifest_sum(manifest) ⇒ Object
-
#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.
-
#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.
- #pull(repo, tag, dir) ⇒ Object
- #push(manifest, dir) ⇒ Object
- #rmtag(image, tag) ⇒ Object
- #search(query = '') ⇒ Object
- #tag(repo, tag, newrepo, newtag) ⇒ Object
- #tags(repo, count = nil, last = "", withHashes = false, auto_paginate: false) ⇒ Object
Constructor Details
#initialize(uri, options = {}) ⇒ Registry
Returns a new instance of Registry.
15 16 17 18 19 20 21 22 23 |
# File 'lib/registry/registry.rb', line 15 def initialize(uri, = {}) @uri = URI.parse(uri) @base_uri = "#{@uri.scheme}://#{@uri.host}:#{@uri.port}" @user = [:user] @password = [:password] @http_options = [:http_options] || {} @http_options[:open_timeout] ||= [:open_timeout] || 2 @http_options[:read_timeout] ||= [: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 |
# 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
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/registry/registry.rb', line 172 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
129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/registry/registry.rb', line 129 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
225 226 227 228 |
# File 'lib/registry/registry.rb', line 225 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
220 221 |
# File 'lib/registry/registry.rb', line 220 def copy(repo,tag,newregistry,newrepo,newtag) end |
#digest(repo, tag) ⇒ Object
143 144 145 146 147 148 149 |
# File 'lib/registry/registry.rb', line 143 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
33 34 35 |
# File 'lib/registry/registry.rb', line 33 def dodelete(url) return doreq "delete", url end |
#doget(url) ⇒ Object
25 26 27 |
# File 'lib/registry/registry.rb', line 25 def doget(url) return doreq "get", url end |
#dohead(url) ⇒ Object
37 38 39 |
# File 'lib/registry/registry.rb', line 37 def dohead(url) return doreq "head", url end |
#doput(url, payload = nil) ⇒ Object
29 30 31 |
# File 'lib/registry/registry.rb', line 29 def doput(url,payload=nil) return doreq "put", url, nil, payload end |
#last(header) ⇒ Object
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/registry/registry.rb', line 248 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
119 120 121 122 123 124 125 126 127 |
# File 'lib/registry/registry.rb', line 119 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
259 260 261 262 263 264 265 |
# File 'lib/registry/registry.rb', line 259 def manifest_sum(manifest) size = 0 manifest["layers"].each { |layer| size += layer["size"] } 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.
44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/registry/registry.rb', line 44 def paginate_doget(url) while url response = doget(url) yield response if (link = response.headers[:link]) url = parse_link_header(link)[:next] else break end 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’ }‘.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/registry/registry.rb', line 232 def parse_link_header(header) last='' parts = header.split(',') links = Hash.new # 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
158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/registry/registry.rb', line 158 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
207 208 |
# File 'lib/registry/registry.rb', line 207 def push(manifest,dir) end |
#rmtag(image, tag) ⇒ Object
151 152 153 154 155 156 |
# File 'lib/registry/registry.rb', line 151 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] return dodelete("/v2/#{image}/manifests/#{reference}").code end |
#search(query = '') ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/registry/registry.rb', line 57 def search(query = '') all_repos = [] paginate_doget "/v2/_catalog" do |response| # parse the response repos = JSON.parse(response)["repositories"] if query.strip.length > 0 re = Regexp.new query repos = repos.find_all {|e| re =~ e } end all_repos += repos end all_repos end |
#tag(repo, tag, newrepo, newtag) ⇒ Object
210 211 212 213 214 215 216 217 218 |
# File 'lib/registry/registry.rb', line 210 def tag(repo,tag,newrepo,newtag) manifest = manifest(repo, tag) if manifest['schemaVersion'] == 2 doput "/v2/#{newrepo}/manifests/#{newtag}", manifest.to_json else raise DockerRegistry2::RegistryVersionException end end |
#tags(repo, count = nil, last = "", withHashes = false, auto_paginate: false) ⇒ Object
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 |
# File 'lib/registry/registry.rb', line 71 def (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 > 0 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")) = (repo, count, last_tag, withHashes) resp["last"] = ["last"] resp["tags"] += ["tags"] resp["tags"] = resp["tags"].uniq resp["hashes"].merge!(["hashes"]) if withHashes end resp end |