util/estargz: simplify implementation and define consts for labels #5933
+74
−41
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,84 @@ | ||
| package estargz | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/containerd/containerd/v2/pkg/labels" | ||
| ocispecs "github.com/opencontainers/image-spec/specs-go/v1" | ||
| ) | ||
|
|
||
| const ( | ||
| // TargetRefLabel is a label which contains image reference. | ||
| // | ||
| // It is a copy of [stargz-snapshotter/fs/source.targetRefLabel]. | ||
| // | ||
| // [stargz-snapshotter/fs/source.targetRefLabel]: https://github.com/containerd/stargz-snapshotter/blob/v0.16.3/fs/source/source.go#L64-L65 | ||
| TargetRefLabel = "containerd.io/snapshot/remote/stargz.reference" | ||
|
|
||
| // TargetDigestLabel is a label which contains layer digest. | ||
| // | ||
| // It is a copy of [stargz-snapshotter/fs/source.targetDigestLabel]. | ||
| // | ||
| // [stargz-snapshotter/fs/source.targetDigestLabel]: https://github.com/containerd/stargz-snapshotter/blob/v0.16.3/fs/source/source.go#L67-L68 | ||
| TargetDigestLabel = "containerd.io/snapshot/remote/stargz.digest" | ||
|
|
||
| // TargetImageLayersLabel is a label which contains layer digests contained in | ||
| // the target image. | ||
| // | ||
| // It is a copy of [stargz-snapshotter/fs/source.targetImageLayersLabel]. | ||
| // | ||
| // [stargz-snapshotter/fs/source.targetImageLayersLabel]: https://github.com/containerd/stargz-snapshotter/blob/v0.16.3/fs/source/source.go#L70-L72 | ||
| TargetImageLayersLabel = "containerd.io/snapshot/remote/stargz.layers" | ||
|
|
||
| // TargetSessionLabel is a label which contains session IDs usable for | ||
| // authenticating the target snapshot. | ||
| // | ||
| // It has no equivalent in github.com/containerd/stargz-snapshotter. | ||
| TargetSessionLabel = "containerd.io/snapshot/remote/stargz.session" | ||
| ) | ||
|
|
||
| const ( | ||
| // TOCJSONDigestAnnotation is an annotation for an image layer. This stores the | ||
| // digest of the TOC JSON. | ||
| // This annotation is valid only when it is specified in `.[]layers.annotations` | ||
| // of an image manifest. | ||
| // | ||
| // This is a copy of [estargz.TOCJSONDigestAnnotation] | ||
| // | ||
| // [estargz.TOCJSONDigestAnnotation]: https://pkg.go.dev/github.com/containerd/stargz-snapshotter/estargz@v0.16.3#TOCJSONDigestAnnotation | ||
| TOCJSONDigestAnnotation = "containerd.io/snapshot/stargz/toc.digest" | ||
|
|
||
| // StoreUncompressedSizeAnnotation is an additional annotation key for eStargz to enable lazy | ||
| // pulling on containers/storage. Stargz Store is required to expose the layer's uncompressed size | ||
| // to the runtime but current OCI image doesn't ship this information by default. So we store this | ||
| // to the special annotation. | ||
| // | ||
| // This is a copy of [estargz.StoreUncompressedSizeAnnotation] | ||
| // | ||
| // [estargz.StoreUncompressedSizeAnnotation]: https://pkg.go.dev/github.com/containerd/stargz-snapshotter/estargz@v0.16.3#StoreUncompressedSizeAnnotation | ||
| StoreUncompressedSizeAnnotation = "io.containers.estargz.uncompressed-size" | ||
|
Comment on lines
+58
to
+59
Member
Author
There was a problem hiding this comment. Curious why this uses a different prefix (
Collaborator
There was a problem hiding this comment. This is because this annotation is necessary to make the filesystem work with |
||
| ) | ||
|
|
||
| func SnapshotLabels(ref string, descs []ocispecs.Descriptor, targetIndex int) map[string]string { | ||
| if len(descs) < targetIndex { | ||
| return nil | ||
| } | ||
| desc := descs[targetIndex] | ||
|
|
||
| var layers string | ||
| for _, l := range descs[targetIndex:] { | ||
| // This avoids the label hits the size limitation. | ||
| // Skipping layers is allowed here and only affects performance. | ||
| if err := labels.Validate(TargetImageLayersLabel, layers+l.Digest.String()); err != nil { | ||
| break | ||
| } | ||
| layers += l.Digest.String() + "," | ||
|
Comment on lines
+72
to
+75
Member
Author
There was a problem hiding this comment. Slight change here; previously this would check the length including the trailing |
||
| } | ||
| return map[string]string{ | ||
| TOCJSONDigestAnnotation: desc.Annotations[TOCJSONDigestAnnotation], | ||
| StoreUncompressedSizeAnnotation: desc.Annotations[StoreUncompressedSizeAnnotation], | ||
| TargetRefLabel: ref, | ||
| TargetDigestLabel: desc.Digest.String(), | ||
| TargetImageLayersLabel: strings.TrimSuffix(layers, ","), | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why isn't this imported (or upstream constant just used instead). Same for next.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went back-and-forth a bit; initially I had these as alias (
TOCJSONDigestAnnotation = estargz.TOCJSONDigestAnnotation), but as we already would have to define the non-exported ones locally (and theestargzpackage containing much more than just the consts), and these consts to not change, I thought it would be OK to just have our own copy, as long as we refer to where they originate from.