Skip to content

Commit 3a916a0

Browse files
dmcgowandmcgowan
committed
Update client Image to have configurable platform
Separate Fetch and Pull commands in client to distinguish between platform specific and non-platform specific operations. `ctr images pull` with all platforms will now unpack all platforms. `ctr content fetch` now supports platform flags. Signed-off-by: Derek McGowan <[email protected]>
1 parent fb1084d commit 3a916a0

File tree

7 files changed

+151
-60
lines changed

7 files changed

+151
-60
lines changed

‎client.go

+70-30
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ import (
4545
"github.com/containerd/containerd/images"
4646
"github.com/containerd/containerd/namespaces"
4747
"github.com/containerd/containerd/pkg/dialer"
48+
"github.com/containerd/containerd/platforms"
4849
"github.com/containerd/containerd/plugin"
4950
"github.com/containerd/containerd/remotes"
5051
"github.com/containerd/containerd/remotes/docker"
@@ -284,98 +285,137 @@ func defaultRemoteContext() *RemoteContext {
284285
}
285286
}
286287

288+
// Fetch downloads the provided content into containerd's content store
289+
// and returns a non-platform specific image reference
290+
func (c *Client) Fetch(ctx context.Context, ref string, opts ...RemoteOpt) (images.Image, error) {
291+
fetchCtx := defaultRemoteContext()
292+
for _, o := range opts {
293+
if err := o(c, fetchCtx); err != nil {
294+
return images.Image{}, err
295+
}
296+
}
297+
298+
if fetchCtx.Unpack {
299+
return images.Image{}, errors.New("unpack on fetch not supported, try pull")
300+
}
301+
302+
ctx, done, err := c.WithLease(ctx)
303+
if err != nil {
304+
return images.Image{}, err
305+
}
306+
defer done(ctx)
307+
308+
return c.fetch(ctx, fetchCtx, ref)
309+
}
310+
287311
// Pull downloads the provided content into containerd's content store
312+
// and returns a platform specific image object
288313
func (c *Client) Pull(ctx context.Context, ref string, opts ...RemoteOpt) (Image, error) {
289314
pullCtx := defaultRemoteContext()
290315
for _, o := range opts {
291316
if err := o(c, pullCtx); err != nil {
292317
return nil, err
293318
}
294319
}
295-
store := c.ContentStore()
320+
321+
if len(pullCtx.Platforms) > 1 {
322+
return nil, errors.New("cannot pull multiplatform image locally, try Fetch")
323+
} else if len(pullCtx.Platforms) == 0 {
324+
pullCtx.Platforms = []string{platforms.Default()}
325+
}
296326

297327
ctx, done, err := c.WithLease(ctx)
298328
if err != nil {
299329
return nil, err
300330
}
301331
defer done(ctx)
302332

303-
name, desc, err := pullCtx.Resolver.Resolve(ctx, ref)
333+
img, err := c.fetch(ctx, pullCtx, ref)
304334
if err != nil {
305-
return nil, errors.Wrapf(err, "failed to resolve reference %q", ref)
335+
return nil, err
306336
}
307337

308-
fetcher, err := pullCtx.Resolver.Fetcher(ctx, name)
338+
i := NewImageWithPlatform(c, img, pullCtx.Platforms[0])
339+
340+
if pullCtx.Unpack {
341+
if err := i.Unpack(ctx, pullCtx.Snapshotter); err != nil {
342+
return nil, errors.Wrapf(err, "failed to unpack image on snapshotter %s", pullCtx.Snapshotter)
343+
}
344+
}
345+
346+
return i, nil
347+
}
348+
349+
func (c *Client) fetch(ctx context.Context, rCtx *RemoteContext, ref string) (images.Image, error) {
350+
store := c.ContentStore()
351+
name, desc, err := rCtx.Resolver.Resolve(ctx, ref)
309352
if err != nil {
310-
return nil, errors.Wrapf(err, "failed to get fetcher for %q", name)
353+
return images.Image{}, errors.Wrapf(err, "failed to resolve reference %q", ref)
354+
}
355+
356+
fetcher, err := rCtx.Resolver.Fetcher(ctx, name)
357+
if err != nil {
358+
return images.Image{}, errors.Wrapf(err, "failed to get fetcher for %q", name)
311359
}
312360

313361
var (
314362
schema1Converter *schema1.Converter
315363
handler images.Handler
316364
)
317-
if desc.MediaType == images.MediaTypeDockerSchema1Manifest && pullCtx.ConvertSchema1 {
365+
if desc.MediaType == images.MediaTypeDockerSchema1Manifest && rCtx.ConvertSchema1 {
318366
schema1Converter = schema1.NewConverter(store, fetcher)
319-
handler = images.Handlers(append(pullCtx.BaseHandlers, schema1Converter)...)
367+
handler = images.Handlers(append(rCtx.BaseHandlers, schema1Converter)...)
320368
} else {
321369
// Get all the children for a descriptor
322370
childrenHandler := images.ChildrenHandler(store)
323371
// Set any children labels for that content
324372
childrenHandler = images.SetChildrenLabels(store, childrenHandler)
325373
// Filter children by platforms
326-
childrenHandler = images.FilterPlatforms(childrenHandler, pullCtx.Platforms...)
374+
childrenHandler = images.FilterPlatforms(childrenHandler, rCtx.Platforms...)
327375

328-
handler = images.Handlers(append(pullCtx.BaseHandlers,
376+
handler = images.Handlers(append(rCtx.BaseHandlers,
329377
remotes.FetchHandler(store, fetcher),
330378
childrenHandler,
331379
)...)
332380
}
333381

334382
if err := images.Dispatch(ctx, handler, desc); err != nil {
335-
return nil, err
383+
return images.Image{}, err
336384
}
337385
if schema1Converter != nil {
338386
desc, err = schema1Converter.Convert(ctx)
339387
if err != nil {
340-
return nil, err
388+
return images.Image{}, err
341389
}
342390
}
343391

344-
img := &image{
345-
client: c,
346-
i: images.Image{
347-
Name: name,
348-
Target: desc,
349-
Labels: pullCtx.Labels,
350-
},
351-
}
352-
353-
if pullCtx.Unpack {
354-
if err := img.Unpack(ctx, pullCtx.Snapshotter); err != nil {
355-
return nil, errors.Wrapf(err, "failed to unpack image on snapshotter %s", pullCtx.Snapshotter)
356-
}
392+
img := images.Image{
393+
Name: name,
394+
Target: desc,
395+
Labels: rCtx.Labels,
357396
}
358397

359398
is := c.ImageService()
360399
for {
361-
if created, err := is.Create(ctx, img.i); err != nil {
400+
if created, err := is.Create(ctx, img); err != nil {
362401
if !errdefs.IsAlreadyExists(err) {
363-
return nil, err
402+
return images.Image{}, err
364403
}
365404

366-
updated, err := is.Update(ctx, img.i)
405+
updated, err := is.Update(ctx, img)
367406
if err != nil {
368407
// if image was removed, try create again
369408
if errdefs.IsNotFound(err) {
370409
continue
371410
}
372-
return nil, err
411+
return images.Image{}, err
373412
}
374413

375-
img.i = updated
414+
img = updated
376415
} else {
377-
img.i = created
416+
img = created
378417
}
418+
379419
return img, nil
380420
}
381421
}

‎client_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func TestMain(m *testing.M) {
111111
}).Info("running tests against containerd")
112112

113113
// pull a seed image
114-
if _, err = client.Pull(ctx, testImage, WithPullUnpack, WithPlatform(platforms.Default())); err != nil {
114+
if _, err = client.Pull(ctx, testImage, WithPullUnpack); err != nil {
115115
ctrd.Stop()
116116
ctrd.Wait()
117117
fmt.Fprintf(os.Stderr, "%s: %s\n", err, buf.String())
@@ -198,11 +198,11 @@ func TestImagePullAllPlatforms(t *testing.T) {
198198
defer cancel()
199199

200200
cs := client.ContentStore()
201-
img, err := client.Pull(ctx, testImage)
201+
img, err := client.Fetch(ctx, testImage)
202202
if err != nil {
203203
t.Fatal(err)
204204
}
205-
index := img.Target()
205+
index := img.Target
206206
manifests, err := images.Children(ctx, cs, index)
207207
if err != nil {
208208
t.Fatal(err)
@@ -246,12 +246,12 @@ func TestImagePullSomePlatforms(t *testing.T) {
246246
opts = append(opts, WithPlatform(platform))
247247
}
248248

249-
img, err := client.Pull(ctx, "docker.io/library/busybox:latest", opts...)
249+
img, err := client.Fetch(ctx, "docker.io/library/busybox:latest", opts...)
250250
if err != nil {
251251
t.Fatal(err)
252252
}
253253

254-
index := img.Target()
254+
index := img.Target
255255
manifests, err := images.Children(ctx, cs, index)
256256
if err != nil {
257257
t.Fatal(err)

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

+20-6
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import (
3232
"github.com/containerd/containerd/images"
3333
"github.com/containerd/containerd/log"
3434
"github.com/containerd/containerd/pkg/progress"
35+
"github.com/containerd/containerd/platforms"
3536
"github.com/containerd/containerd/remotes"
3637
digest "github.com/opencontainers/go-digest"
3738
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
@@ -56,7 +57,16 @@ not use this implementation as a guide. The end goal should be having metadata,
5657
content and snapshots ready for a direct use via the 'ctr run'.
5758
5859
Most of this is experimental and there are few leaps to make this work.`,
59-
Flags: append(commands.RegistryFlags, commands.LabelFlag),
60+
Flags: append(commands.RegistryFlags, commands.LabelFlag,
61+
cli.StringSliceFlag{
62+
Name: "platform",
63+
Usage: "Pull content from a specific platform",
64+
},
65+
cli.BoolFlag{
66+
Name: "all-platforms",
67+
Usage: "pull content from all platforms",
68+
},
69+
),
6070
Action: func(clicontext *cli.Context) error {
6171
var (
6272
ref = clicontext.Args().First()
@@ -73,10 +83,10 @@ Most of this is experimental and there are few leaps to make this work.`,
7383
}
7484

7585
// Fetch loads all resources into the content store and returns the image
76-
func Fetch(ctx context.Context, client *containerd.Client, ref string, cliContext *cli.Context) (containerd.Image, error) {
86+
func Fetch(ctx context.Context, client *containerd.Client, ref string, cliContext *cli.Context) (images.Image, error) {
7787
resolver, err := commands.GetResolver(ctx, cliContext)
7888
if err != nil {
79-
return nil, err
89+
return images.Image{}, err
8090
}
8191

8292
ongoing := newJobs(ref)
@@ -109,15 +119,19 @@ func Fetch(ctx context.Context, client *containerd.Client, ref string, cliContex
109119
}
110120

111121
if !cliContext.Bool("all-platforms") {
112-
for _, platform := range cliContext.StringSlice("platform") {
122+
p := cliContext.StringSlice("platform")
123+
if len(p) == 0 {
124+
p = append(p, platforms.Default())
125+
}
126+
for _, platform := range p {
113127
opts = append(opts, containerd.WithPlatform(platform))
114128
}
115129
}
116130

117-
img, err := client.Pull(pctx, ref, opts...)
131+
img, err := client.Fetch(pctx, ref, opts...)
118132
stopProgress()
119133
if err != nil {
120-
return nil, err
134+
return images.Image{}, err
121135
}
122136

123137
<-progress

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

+32-6
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@ package images
1919
import (
2020
"fmt"
2121

22+
"github.com/containerd/containerd"
2223
"github.com/containerd/containerd/cmd/ctr/commands"
2324
"github.com/containerd/containerd/cmd/ctr/commands/content"
25+
"github.com/containerd/containerd/images"
2426
"github.com/containerd/containerd/log"
2527
"github.com/containerd/containerd/platforms"
28+
"github.com/pkg/errors"
2629
"github.com/urfave/cli"
2730
)
2831

@@ -43,7 +46,7 @@ command. As part of this process, we do the following:
4346
cli.StringSliceFlag{
4447
Name: "platform",
4548
Usage: "Pull content from a specific platform",
46-
Value: &cli.StringSlice{platforms.Default()},
49+
Value: &cli.StringSlice{},
4750
},
4851
cli.BoolFlag{
4952
Name: "all-platforms",
@@ -78,11 +81,34 @@ command. As part of this process, we do the following:
7881
log.G(ctx).WithField("image", ref).Debug("unpacking")
7982

8083
// TODO: Show unpack status
81-
fmt.Printf("unpacking %s...\n", img.Target().Digest)
82-
err = img.Unpack(ctx, context.String("snapshotter"))
83-
if err == nil {
84-
fmt.Println("done")
84+
85+
var p []string
86+
if context.Bool("all-platforms") {
87+
all, err := images.Platforms(ctx, client.ContentStore(), img.Target)
88+
if err != nil {
89+
return errors.Wrap(err, "unable to resolve image platforms")
90+
}
91+
p = make([]string, len(all))
92+
for i := range all {
93+
p[i] = platforms.Format(all[i])
94+
}
95+
} else {
96+
p = context.StringSlice("platform")
97+
}
98+
if len(p) == 0 {
99+
p = append(p, platforms.Default())
85100
}
86-
return err
101+
102+
for _, platform := range p {
103+
fmt.Printf("unpacking %s %s...\n", platform, img.Target.Digest)
104+
i := containerd.NewImageWithPlatform(client, img, platform)
105+
err = i.Unpack(ctx, context.String("snapshotter"))
106+
if err != nil {
107+
return err
108+
}
109+
}
110+
111+
fmt.Println("done")
112+
return nil
87113
},
88114
}

‎export_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ func TestOCIExport(t *testing.T) {
4040
}
4141
defer client.Close()
4242

43-
pulled, err := client.Pull(ctx, testImage)
43+
pulled, err := client.Fetch(ctx, testImage)
4444
if err != nil {
4545
t.Fatal(err)
4646
}
47-
exportedStream, err := client.Export(ctx, &oci.V1Exporter{}, pulled.Target())
47+
exportedStream, err := client.Export(ctx, &oci.V1Exporter{}, pulled.Target)
4848
if err != nil {
4949
t.Fatal(err)
5050
}

0 commit comments

Comments
 (0)