Skip to content

Commit 9edcfcc

Browse files
dmcgowandmcgowan
committed
Add platform match comparer interface
Adds a new platform interface for matching and comparing platforms. This new interface allows both filtering and ordering of platforms to support running multiple platform and choosing the best platform. Signed-off-by: Derek McGowan <[email protected]>
1 parent 830363a commit 9edcfcc

12 files changed

Lines changed: 368 additions & 70 deletions

File tree

‎client.go‎

Lines changed: 58 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -259,9 +259,10 @@ type RemoteContext struct {
259259
// If no resolver is provided, defaults to Docker registry resolver.
260260
Resolver remotes.Resolver
261261

262-
// Platforms defines which platforms to handle when doing the image operation.
263-
// If this field is empty, content for all platforms will be pulled.
264-
Platforms []string
262+
// PlatformMatcher is used to match the platforms for an image
263+
// operation and define the preference when a single match is required
264+
// from multiple platforms.
265+
PlatformMatcher platforms.MatchComparer
265266

266267
// Unpack is done after an image is pulled to extract into a snapshotter.
267268
// If an image is not unpacked on pull, it can be unpacked any time
@@ -283,6 +284,12 @@ type RemoteContext struct {
283284
// manifests. If this option is false then any image which resolves
284285
// to schema 1 will return an error since schema 1 is not supported.
285286
ConvertSchema1 bool
287+
288+
// Platforms defines which platforms to handle when doing the image operation.
289+
// Platforms is ignored when a PlatformMatcher is set, otherwise the
290+
// platforms will be used to create a PlatformMatcher with no ordering
291+
// preference.
292+
Platforms []string
286293
}
287294

288295
func defaultRemoteContext() *RemoteContext {
@@ -308,6 +315,23 @@ func (c *Client) Fetch(ctx context.Context, ref string, opts ...RemoteOpt) (imag
308315
return images.Image{}, errors.New("unpack on fetch not supported, try pull")
309316
}
310317

318+
if fetchCtx.PlatformMatcher == nil {
319+
if len(fetchCtx.Platforms) == 0 {
320+
fetchCtx.PlatformMatcher = platforms.All
321+
} else {
322+
var ps []ocispec.Platform
323+
for _, s := range fetchCtx.Platforms {
324+
p, err := platforms.Parse(s)
325+
if err != nil {
326+
return images.Image{}, errors.Wrapf(err, "invalid platform %s", s)
327+
}
328+
ps = append(ps, p)
329+
}
330+
331+
fetchCtx.PlatformMatcher = platforms.Any(ps...)
332+
}
333+
}
334+
311335
ctx, done, err := c.WithLease(ctx)
312336
if err != nil {
313337
return images.Image{}, err
@@ -327,10 +351,19 @@ func (c *Client) Pull(ctx context.Context, ref string, opts ...RemoteOpt) (Image
327351
}
328352
}
329353

330-
if len(pullCtx.Platforms) > 1 {
331-
return nil, errors.New("cannot pull multiplatform image locally, try Fetch")
332-
} else if len(pullCtx.Platforms) == 0 {
333-
pullCtx.Platforms = []string{platforms.Default()}
354+
if pullCtx.PlatformMatcher == nil {
355+
if len(pullCtx.Platforms) > 1 {
356+
return nil, errors.New("cannot pull multiplatform image locally, try Fetch")
357+
} else if len(pullCtx.Platforms) == 0 {
358+
pullCtx.PlatformMatcher = platforms.Default()
359+
} else {
360+
p, err := platforms.Parse(pullCtx.Platforms[0])
361+
if err != nil {
362+
return nil, errors.Wrapf(err, "invalid platform %s", pullCtx.Platforms[0])
363+
}
364+
365+
pullCtx.PlatformMatcher = platforms.Only(p)
366+
}
334367
}
335368

336369
ctx, done, err := c.WithLease(ctx)
@@ -344,7 +377,7 @@ func (c *Client) Pull(ctx context.Context, ref string, opts ...RemoteOpt) (Image
344377
return nil, err
345378
}
346379

347-
i := NewImageWithPlatform(c, img, pullCtx.Platforms[0])
380+
i := NewImageWithPlatform(c, img, pullCtx.PlatformMatcher)
348381

349382
if pullCtx.Unpack {
350383
if err := i.Unpack(ctx, pullCtx.Snapshotter); err != nil {
@@ -380,7 +413,7 @@ func (c *Client) fetch(ctx context.Context, rCtx *RemoteContext, ref string) (im
380413
// Set any children labels for that content
381414
childrenHandler = images.SetChildrenLabels(store, childrenHandler)
382415
// Filter children by platforms
383-
childrenHandler = images.FilterPlatforms(childrenHandler, rCtx.Platforms...)
416+
childrenHandler = images.FilterPlatforms(childrenHandler, rCtx.PlatformMatcher)
384417

385418
handler = images.Handlers(append(rCtx.BaseHandlers,
386419
remotes.FetchHandler(store, fetcher),
@@ -437,13 +470,28 @@ func (c *Client) Push(ctx context.Context, ref string, desc ocispec.Descriptor,
437470
return err
438471
}
439472
}
473+
if pushCtx.PlatformMatcher == nil {
474+
if len(pushCtx.Platforms) > 0 {
475+
var ps []ocispec.Platform
476+
for _, platform := range pushCtx.Platforms {
477+
p, err := platforms.Parse(platform)
478+
if err != nil {
479+
return errors.Wrapf(err, "invalid platform %s", platform)
480+
}
481+
ps = append(ps, p)
482+
}
483+
pushCtx.PlatformMatcher = platforms.Any(ps...)
484+
} else {
485+
pushCtx.PlatformMatcher = platforms.All
486+
}
487+
}
440488

441489
pusher, err := pushCtx.Resolver.Pusher(ctx, ref)
442490
if err != nil {
443491
return err
444492
}
445493

446-
return remotes.PushContent(ctx, pusher, desc, c.ContentStore(), pushCtx.Platforms, pushCtx.BaseHandlers...)
494+
return remotes.PushContent(ctx, pusher, desc, c.ContentStore(), pushCtx.PlatformMatcher, pushCtx.BaseHandlers...)
447495
}
448496

449497
// GetImage returns an existing image

‎client_opts.go‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ type RemoteOpt func(*Client, *RemoteContext) error
8989
// content for
9090
func WithPlatform(platform string) RemoteOpt {
9191
if platform == "" {
92-
platform = platforms.Default()
92+
platform = platforms.DefaultString()
9393
}
9494
return func(_ *Client, c *RemoteContext) error {
9595
for _, p := range c.Platforms {
@@ -103,6 +103,16 @@ func WithPlatform(platform string) RemoteOpt {
103103
}
104104
}
105105

106+
// WithPlatformMatcher specifies the matcher to use for
107+
// determining which platforms to pull content for.
108+
// This value supersedes anything set with `WithPlatform`.
109+
func WithPlatformMatcher(m platforms.MatchComparer) RemoteOpt {
110+
return func(_ *Client, c *RemoteContext) error {
111+
c.PlatformMatcher = m
112+
return nil
113+
}
114+
}
115+
106116
// WithPullUnpack is used to unpack an image after pull. This
107117
// uses the snapshotter, content store, and diff service
108118
// configured for the client.

‎client_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ func TestImagePull(t *testing.T) {
185185

186186
ctx, cancel := testContext()
187187
defer cancel()
188-
_, err = client.Pull(ctx, testImage, WithPlatform(platforms.Default()))
188+
_, err = client.Pull(ctx, testImage, WithPlatformMatcher(platforms.Default()))
189189
if err != nil {
190190
t.Fatal(err)
191191
}
@@ -304,7 +304,7 @@ func TestImagePullSchema1(t *testing.T) {
304304
ctx, cancel := testContext()
305305
defer cancel()
306306
schema1TestImage := "gcr.io/google_containers/pause:3.0@sha256:0d093c962a6c2dd8bb8727b661e2b5f13e9df884af9945b4cc7088d9350cd3ee"
307-
_, err = client.Pull(ctx, schema1TestImage, WithPlatform(platforms.Default()), WithSchema1Conversion)
307+
_, err = client.Pull(ctx, schema1TestImage, WithPlatform(platforms.DefaultString()), WithSchema1Conversion)
308308
if err != nil {
309309
t.Fatal(err)
310310
}

‎cmd/ctr/commands/content/fetch.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func NewFetchConfig(ctx context.Context, clicontext *cli.Context) (*FetchConfig,
113113
if !clicontext.Bool("all-platforms") {
114114
p := clicontext.StringSlice("platform")
115115
if len(p) == 0 {
116-
p = append(p, platforms.Default())
116+
p = append(p, platforms.DefaultString())
117117
}
118118
config.Platforms = p
119119
}

‎cmd/ctr/commands/images/pull.go‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import (
2525
"github.com/containerd/containerd/images"
2626
"github.com/containerd/containerd/log"
2727
"github.com/containerd/containerd/platforms"
28+
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
2829
"github.com/pkg/errors"
2930
"github.com/urfave/cli"
3031
)
@@ -86,26 +87,28 @@ command. As part of this process, we do the following:
8687

8788
// TODO: Show unpack status
8889

89-
var p []string
90+
var p []ocispec.Platform
9091
if context.Bool("all-platforms") {
91-
all, err := images.Platforms(ctx, client.ContentStore(), img.Target)
92+
p, err = images.Platforms(ctx, client.ContentStore(), img.Target)
9293
if err != nil {
9394
return errors.Wrap(err, "unable to resolve image platforms")
9495
}
95-
p = make([]string, len(all))
96-
for i := range all {
97-
p[i] = platforms.Format(all[i])
98-
}
9996
} else {
100-
p = context.StringSlice("platform")
97+
for _, s := range context.StringSlice("platform") {
98+
ps, err := platforms.Parse(s)
99+
if err != nil {
100+
return errors.Wrapf(err, "unable to parse platform %s", s)
101+
}
102+
p = append(p, ps)
103+
}
101104
}
102105
if len(p) == 0 {
103-
p = append(p, platforms.Default())
106+
p = append(p, platforms.DefaultSpec())
104107
}
105108

106109
for _, platform := range p {
107-
fmt.Printf("unpacking %s %s...\n", platform, img.Target.Digest)
108-
i := containerd.NewImageWithPlatform(client, img, platform)
110+
fmt.Printf("unpacking %s %s...\n", platforms.Format(platform), img.Target.Digest)
111+
i := containerd.NewImageWithPlatform(client, img, platforms.Only(platform))
109112
err = i.Unpack(ctx, context.String("snapshotter"))
110113
if err != nil {
111114
return err

‎image.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ func NewImage(client *Client, i images.Image) Image {
6363
}
6464

6565
// NewImageWithPlatform returns a client image object from the metadata image
66-
func NewImageWithPlatform(client *Client, i images.Image, platform string) Image {
66+
func NewImageWithPlatform(client *Client, i images.Image, platform platforms.MatchComparer) Image {
6767
return &image{
6868
client: client,
6969
i: i,
@@ -75,7 +75,7 @@ type image struct {
7575
client *Client
7676

7777
i images.Image
78-
platform string
78+
platform platforms.MatchComparer
7979
}
8080

8181
func (i *image) Name() string {
@@ -186,7 +186,7 @@ func (i *image) Unpack(ctx context.Context, snapshotterName string) error {
186186
return nil
187187
}
188188

189-
func (i *image) getLayers(ctx context.Context, platform string) ([]rootfs.Layer, error) {
189+
func (i *image) getLayers(ctx context.Context, platform platforms.MatchComparer) ([]rootfs.Layer, error) {
190190
cs := i.client.ContentStore()
191191

192192
manifest, err := images.Manifest(ctx, cs, i.i.Target, platform)

‎images/handlers.go‎

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -182,31 +182,61 @@ func SetChildrenLabels(manager content.Manager, f HandlerFunc) HandlerFunc {
182182
}
183183
}
184184

185-
// FilterPlatforms is a handler wrapper which limits the descriptors returned
185+
// FilterPlatformList is a handler wrapper which limits the descriptors returned
186186
// by a handler to the specified platforms.
187-
func FilterPlatforms(f HandlerFunc, platformList ...string) HandlerFunc {
187+
func FilterPlatformList(f HandlerFunc, platformList ...string) HandlerFunc {
188188
return func(ctx context.Context, desc ocispec.Descriptor) ([]ocispec.Descriptor, error) {
189189
children, err := f(ctx, desc)
190190
if err != nil {
191191
return children, err
192192
}
193193

194-
var descs []ocispec.Descriptor
195-
196194
if len(platformList) == 0 {
197-
descs = children
198-
} else {
199-
for _, platform := range platformList {
195+
return children, nil
196+
}
197+
198+
var m platforms.Matcher
199+
200+
if len(platformList) > 0 {
201+
ps := make([]ocispec.Platform, len(platformList))
202+
for i, platform := range platformList {
200203
p, err := platforms.Parse(platform)
201204
if err != nil {
202205
return nil, err
203206
}
204-
matcher := platforms.NewMatcher(p)
207+
ps[i] = p
208+
}
209+
m = platforms.Any(ps...)
210+
}
205211

206-
for _, d := range children {
207-
if d.Platform == nil || matcher.Match(*d.Platform) {
208-
descs = append(descs, d)
209-
}
212+
var descs []ocispec.Descriptor
213+
for _, d := range children {
214+
if d.Platform == nil || m.Match(*d.Platform) {
215+
descs = append(descs, d)
216+
}
217+
}
218+
219+
return descs, nil
220+
}
221+
}
222+
223+
// FilterPlatforms is a handler wrapper which limits the descriptors returned
224+
// based on matching the specified platform matcher.
225+
func FilterPlatforms(f HandlerFunc, m platforms.Matcher) HandlerFunc {
226+
return func(ctx context.Context, desc ocispec.Descriptor) ([]ocispec.Descriptor, error) {
227+
children, err := f(ctx, desc)
228+
if err != nil {
229+
return children, err
230+
}
231+
232+
var descs []ocispec.Descriptor
233+
234+
if m == nil {
235+
descs = children
236+
} else {
237+
for _, d := range children {
238+
if d.Platform == nil || m.Match(*d.Platform) {
239+
descs = append(descs, d)
210240
}
211241
}
212242
}

0 commit comments

Comments
 (0)