forked from containerd/containerd
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Go example: ```go opts := []converter.Opt{ // convert Docker media types to OCI ones converter.WithDocker2OCI(true), // convert tar.gz layers to uncompressed tar layers converter.WithLayerConvertFunc(uncompress.LayerConvertFunc), } srcRef := "example.com/foo:orig" dstRef := "example.com/foo:converted" dstImg, err = converter.Convert(ctx, client, dstRef, srcRef, opts...) fmt.Println(dstImg.Target) ``` ctr example: `ctr images convert --oci --uncompress example.com/foo:orig example.com/foo:converted` Go test: `go test -exec sudo -test.root -test.run TestConvert` The implementation is from containerd/stargz-snapshotter#224, but eStargz-specific functions are not included in this PR. eStargz converter can be specified by importing `estargz` package and using `WithLayerConvertFunc(estargz.LayerConvertFunc)` option. This converter interface will be potentially useful for converting zstd and ocicrypt layers as well. Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
- Loading branch information
1 parent
9b9de47
commit 5ca3ac6
Showing
9 changed files
with
1,024 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,108 @@ | ||
/* | ||
Copyright The containerd Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package images | ||
|
||
import ( | ||
"fmt" | ||
|
||
"github.com/containerd/containerd/cmd/ctr/commands" | ||
"github.com/containerd/containerd/images/converter" | ||
"github.com/containerd/containerd/images/converter/uncompress" | ||
"github.com/containerd/containerd/platforms" | ||
ocispec "github.com/opencontainers/image-spec/specs-go/v1" | ||
"github.com/pkg/errors" | ||
"github.com/urfave/cli" | ||
) | ||
|
||
var convertCommand = cli.Command{ | ||
Name: "convert", | ||
Usage: "convert an image", | ||
ArgsUsage: "[flags] <source_ref> <target_ref>", | ||
Description: `Convert an image format. | ||
e.g., 'ctr convert --uncompress --oci example.com/foo:orig example.com/foo:converted' | ||
Use '--platform' to define the output platform. | ||
When '--all-platforms' is given all images in a manifest list must be available. | ||
`, | ||
Flags: []cli.Flag{ | ||
// generic flags | ||
cli.BoolFlag{ | ||
Name: "uncompress", | ||
Usage: "convert tar.gz layers to uncompressed tar layers", | ||
}, | ||
cli.BoolFlag{ | ||
Name: "oci", | ||
Usage: "convert Docker media types to OCI media types", | ||
}, | ||
// platform flags | ||
cli.StringSliceFlag{ | ||
Name: "platform", | ||
Usage: "Pull content from a specific platform", | ||
Value: &cli.StringSlice{}, | ||
}, | ||
cli.BoolFlag{ | ||
Name: "all-platforms", | ||
Usage: "exports content from all platforms", | ||
}, | ||
}, | ||
Action: func(context *cli.Context) error { | ||
var convertOpts []converter.Opt | ||
srcRef := context.Args().Get(0) | ||
targetRef := context.Args().Get(1) | ||
if srcRef == "" || targetRef == "" { | ||
return errors.New("src and target image need to be specified") | ||
} | ||
|
||
if !context.Bool("all-platforms") { | ||
if pss := context.StringSlice("platform"); len(pss) > 0 { | ||
var all []ocispec.Platform | ||
for _, ps := range pss { | ||
p, err := platforms.Parse(ps) | ||
if err != nil { | ||
return errors.Wrapf(err, "invalid platform %q", ps) | ||
} | ||
all = append(all, p) | ||
} | ||
convertOpts = append(convertOpts, converter.WithPlatform(platforms.Ordered(all...))) | ||
} else { | ||
convertOpts = append(convertOpts, converter.WithPlatform(platforms.DefaultStrict())) | ||
} | ||
} | ||
|
||
if context.Bool("uncompress") { | ||
convertOpts = append(convertOpts, converter.WithLayerConvertFunc(uncompress.LayerConvertFunc)) | ||
} | ||
|
||
if context.Bool("oci") { | ||
convertOpts = append(convertOpts, converter.WithDockerToOCI(true)) | ||
} | ||
|
||
client, ctx, cancel, err := commands.NewClient(context) | ||
if err != nil { | ||
return err | ||
} | ||
defer cancel() | ||
|
||
newImg, err := converter.Convert(ctx, client, targetRef, srcRef, convertOpts...) | ||
if err != nil { | ||
return err | ||
} | ||
fmt.Fprintln(context.App.Writer, newImg.Target.Digest.String()) | ||
return nil | ||
}, | ||
} |
This file contains 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 |
---|---|---|
|
@@ -50,6 +50,7 @@ var Command = cli.Command{ | |
removeCommand, | ||
tagCommand, | ||
setLabelsCommand, | ||
convertCommand, | ||
}, | ||
} | ||
|
||
|
This file contains 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 |
---|---|---|
@@ -0,0 +1,88 @@ | ||
/* | ||
Copyright The containerd Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package containerd | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/containerd/containerd/images" | ||
"github.com/containerd/containerd/images/converter" | ||
"github.com/containerd/containerd/images/converter/uncompress" | ||
"github.com/containerd/containerd/platforms" | ||
ocispec "github.com/opencontainers/image-spec/specs-go/v1" | ||
"gotest.tools/v3/assert" | ||
) | ||
|
||
// TestConvert creates an image from testImage, with the following conversion: | ||
// - Media type: Docker -> OCI | ||
// - Layer type: tar.gz -> tar | ||
// - Arch: Multi -> Single | ||
func TestConvert(t *testing.T) { | ||
if testing.Short() { | ||
t.Skip() | ||
} | ||
ctx, cancel := testContext(t) | ||
defer cancel() | ||
|
||
client, err := New(address) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
defer client.Close() | ||
|
||
_, err = client.Fetch(ctx, testImage) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
dstRef := testImage + "-testconvert" | ||
defPlat := platforms.DefaultStrict() | ||
opts := []converter.Opt{ | ||
converter.WithDockerToOCI(true), | ||
converter.WithLayerConvertFunc(uncompress.LayerConvertFunc), | ||
converter.WithPlatform(defPlat), | ||
} | ||
dstImg, err := converter.Convert(ctx, client, dstRef, testImage, opts...) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
defer func() { | ||
if deleteErr := client.ImageService().Delete(ctx, dstRef); deleteErr != nil { | ||
t.Fatal(deleteErr) | ||
} | ||
}() | ||
cs := client.ContentStore() | ||
plats, err := images.Platforms(ctx, cs, dstImg.Target) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
// Assert that the image does not have any extra arch. | ||
assert.Equal(t, 1, len(plats)) | ||
assert.Check(t, defPlat.Match(plats[0])) | ||
|
||
// Assert that the media type is converted to OCI and also uncompressed | ||
mani, err := images.Manifest(ctx, cs, dstImg.Target, defPlat) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
for _, l := range mani.Layers { | ||
if plats[0].OS == "windows" { | ||
assert.Equal(t, ocispec.MediaTypeImageLayerNonDistributable, l.MediaType) | ||
} else { | ||
assert.Equal(t, ocispec.MediaTypeImageLayer, l.MediaType) | ||
} | ||
} | ||
} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,126 @@ | ||
/* | ||
Copyright The containerd Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
// Package converter provides image converter | ||
package converter | ||
|
||
import ( | ||
"context" | ||
|
||
"github.com/containerd/containerd/content" | ||
"github.com/containerd/containerd/images" | ||
"github.com/containerd/containerd/leases" | ||
"github.com/containerd/containerd/platforms" | ||
) | ||
|
||
type convertOpts struct { | ||
layerConvertFunc ConvertFunc | ||
docker2oci bool | ||
indexConvertFunc ConvertFunc | ||
platformMC platforms.MatchComparer | ||
} | ||
|
||
// Opt is an option for Convert() | ||
type Opt func(*convertOpts) error | ||
|
||
// WithLayerConvertFunc specifies the function that converts layers. | ||
func WithLayerConvertFunc(fn ConvertFunc) Opt { | ||
return func(copts *convertOpts) error { | ||
copts.layerConvertFunc = fn | ||
return nil | ||
} | ||
} | ||
|
||
// WithDockerToOCI converts Docker media types into OCI ones. | ||
func WithDockerToOCI(v bool) Opt { | ||
return func(copts *convertOpts) error { | ||
copts.docker2oci = true | ||
return nil | ||
} | ||
} | ||
|
||
// WithPlatform specifies the platform. | ||
// Defaults to all platforms. | ||
func WithPlatform(p platforms.MatchComparer) Opt { | ||
return func(copts *convertOpts) error { | ||
copts.platformMC = p | ||
return nil | ||
} | ||
} | ||
|
||
// WithIndexConvertFunc specifies the function that converts manifests and index (manifest lists). | ||
// Defaults to DefaultIndexConvertFunc. | ||
func WithIndexConvertFunc(fn ConvertFunc) Opt { | ||
return func(copts *convertOpts) error { | ||
copts.indexConvertFunc = fn | ||
return nil | ||
} | ||
} | ||
|
||
// Client is implemented by *containerd.Client . | ||
type Client interface { | ||
WithLease(ctx context.Context, opts ...leases.Opt) (context.Context, func(context.Context) error, error) | ||
ContentStore() content.Store | ||
ImageService() images.Store | ||
} | ||
|
||
// Convert converts an image. | ||
func Convert(ctx context.Context, client Client, dstRef, srcRef string, opts ...Opt) (*images.Image, error) { | ||
var copts convertOpts | ||
for _, o := range opts { | ||
if err := o(&copts); err != nil { | ||
return nil, err | ||
} | ||
} | ||
if copts.platformMC == nil { | ||
copts.platformMC = platforms.All | ||
} | ||
if copts.indexConvertFunc == nil { | ||
copts.indexConvertFunc = DefaultIndexConvertFunc(copts.layerConvertFunc, copts.docker2oci, copts.platformMC) | ||
} | ||
|
||
ctx, done, err := client.WithLease(ctx) | ||
if err != nil { | ||
return nil, err | ||
} | ||
defer done(ctx) | ||
|
||
cs := client.ContentStore() | ||
is := client.ImageService() | ||
srcImg, err := is.Get(ctx, srcRef) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
dstDesc, err := copts.indexConvertFunc(ctx, cs, srcImg.Target) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
dstImg := srcImg | ||
dstImg.Name = dstRef | ||
if dstDesc != nil { | ||
dstImg.Target = *dstDesc | ||
} | ||
var res images.Image | ||
if dstRef != srcRef { | ||
_ = is.Delete(ctx, dstRef) | ||
res, err = is.Create(ctx, dstImg) | ||
} else { | ||
res, err = is.Update(ctx, dstImg) | ||
} | ||
return &res, err | ||
} |
Oops, something went wrong.