-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
helper.go
502 lines (450 loc) · 14.5 KB
/
helper.go
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
package api
import (
"encoding/json"
"fmt"
"strings"
"k8s.io/kubernetes/pkg/api/errors"
"k8s.io/kubernetes/pkg/api/unversioned"
"k8s.io/kubernetes/pkg/util/sets"
"github.com/docker/distribution/digest"
"github.com/golang/glog"
)
const (
// DockerDefaultNamespace is the value for namespace when a single segment name is provided.
DockerDefaultNamespace = "library"
// DockerDefaultRegistry is the value for the registry when none was provided.
DockerDefaultRegistry = "docker.io"
)
// TODO remove (base, tag, id)
func parseRepositoryTag(repos string) (string, string, string) {
n := strings.Index(repos, "@")
if n >= 0 {
parts := strings.Split(repos, "@")
return parts[0], "", parts[1]
}
n = strings.LastIndex(repos, ":")
if n < 0 {
return repos, "", ""
}
if tag := repos[n+1:]; !strings.Contains(tag, "/") {
return repos[:n], tag, ""
}
return repos, "", ""
}
func isRegistryName(str string) bool {
switch {
case strings.Contains(str, ":"),
strings.Contains(str, "."),
str == "localhost":
return true
}
return false
}
// ParseDockerImageReference parses a Docker pull spec string into a
// DockerImageReference.
func ParseDockerImageReference(spec string) (DockerImageReference, error) {
var ref DockerImageReference
// TODO replace with docker version once docker/docker PR11109 is merged upstream
stream, tag, id := parseRepositoryTag(spec)
repoParts := strings.Split(stream, "/")
switch len(repoParts) {
case 2:
if isRegistryName(repoParts[0]) {
// registry/name
ref.Registry = repoParts[0]
// TODO: default this in all cases where Namespace ends up as ""?
ref.Namespace = DockerDefaultNamespace
if len(repoParts[1]) == 0 {
return ref, fmt.Errorf("the docker pull spec %q must be two or three segments separated by slashes", spec)
}
ref.Name = repoParts[1]
ref.Tag = tag
ref.ID = id
break
}
// namespace/name
ref.Namespace = repoParts[0]
if len(repoParts[1]) == 0 {
return ref, fmt.Errorf("the docker pull spec %q must be two or three segments separated by slashes", spec)
}
ref.Name = repoParts[1]
ref.Tag = tag
ref.ID = id
break
case 3:
// registry/namespace/name
ref.Registry = repoParts[0]
ref.Namespace = repoParts[1]
if len(repoParts[2]) == 0 {
return ref, fmt.Errorf("the docker pull spec %q must be two or three segments separated by slashes", spec)
}
ref.Name = repoParts[2]
ref.Tag = tag
ref.ID = id
break
case 1:
// name
if len(repoParts[0]) == 0 {
return ref, fmt.Errorf("the docker pull spec %q must be two or three segments separated by slashes", spec)
}
ref.Name = repoParts[0]
ref.Tag = tag
ref.ID = id
break
default:
return ref, fmt.Errorf("the docker pull spec %q must be two or three segments separated by slashes", spec)
}
return ref, nil
}
// Equal returns true if the other DockerImageReference is equivalent to the
// reference r. The comparison applies defaults to the Docker image reference,
// so that e.g., "foobar" equals "docker.io/library/foobar:latest".
func (r DockerImageReference) Equal(other DockerImageReference) bool {
defaultedRef := r.DockerClientDefaults()
otherDefaultedRef := other.DockerClientDefaults()
return defaultedRef == otherDefaultedRef
}
// DockerClientDefaults sets the default values used by the Docker client.
func (r DockerImageReference) DockerClientDefaults() DockerImageReference {
if len(r.Namespace) == 0 {
r.Namespace = DockerDefaultNamespace
}
if len(r.Registry) == 0 {
r.Registry = DockerDefaultRegistry
}
if len(r.Tag) == 0 {
r.Tag = DefaultImageTag
}
return r
}
// Minimal reduces a DockerImageReference to its minimalist form.
func (r DockerImageReference) Minimal() DockerImageReference {
if r.Tag == DefaultImageTag {
r.Tag = ""
}
return r
}
// AsRepository returns the reference without tags or IDs.
func (r DockerImageReference) AsRepository() DockerImageReference {
r.Tag = ""
r.ID = ""
return r
}
// DaemonMinimal clears defaults that Docker assumes.
func (r DockerImageReference) DaemonMinimal() DockerImageReference {
if r.Namespace == "library" {
r.Namespace = ""
}
switch r.Registry {
case "index.docker.io", "docker.io":
r.Registry = "docker.io"
}
return r.Minimal()
}
// NameString returns the name of the reference with its tag or ID.
func (r DockerImageReference) NameString() string {
switch {
case len(r.Name) == 0:
return ""
case len(r.Tag) > 0:
return r.Name + ":" + r.Tag
case len(r.ID) > 0:
var ref string
if _, err := digest.ParseDigest(r.ID); err == nil {
// if it parses as a digest, it's v2 pull by id
ref = "@" + r.ID
} else {
// if it doesn't parse as a digest, it's presumably a v1 registry by-id tag
ref = ":" + r.ID
}
return r.Name + ref
default:
return r.Name
}
}
// Exact returns a string representation of the set fields on the DockerImageReference
func (r DockerImageReference) Exact() string {
name := r.NameString()
if len(name) == 0 {
return name
}
s := r.Registry
if len(s) > 0 {
s += "/"
}
if len(r.Namespace) != 0 {
s += r.Namespace + "/"
}
return s + name
}
// String converts a DockerImageReference to a Docker pull spec (which implies a default namespace
// according to V1 Docker registry rules). Use Exact() if you want no defaulting.
func (r DockerImageReference) String() string {
if len(r.Namespace) == 0 {
r.Namespace = DockerDefaultNamespace
}
return r.Exact()
}
// SplitImageStreamTag turns the name of an ImageStreamTag into Name and Tag.
// It returns false if the tag was not properly specified in the name.
func SplitImageStreamTag(nameAndTag string) (name string, tag string, ok bool) {
parts := strings.SplitN(nameAndTag, ":", 2)
name = parts[0]
if len(parts) > 1 {
tag = parts[1]
}
if len(tag) == 0 {
tag = DefaultImageTag
}
return name, tag, len(parts) == 2
}
// JoinImageStreamTag turns a name and tag into the name of an ImageStreamTag
func JoinImageStreamTag(name, tag string) string {
if len(tag) == 0 {
tag = DefaultImageTag
}
return fmt.Sprintf("%s:%s", name, tag)
}
// NormalizeImageStreamTag normalizes an image stream tag by defaulting to 'latest'
// if no tag has been specified.
func NormalizeImageStreamTag(name string) string {
if !strings.Contains(name, ":") {
// Default to latest
return JoinImageStreamTag(name, DefaultImageTag)
}
return name
}
// ImageWithMetadata returns a copy of image with the DockerImageMetadata filled in
// from the raw DockerImageManifest data stored in the image.
func ImageWithMetadata(image Image) (*Image, error) {
if len(image.DockerImageManifest) == 0 {
return &image, nil
}
manifestData := image.DockerImageManifest
image.DockerImageManifest = ""
manifest := DockerImageManifest{}
if err := json.Unmarshal([]byte(manifestData), &manifest); err != nil {
return nil, err
}
if len(manifest.History) == 0 {
// should never have an empty history, but just in case...
return &image, nil
}
v1Metadata := DockerV1CompatibilityImage{}
if err := json.Unmarshal([]byte(manifest.History[0].DockerV1Compatibility), &v1Metadata); err != nil {
return nil, err
}
image.DockerImageMetadata.ID = v1Metadata.ID
image.DockerImageMetadata.Parent = v1Metadata.Parent
image.DockerImageMetadata.Comment = v1Metadata.Comment
image.DockerImageMetadata.Created = v1Metadata.Created
image.DockerImageMetadata.Container = v1Metadata.Container
image.DockerImageMetadata.ContainerConfig = v1Metadata.ContainerConfig
image.DockerImageMetadata.DockerVersion = v1Metadata.DockerVersion
image.DockerImageMetadata.Author = v1Metadata.Author
image.DockerImageMetadata.Config = v1Metadata.Config
image.DockerImageMetadata.Architecture = v1Metadata.Architecture
image.DockerImageMetadata.Size = v1Metadata.Size
return &image, nil
}
// DockerImageReferenceForStream returns a DockerImageReference that represents
// the ImageStream or false, if no valid reference exists.
func DockerImageReferenceForStream(stream *ImageStream) (DockerImageReference, error) {
spec := stream.Status.DockerImageRepository
if len(spec) == 0 {
spec = stream.Spec.DockerImageRepository
}
if len(spec) == 0 {
return DockerImageReference{}, fmt.Errorf("no possible pull spec for %s/%s", stream.Namespace, stream.Name)
}
return ParseDockerImageReference(spec)
}
// LatestTaggedImage returns the most recent TagEvent for the specified image
// repository and tag. Will resolve lookups for the empty tag. Returns nil
// if tag isn't present in stream.status.tags.
func LatestTaggedImage(stream *ImageStream, tag string) *TagEvent {
if len(tag) == 0 {
tag = DefaultImageTag
}
// find the most recent tag event with an image reference
if stream.Status.Tags != nil {
if history, ok := stream.Status.Tags[tag]; ok {
if len(history.Items) == 0 {
return nil
}
return &history.Items[0]
}
}
return nil
}
// AddTagEventToImageStream attempts to update the given image stream with a tag event. It will
// collapse duplicate entries - returning true if a change was made or false if no change
// occurred.
func AddTagEventToImageStream(stream *ImageStream, tag string, next TagEvent) bool {
if stream.Status.Tags == nil {
stream.Status.Tags = make(map[string]TagEventList)
}
tags, ok := stream.Status.Tags[tag]
if !ok || len(tags.Items) == 0 {
stream.Status.Tags[tag] = TagEventList{Items: []TagEvent{next}}
return true
}
previous := &tags.Items[0]
// image reference has not changed
if previous.DockerImageReference == next.DockerImageReference {
if next.Image == previous.Image {
return false
}
previous.Image = next.Image
stream.Status.Tags[tag] = tags
return true
}
// image has not changed, but image reference has
if next.Image == previous.Image {
previous.DockerImageReference = next.DockerImageReference
stream.Status.Tags[tag] = tags
return true
}
tags.Items = append([]TagEvent{next}, tags.Items...)
stream.Status.Tags[tag] = tags
return true
}
// UpdateChangedTrackingTags identifies any tags in the status that have changed and
// ensures any referenced tracking tags are also updated. It returns the number of
// updates applied.
func UpdateChangedTrackingTags(new, old *ImageStream) int {
changes := 0
for newTag, newImages := range new.Status.Tags {
if oldImages, ok := old.Status.Tags[newTag]; ok {
changed, deleted := tagsChanged(oldImages.Items, newImages.Items)
if !changed || deleted {
continue
}
changes += UpdateTrackingTags(new, newTag, newImages.Items[0])
}
}
return changes
}
// tagsChanged returns true if the two lists differ, and if the newer list is empty
// then deleted is returned true as well.
func tagsChanged(new, old []TagEvent) (changed bool, deleted bool) {
switch {
case len(old) == 0 && len(new) == 0:
return false, false
case len(new) == 0:
return true, true
case len(old) == 0:
return true, false
default:
return new[0] == old[0], false
}
}
// UpdateTrackingTags sets updatedImage as the most recent TagEvent for all tags
// in stream.spec.tags that have from.kind = "ImageStreamTag" and the tag in from.name
// = updatedTag. from.name may be either <tag> or <stream name>:<tag>. For now, only
// references to tags in the current stream are supported.
//
// For example, if stream.spec.tags[latest].from.name = 2.0, whenever an image is pushed
// to this stream with the tag 2.0, status.tags[latest].items[0] will also be updated
// to point at the same image that was just pushed for 2.0.
//
// Returns the number of tags changed.
func UpdateTrackingTags(stream *ImageStream, updatedTag string, updatedImage TagEvent) int {
updated := 0
glog.V(5).Infof("UpdateTrackingTags: stream=%s/%s, updatedTag=%s, updatedImage.dockerImageReference=%s, updatedImage.image=%s", stream.Namespace, stream.Name, updatedTag, updatedImage.DockerImageReference, updatedImage.Image)
for specTag, tagRef := range stream.Spec.Tags {
glog.V(5).Infof("Examining spec tag %q, tagRef=%#v", specTag, tagRef)
// no from
if tagRef.From == nil {
glog.V(5).Infof("tagRef.From is nil, skipping")
continue
}
// wrong kind
if tagRef.From.Kind != "ImageStreamTag" {
glog.V(5).Infof("tagRef.Kind %q isn't ImageStreamTag, skipping", tagRef.From.Kind)
continue
}
tagRefNamespace := tagRef.From.Namespace
if len(tagRefNamespace) == 0 {
tagRefNamespace = stream.Namespace
}
// different namespace
if tagRefNamespace != stream.Namespace {
glog.V(5).Infof("tagRefNamespace %q doesn't match stream namespace %q - skipping", tagRefNamespace, stream.Namespace)
continue
}
tagRefName := tagRef.From.Name
parts := strings.Split(tagRefName, ":")
tag := ""
switch len(parts) {
case 2:
// <stream>:<tag>
tagRefName = parts[0]
tag = parts[1]
default:
// <tag> (this stream)
tag = tagRefName
tagRefName = stream.Name
}
glog.V(5).Infof("tagRefName=%q, tag=%q", tagRefName, tag)
// different stream
if tagRefName != stream.Name {
glog.V(5).Infof("tagRefName %q doesn't match stream name %q - skipping", tagRefName, stream.Name)
continue
}
// different tag
if tag != updatedTag {
glog.V(5).Infof("tag %q doesn't match updated tag %q - skipping", tag, updatedTag)
continue
}
if AddTagEventToImageStream(stream, specTag, updatedImage) {
glog.V(5).Infof("stream updated")
updated++
}
}
return updated
}
// ResolveImageID returns latest TagEvent for specified imageID and an error if
// there's more than one image matching the ID or when one does not exist.
func ResolveImageID(stream *ImageStream, imageID string) (*TagEvent, error) {
var event *TagEvent
set := sets.NewString()
for _, history := range stream.Status.Tags {
for _, tagging := range history.Items {
if d, err := digest.ParseDigest(tagging.Image); err == nil {
if strings.HasPrefix(d.Hex(), imageID) || strings.HasPrefix(tagging.Image, imageID) {
event = &tagging
set.Insert(tagging.Image)
}
continue
}
if strings.HasPrefix(tagging.Image, imageID) {
event = &tagging
set.Insert(tagging.Image)
}
}
}
switch len(set) {
case 1:
return &TagEvent{
Created: unversioned.Now(),
DockerImageReference: event.DockerImageReference,
Image: event.Image,
}, nil
case 0:
return nil, errors.NewNotFound("imageStreamImage", imageID)
default:
return nil, errors.NewConflict("imageStreamImage", imageID, fmt.Errorf("multiple images match the prefix %q: %s", imageID, strings.Join(set.List(), ", ")))
}
}
// ShortDockerImageID returns a short form of the provided DockerImage ID for display
func ShortDockerImageID(image *DockerImage, length int) string {
id := image.ID
if s, err := digest.ParseDigest(id); err == nil {
id = s.Hex()
}
if len(id) > length {
id = id[:length]
}
return id
}