forked from openshift/origin
-
Notifications
You must be signed in to change notification settings - Fork 1
/
helper.go
1163 lines (1039 loc) · 35.7 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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package api
import (
"bytes"
"encoding/json"
"fmt"
"net"
"net/url"
"regexp"
"sort"
"strings"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
"github.com/blang/semver"
"github.com/docker/distribution/digest"
"github.com/docker/distribution/manifest/schema1"
"github.com/docker/distribution/manifest/schema2"
"github.com/golang/glog"
"github.com/openshift/origin/pkg/image/reference"
)
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"
// DockerDefaultV1Registry is the host name of the default v1 registry
DockerDefaultV1Registry = "index." + DockerDefaultRegistry
// DockerDefaultV2Registry is the host name of the default v2 registry
DockerDefaultV2Registry = "registry-1." + DockerDefaultRegistry
// TagReferenceAnnotationTagHidden indicates that a given TagReference is hidden from search results
TagReferenceAnnotationTagHidden = "hidden"
// ImportRegistryNotAllowed indicates that the image tag was not imported due to
// untrusted registry.
ImportRegistryNotAllowed = "registry is not allowed for import"
)
// DefaultRegistry returns the default Docker registry (host or host:port), or false if it is not available.
type DefaultRegistry interface {
DefaultRegistry() (string, bool)
}
// DefaultRegistryFunc implements DefaultRegistry for a simple function.
type DefaultRegistryFunc func() (string, bool)
// DefaultRegistry implements the DefaultRegistry interface for a function.
func (fn DefaultRegistryFunc) DefaultRegistry() (string, bool) {
return fn()
}
// ParseImageStreamImageName splits a string into its name component and ID component, and returns an error
// if the string is not in the right form.
func ParseImageStreamImageName(input string) (name string, id string, err error) {
segments := strings.SplitN(input, "@", 3)
switch len(segments) {
case 2:
name = segments[0]
id = segments[1]
if len(name) == 0 || len(id) == 0 {
err = fmt.Errorf("image stream image name %q must have a name and ID", input)
}
default:
err = fmt.Errorf("expected exactly one @ in the isimage name %q", input)
}
return
}
// ParseImageStreamTagName splits a string into its name component and tag component, and returns an error
// if the string is not in the right form.
func ParseImageStreamTagName(istag string) (name string, tag string, err error) {
if strings.Contains(istag, "@") {
err = fmt.Errorf("%q is an image stream image, not an image stream tag", istag)
return
}
segments := strings.SplitN(istag, ":", 3)
switch len(segments) {
case 2:
name = segments[0]
tag = segments[1]
if len(name) == 0 || len(tag) == 0 {
err = fmt.Errorf("image stream tag name %q must have a name and a tag", istag)
}
default:
err = fmt.Errorf("expected exactly one : delimiter in the istag %q", istag)
}
return
}
// MakeImageStreamImageName creates a name for image stream image object from an image stream name and an id.
func MakeImageStreamImageName(name, id string) string {
return fmt.Sprintf("%s@%s", name, id)
}
// IsRegistryDockerHub returns true if the given registry name belongs to
// Docker hub.
func IsRegistryDockerHub(registry string) bool {
switch registry {
case DockerDefaultRegistry, DockerDefaultV1Registry, DockerDefaultV2Registry:
return true
default:
return false
}
}
// ParseDockerImageReference parses a Docker pull spec string into a
// DockerImageReference.
func ParseDockerImageReference(spec string) (DockerImageReference, error) {
var ref DockerImageReference
namedRef, err := reference.ParseNamedDockerImageReference(spec)
if err != nil {
return ref, err
}
ref.Registry = namedRef.Registry
ref.Namespace = namedRef.Namespace
ref.Name = namedRef.Name
ref.Tag = namedRef.Tag
ref.ID = namedRef.ID
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.Registry) == 0 {
r.Registry = DockerDefaultRegistry
}
if len(r.Namespace) == 0 && IsRegistryDockerHub(r.Registry) {
r.Namespace = DockerDefaultNamespace
}
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
}
// RepositoryName returns the registry relative name
func (r DockerImageReference) RepositoryName() string {
r.Tag = ""
r.ID = ""
r.Registry = ""
return r.Exact()
}
// RegistryHostPort returns the registry hostname and the port.
// If the port is not specified in the registry hostname we default to 443.
// This will also default to Docker client defaults if the registry hostname is empty.
func (r DockerImageReference) RegistryHostPort(insecure bool) (string, string) {
registryHost := r.AsV2().DockerClientDefaults().Registry
if strings.Contains(registryHost, ":") {
hostname, port, _ := net.SplitHostPort(registryHost)
return hostname, port
}
if insecure {
return registryHost, "80"
}
return registryHost, "443"
}
// RepositoryName returns the registry relative name
func (r DockerImageReference) RegistryURL() *url.URL {
return &url.URL{
Scheme: "https",
Host: r.AsV2().Registry,
}
}
// DaemonMinimal clears defaults that Docker assumes.
func (r DockerImageReference) DaemonMinimal() DockerImageReference {
switch r.Registry {
case DockerDefaultV1Registry, DockerDefaultV2Registry:
r.Registry = DockerDefaultRegistry
}
if IsRegistryDockerHub(r.Registry) && r.Namespace == DockerDefaultNamespace {
r.Namespace = ""
}
return r.Minimal()
}
func (r DockerImageReference) AsV2() DockerImageReference {
switch r.Registry {
case DockerDefaultV1Registry, DockerDefaultRegistry:
r.Registry = DockerDefaultV2Registry
}
return r
}
// MostSpecific returns the most specific image reference that can be constructed from the
// current ref, preferring an ID over a Tag. Allows client code dealing with both tags and IDs
// to get the most specific reference easily.
func (r DockerImageReference) MostSpecific() DockerImageReference {
if len(r.ID) == 0 {
return r
}
if _, err := digest.ParseDigest(r.ID); err == nil {
r.Tag = ""
return r
}
if len(r.Tag) == 0 {
r.Tag, r.ID = r.ID, ""
return r
}
return r
}
// 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, its 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 && IsRegistryDockerHub(r.Registry) {
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
}
// SplitImageStreamImage turns the name of an ImageStreamImage into Name and ID.
// It returns false if the ID was not properly specified in the name.
func SplitImageStreamImage(nameAndID string) (name string, id string, ok bool) {
parts := strings.SplitN(nameAndID, "@", 2)
name = parts[0]
if len(parts) > 1 {
id = parts[1]
}
return name, id, 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 {
stripped, tag, ok := SplitImageStreamTag(name)
if !ok {
// Default to latest
return JoinImageStreamTag(stripped, tag)
}
return name
}
// ManifestMatchesImage returns true if the provided manifest matches the name of the image.
func ManifestMatchesImage(image *Image, newManifest []byte) (bool, error) {
dgst, err := digest.ParseDigest(image.Name)
if err != nil {
return false, err
}
v, err := digest.NewDigestVerifier(dgst)
if err != nil {
return false, err
}
var canonical []byte
switch image.DockerImageManifestMediaType {
case schema2.MediaTypeManifest:
var m schema2.DeserializedManifest
if err := json.Unmarshal(newManifest, &m); err != nil {
return false, err
}
_, canonical, err = m.Payload()
if err != nil {
return false, err
}
case schema1.MediaTypeManifest, "":
var m schema1.SignedManifest
if err := json.Unmarshal(newManifest, &m); err != nil {
return false, err
}
canonical = m.Canonical
default:
return false, fmt.Errorf("unsupported manifest mediatype: %s", image.DockerImageManifestMediaType)
}
if _, err := v.Write(canonical); err != nil {
return false, err
}
return v.Verified(), nil
}
// ImageConfigMatchesImage returns true if the provided image config matches a digest
// stored in the manifest of the image.
func ImageConfigMatchesImage(image *Image, imageConfig []byte) (bool, error) {
if image.DockerImageManifestMediaType != schema2.MediaTypeManifest {
return false, nil
}
var m schema2.DeserializedManifest
if err := json.Unmarshal([]byte(image.DockerImageManifest), &m); err != nil {
return false, err
}
v, err := digest.NewDigestVerifier(m.Config.Digest)
if err != nil {
return false, err
}
if _, err := v.Write(imageConfig); err != nil {
return false, err
}
return v.Verified(), nil
}
// ImageWithMetadata mutates the given image. It parses raw DockerImageManifest data stored in the image and
// fills its DockerImageMetadata and other fields.
func ImageWithMetadata(image *Image) error {
if len(image.DockerImageManifest) == 0 {
return nil
}
if len(image.DockerImageLayers) > 0 && image.DockerImageMetadata.Size > 0 && len(image.DockerImageManifestMediaType) > 0 {
glog.V(5).Infof("Image metadata already filled for %s", image.Name)
// don't update image already filled
return nil
}
manifestData := image.DockerImageManifest
manifest := DockerImageManifest{}
if err := json.Unmarshal([]byte(manifestData), &manifest); err != nil {
return err
}
switch manifest.SchemaVersion {
case 0:
// legacy config object
case 1:
image.DockerImageManifestMediaType = schema1.MediaTypeManifest
if len(manifest.History) == 0 {
// should never have an empty history, but just in case...
return nil
}
v1Metadata := DockerV1CompatibilityImage{}
if err := json.Unmarshal([]byte(manifest.History[0].DockerV1Compatibility), &v1Metadata); err != nil {
return err
}
image.DockerImageLayers = make([]ImageLayer, len(manifest.FSLayers))
for i, layer := range manifest.FSLayers {
image.DockerImageLayers[i].MediaType = schema1.MediaTypeManifestLayer
image.DockerImageLayers[i].Name = layer.DockerBlobSum
}
if len(manifest.History) == len(image.DockerImageLayers) {
// This code does not work for images converted from v2 to v1, since V1Compatibility does not
// contain size information in this case.
image.DockerImageLayers[0].LayerSize = v1Metadata.Size
var size = DockerV1CompatibilityImageSize{}
for i, obj := range manifest.History[1:] {
size.Size = 0
if err := json.Unmarshal([]byte(obj.DockerV1Compatibility), &size); err != nil {
continue
}
image.DockerImageLayers[i+1].LayerSize = size.Size
}
} else {
glog.V(4).Infof("Imported image has mismatched layer count and history count, not updating image metadata: %s", image.Name)
}
// reverse order of the layers for v1 (lowest = 0, highest = i)
for i, j := 0, len(image.DockerImageLayers)-1; i < j; i, j = i+1, j-1 {
image.DockerImageLayers[i], image.DockerImageLayers[j] = image.DockerImageLayers[j], image.DockerImageLayers[i]
}
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
if len(image.DockerImageLayers) > 0 {
size := int64(0)
layerSet := sets.NewString()
for _, layer := range image.DockerImageLayers {
if layerSet.Has(layer.Name) {
continue
}
layerSet.Insert(layer.Name)
size += layer.LayerSize
}
image.DockerImageMetadata.Size = size
} else {
image.DockerImageMetadata.Size = v1Metadata.Size
}
case 2:
image.DockerImageManifestMediaType = schema2.MediaTypeManifest
if len(image.DockerImageConfig) == 0 {
return fmt.Errorf("dockerImageConfig must not be empty for manifest schema 2")
}
config := DockerImageConfig{}
if err := json.Unmarshal([]byte(image.DockerImageConfig), &config); err != nil {
return fmt.Errorf("failed to parse dockerImageConfig: %v", err)
}
image.DockerImageLayers = make([]ImageLayer, len(manifest.Layers))
for i, layer := range manifest.Layers {
image.DockerImageLayers[i].Name = layer.Digest
image.DockerImageLayers[i].LayerSize = layer.Size
image.DockerImageLayers[i].MediaType = layer.MediaType
}
// reverse order of the layers for v1 (lowest = 0, highest = i)
for i, j := 0, len(image.DockerImageLayers)-1; i < j; i, j = i+1, j-1 {
image.DockerImageLayers[i], image.DockerImageLayers[j] = image.DockerImageLayers[j], image.DockerImageLayers[i]
}
image.DockerImageMetadata.ID = manifest.Config.Digest
image.DockerImageMetadata.Parent = config.Parent
image.DockerImageMetadata.Comment = config.Comment
image.DockerImageMetadata.Created = config.Created
image.DockerImageMetadata.Container = config.Container
image.DockerImageMetadata.ContainerConfig = config.ContainerConfig
image.DockerImageMetadata.DockerVersion = config.DockerVersion
image.DockerImageMetadata.Author = config.Author
image.DockerImageMetadata.Config = config.Config
image.DockerImageMetadata.Architecture = config.Architecture
image.DockerImageMetadata.Size = int64(len(image.DockerImageConfig))
layerSet := sets.NewString(image.DockerImageMetadata.ID)
if len(image.DockerImageLayers) > 0 {
for _, layer := range image.DockerImageLayers {
if layerSet.Has(layer.Name) {
continue
}
layerSet.Insert(layer.Name)
image.DockerImageMetadata.Size += layer.LayerSize
}
}
default:
return fmt.Errorf("unrecognized Docker image manifest schema %d for %q (%s)", manifest.SchemaVersion, image.Name, image.DockerImageReference)
}
return 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)
}
// FollowTagReference walks through the defined tags on a stream, following any referential tags in the stream.
// Will return ok if the tag is valid, multiple if the tag had at least reference, and ref and finalTag will be the last
// tag seen. If a circular loop is found ok will be false.
func FollowTagReference(stream *ImageStream, tag string) (finalTag string, ref *TagReference, ok bool, multiple bool) {
seen := sets.NewString()
for {
if seen.Has(tag) {
// circular reference
return tag, nil, false, multiple
}
seen.Insert(tag)
tagRef, ok := stream.Spec.Tags[tag]
if !ok {
// no tag at the end of the rainbow
return tag, nil, false, multiple
}
if tagRef.From == nil || tagRef.From.Kind != "ImageStreamTag" || strings.Contains(tagRef.From.Name, ":") {
// terminating tag
return tag, &tagRef, true, multiple
}
// follow the referenec
tag = tagRef.From.Name
multiple = true
}
}
// LatestImageTagEvent returns the most recent TagEvent and the tag for the specified
// image.
func LatestImageTagEvent(stream *ImageStream, imageID string) (string, *TagEvent) {
var (
latestTagEvent *TagEvent
latestTag string
)
for tag, events := range stream.Status.Tags {
if len(events.Items) == 0 {
continue
}
for i, event := range events.Items {
if digestOrImageMatch(event.Image, imageID) &&
(latestTagEvent == nil || latestTagEvent != nil && event.Created.After(latestTagEvent.Created.Time)) {
latestTagEvent = &events.Items[i]
latestTag = tag
}
}
}
return latestTag, latestTagEvent
}
// 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
}
// ResolveLatestTaggedImage returns the appropriate pull spec for a given tag in
// the image stream, handling the tag's reference policy if necessary to return
// a resolved image. Callers that transform an ImageStreamTag into a pull spec
// should use this method instead of LatestTaggedImage.
func ResolveLatestTaggedImage(stream *ImageStream, tag string) (string, bool) {
if len(tag) == 0 {
tag = DefaultImageTag
}
return ResolveTagReference(stream, tag, LatestTaggedImage(stream, tag))
}
// ResolveTagReference applies the tag reference rules for a stream, tag, and tag event for
// that tag. It returns true if the tag is
func ResolveTagReference(stream *ImageStream, tag string, latest *TagEvent) (string, bool) {
if latest == nil {
return "", false
}
return ResolveReferenceForTagEvent(stream, tag, latest), true
}
// ResolveReferenceForTagEvent applies the tag reference rules for a stream, tag, and tag event for
// that tag.
func ResolveReferenceForTagEvent(stream *ImageStream, tag string, latest *TagEvent) string {
// retrieve spec policy - if not found, we use the latest spec
ref, ok := stream.Spec.Tags[tag]
if !ok {
return latest.DockerImageReference
}
switch ref.ReferencePolicy.Type {
// the local reference policy attempts to use image pull through on the integrated
// registry if possible
case LocalTagReferencePolicy:
local := stream.Status.DockerImageRepository
if len(local) == 0 || len(latest.Image) == 0 {
// fallback to the originating reference if no local docker registry defined or we
// lack an image ID
return latest.DockerImageReference
}
ref, err := ParseDockerImageReference(local)
if err != nil {
// fallback to the originating reference if the reported local repository spec is not valid
return latest.DockerImageReference
}
// create a local pullthrough URL
ref.Tag = ""
ref.ID = latest.Image
return ref.Exact()
// the default policy is to use the originating image
default:
return latest.DockerImageReference
}
}
// DockerImageReferenceForImage returns the docker reference for specified image. Assuming
// the image stream contains the image and the image has corresponding tag, this function
// will try to find this tag and take the reference policy into the account.
// If the image stream does not reference the image or the image does not have
// corresponding tag event, this function will return false.
func DockerImageReferenceForImage(stream *ImageStream, imageID string) (string, bool) {
tag, event := LatestImageTagEvent(stream, imageID)
if len(tag) == 0 {
return "", false
}
ref, ok := stream.Spec.Tags[tag]
if !ok {
return event.DockerImageReference, true
}
switch ref.ReferencePolicy.Type {
case LocalTagReferencePolicy:
ref, err := ParseDockerImageReference(stream.Status.DockerImageRepository)
if err != nil {
return event.DockerImageReference, true
}
ref.Tag = ""
ref.ID = event.Image
return ref.Exact(), true
default:
return event.DockerImageReference, true
}
}
// DifferentTagEvent returns true if the supplied tag event matches the current stream tag event.
// Generation is not compared.
func DifferentTagEvent(stream *ImageStream, tag string, next TagEvent) bool {
tags, ok := stream.Status.Tags[tag]
if !ok || len(tags.Items) == 0 {
return true
}
previous := &tags.Items[0]
sameRef := previous.DockerImageReference == next.DockerImageReference
sameImage := previous.Image == next.Image
return !(sameRef && sameImage)
}
// DifferentTagEvent compares the generation on tag's spec vs its status.
// Returns if spec generation is newer than status one.
func DifferentTagGeneration(stream *ImageStream, tag string) bool {
specTag, ok := stream.Spec.Tags[tag]
if !ok || specTag.Generation == nil {
return true
}
statusTag, ok := stream.Status.Tags[tag]
if !ok || len(statusTag.Items) == 0 {
return true
}
return *specTag.Generation > statusTag.Items[0].Generation
}
// 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. Any successful tag resets the status field.
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]
sameRef := previous.DockerImageReference == next.DockerImageReference
sameImage := previous.Image == next.Image
sameGen := previous.Generation == next.Generation
switch {
// shouldn't change the tag
case sameRef && sameImage && sameGen:
return false
case sameImage && sameRef:
// collapse the tag
case sameRef:
previous.Image = next.Image
case sameImage:
previous.DockerImageReference = next.DockerImageReference
default:
// shouldn't collapse the tag
tags.Conditions = nil
tags.Items = append([]TagEvent{next}, tags.Items...)
stream.Status.Tags[tag] = tags
return true
}
previous.Generation = next.Generation
tags.Conditions = nil
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 len(newImages.Items) == 0 {
continue
}
if old != nil {
oldImages := old.Status.Tags[newTag]
changed, deleted := tagsChanged(newImages.Items, oldImages.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
}
// TODO: this is probably wrong - we should require ":<tag>", but we can't break old clients
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
}
func digestOrImageMatch(image, imageID string) bool {
if d, err := digest.ParseDigest(image); err == nil {
return strings.HasPrefix(d.Hex(), imageID) || strings.HasPrefix(image, imageID)
}
return strings.HasPrefix(image, imageID)
}
// 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 i := range history.Items {
tagging := &history.Items[i]
if digestOrImageMatch(tagging.Image, imageID) {
event = tagging
set.Insert(tagging.Image)
}
}
}
switch len(set) {
case 1:
return &TagEvent{
Created: metav1.Now(),
DockerImageReference: event.DockerImageReference,
Image: event.Image,
}, nil
case 0:
return nil, errors.NewNotFound(Resource("imagestreamimage"), imageID)
default:
return nil, errors.NewConflict(Resource("imagestreamimage"), imageID, fmt.Errorf("multiple images match the prefix %q: %s", imageID, strings.Join(set.List(), ", ")))
}
}
// MostAccuratePullSpec returns a docker image reference that uses the current ID if possible, the current tag otherwise, and
// returns false if the reference if the spec could not be parsed. The returned spec has all client defaults applied.
func MostAccuratePullSpec(pullSpec string, id, tag string) (string, bool) {
ref, err := ParseDockerImageReference(pullSpec)
if err != nil {
return pullSpec, false
}
if len(id) > 0 {
ref.ID = id
}
if len(tag) > 0 {
ref.Tag = tag
}
return ref.MostSpecific().Exact(), true
}
// 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
}
// HasTagCondition returns true if the specified image stream tag has a condition with the same type, status, and
// reason (does not check generation, date, or message).
func HasTagCondition(stream *ImageStream, tag string, condition TagEventCondition) bool {
for _, existing := range stream.Status.Tags[tag].Conditions {
if condition.Type == existing.Type && condition.Status == existing.Status && condition.Reason == existing.Reason {
return true
}
}
return false
}
// SetTagConditions applies the specified conditions to the status of the given tag.
func SetTagConditions(stream *ImageStream, tag string, conditions ...TagEventCondition) {
tagEvents := stream.Status.Tags[tag]
tagEvents.Conditions = conditions
if stream.Status.Tags == nil {
stream.Status.Tags = make(map[string]TagEventList)
}
stream.Status.Tags[tag] = tagEvents
}
// LatestObservedTagGeneration returns the generation value for the given tag that has been observed by the controller
// monitoring the image stream. If the tag has not been observed, the generation is zero.
func LatestObservedTagGeneration(stream *ImageStream, tag string) int64 {
tagEvents, ok := stream.Status.Tags[tag]
if !ok {
return 0
}
// find the most recent generation
lastGen := int64(0)
if items := tagEvents.Items; len(items) > 0 {
tagEvent := items[0]
if tagEvent.Generation > lastGen {
lastGen = tagEvent.Generation
}
}
for _, condition := range tagEvents.Conditions {
if condition.Type != ImportSuccess {
continue
}
if condition.Generation > lastGen {
lastGen = condition.Generation
}
break
}
return lastGen
}
var (
reMinorSemantic = regexp.MustCompile(`^[\d]+\.[\d]+$`)
reMinorWithPatch = regexp.MustCompile(`^([\d]+\.[\d]+)-\w+$`)
)
type tagPriority int
const (
// the "latest" tag
tagPriorityLatest tagPriority = iota
// a semantic minor version ("5.1", "v5.1", "v5.1-rc1")