429 lines
11 KiB
Go
429 lines
11 KiB
Go
/*
|
|
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 (
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"sort"
|
|
"strings"
|
|
"text/tabwriter"
|
|
|
|
"github.com/containerd/containerd/cmd/ctr/commands"
|
|
"github.com/containerd/containerd/errdefs"
|
|
"github.com/containerd/containerd/images"
|
|
"github.com/containerd/containerd/log"
|
|
"github.com/containerd/containerd/pkg/progress"
|
|
"github.com/containerd/containerd/platforms"
|
|
"github.com/urfave/cli"
|
|
)
|
|
|
|
// Command is the cli command for managing images
|
|
var Command = cli.Command{
|
|
Name: "images",
|
|
Aliases: []string{"image", "i"},
|
|
Usage: "manage images",
|
|
Subcommands: cli.Commands{
|
|
checkCommand,
|
|
exportCommand,
|
|
importCommand,
|
|
listCommand,
|
|
mountCommand,
|
|
unmountCommand,
|
|
pullCommand,
|
|
pushCommand,
|
|
pruneCommand,
|
|
removeCommand,
|
|
tagCommand,
|
|
setLabelsCommand,
|
|
convertCommand,
|
|
},
|
|
}
|
|
|
|
var listCommand = cli.Command{
|
|
Name: "list",
|
|
Aliases: []string{"ls"},
|
|
Usage: "list images known to containerd",
|
|
ArgsUsage: "[flags] [<filter>, ...]",
|
|
Description: "list images registered with containerd",
|
|
Flags: []cli.Flag{
|
|
cli.BoolFlag{
|
|
Name: "quiet, q",
|
|
Usage: "Print only the image refs",
|
|
},
|
|
},
|
|
Action: func(context *cli.Context) error {
|
|
var (
|
|
filters = context.Args()
|
|
quiet = context.Bool("quiet")
|
|
)
|
|
client, ctx, cancel, err := commands.NewClient(context)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer cancel()
|
|
var (
|
|
imageStore = client.ImageService()
|
|
cs = client.ContentStore()
|
|
)
|
|
imageList, err := imageStore.List(ctx, filters...)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to list images: %w", err)
|
|
}
|
|
if quiet {
|
|
for _, image := range imageList {
|
|
fmt.Println(image.Name)
|
|
}
|
|
return nil
|
|
}
|
|
tw := tabwriter.NewWriter(os.Stdout, 1, 8, 1, ' ', 0)
|
|
fmt.Fprintln(tw, "REF\tTYPE\tDIGEST\tSIZE\tPLATFORMS\tLABELS\t")
|
|
for _, image := range imageList {
|
|
size, err := image.Size(ctx, cs, platforms.Default())
|
|
if err != nil {
|
|
log.G(ctx).WithError(err).Errorf("failed calculating size for image %s", image.Name)
|
|
}
|
|
|
|
platformColumn := "-"
|
|
specs, err := images.Platforms(ctx, cs, image.Target)
|
|
if err != nil {
|
|
log.G(ctx).WithError(err).Errorf("failed resolving platform for image %s", image.Name)
|
|
} else if len(specs) > 0 {
|
|
psm := map[string]struct{}{}
|
|
for _, p := range specs {
|
|
psm[platforms.Format(p)] = struct{}{}
|
|
}
|
|
var ps []string
|
|
for p := range psm {
|
|
ps = append(ps, p)
|
|
}
|
|
sort.Stable(sort.StringSlice(ps))
|
|
platformColumn = strings.Join(ps, ",")
|
|
}
|
|
|
|
labels := "-"
|
|
if len(image.Labels) > 0 {
|
|
var pairs []string
|
|
for k, v := range image.Labels {
|
|
pairs = append(pairs, fmt.Sprintf("%v=%v", k, v))
|
|
}
|
|
sort.Strings(pairs)
|
|
labels = strings.Join(pairs, ",")
|
|
}
|
|
|
|
fmt.Fprintf(tw, "%v\t%v\t%v\t%v\t%v\t%s\t\n",
|
|
image.Name,
|
|
image.Target.MediaType,
|
|
image.Target.Digest,
|
|
progress.Bytes(size),
|
|
platformColumn,
|
|
labels)
|
|
}
|
|
|
|
return tw.Flush()
|
|
},
|
|
}
|
|
|
|
var setLabelsCommand = cli.Command{
|
|
Name: "label",
|
|
Usage: "set and clear labels for an image",
|
|
ArgsUsage: "[flags] <name> [<key>=<value>, ...]",
|
|
Description: "set and clear labels for an image",
|
|
Flags: []cli.Flag{
|
|
cli.BoolFlag{
|
|
Name: "replace-all, r",
|
|
Usage: "Replace all labels",
|
|
},
|
|
},
|
|
Action: func(context *cli.Context) error {
|
|
var (
|
|
replaceAll = context.Bool("replace-all")
|
|
name, labels = commands.ObjectWithLabelArgs(context)
|
|
)
|
|
client, ctx, cancel, err := commands.NewClient(context)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer cancel()
|
|
if name == "" {
|
|
return errors.New("please specify an image")
|
|
}
|
|
|
|
var (
|
|
is = client.ImageService()
|
|
fieldpaths []string
|
|
)
|
|
|
|
for k := range labels {
|
|
if replaceAll {
|
|
fieldpaths = append(fieldpaths, "labels")
|
|
} else {
|
|
fieldpaths = append(fieldpaths, strings.Join([]string{"labels", k}, "."))
|
|
}
|
|
}
|
|
|
|
image := images.Image{
|
|
Name: name,
|
|
Labels: labels,
|
|
}
|
|
|
|
updated, err := is.Update(ctx, image, fieldpaths...)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
var labelStrings []string
|
|
for k, v := range updated.Labels {
|
|
labelStrings = append(labelStrings, fmt.Sprintf("%s=%s", k, v))
|
|
}
|
|
|
|
fmt.Println(strings.Join(labelStrings, ","))
|
|
|
|
return nil
|
|
},
|
|
}
|
|
|
|
var checkCommand = cli.Command{
|
|
Name: "check",
|
|
Usage: "check existing images to ensure all content is available locally",
|
|
ArgsUsage: "[flags] [<filter>, ...]",
|
|
Description: "check existing images to ensure all content is available locally",
|
|
Flags: append([]cli.Flag{
|
|
cli.BoolFlag{
|
|
Name: "quiet, q",
|
|
Usage: "Print only the ready image refs (fully downloaded and unpacked)",
|
|
},
|
|
}, commands.SnapshotterFlags...),
|
|
Action: func(context *cli.Context) error {
|
|
var (
|
|
exitErr error
|
|
quiet = context.Bool("quiet")
|
|
)
|
|
client, ctx, cancel, err := commands.NewClient(context)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer cancel()
|
|
|
|
var contentStore = client.ContentStore()
|
|
|
|
args := []string(context.Args())
|
|
imageList, err := client.ListImages(ctx, args...)
|
|
if err != nil {
|
|
return fmt.Errorf("failed listing images: %w", err)
|
|
}
|
|
if len(imageList) == 0 {
|
|
log.G(ctx).Debugf("no images found")
|
|
return exitErr
|
|
}
|
|
|
|
var tw = tabwriter.NewWriter(os.Stdout, 1, 8, 1, ' ', 0)
|
|
if !quiet {
|
|
fmt.Fprintln(tw, "REF\tTYPE\tDIGEST\tSTATUS\tSIZE\tUNPACKED\t")
|
|
}
|
|
|
|
for _, image := range imageList {
|
|
var (
|
|
status = "complete"
|
|
size string
|
|
requiredSize int64
|
|
presentSize int64
|
|
complete = true
|
|
)
|
|
|
|
available, required, present, missing, err := images.Check(ctx, contentStore, image.Target(), platforms.Default())
|
|
if err != nil {
|
|
if exitErr == nil {
|
|
exitErr = fmt.Errorf("unable to check %v: %w", image.Name(), err)
|
|
}
|
|
log.G(ctx).WithError(err).Errorf("unable to check %v", image.Name())
|
|
status = "error"
|
|
complete = false
|
|
}
|
|
|
|
if status != "error" {
|
|
for _, d := range required {
|
|
requiredSize += d.Size
|
|
}
|
|
|
|
for _, d := range present {
|
|
presentSize += d.Size
|
|
}
|
|
|
|
if len(missing) > 0 {
|
|
status = "incomplete"
|
|
complete = false
|
|
}
|
|
|
|
if available {
|
|
status += fmt.Sprintf(" (%v/%v)", len(present), len(required))
|
|
size = fmt.Sprintf("%v/%v", progress.Bytes(presentSize), progress.Bytes(requiredSize))
|
|
} else {
|
|
status = fmt.Sprintf("unavailable (%v/?)", len(present))
|
|
size = fmt.Sprintf("%v/?", progress.Bytes(presentSize))
|
|
complete = false
|
|
}
|
|
} else {
|
|
size = "-"
|
|
}
|
|
|
|
unpacked, err := image.IsUnpacked(ctx, context.String("snapshotter"))
|
|
if err != nil {
|
|
if exitErr == nil {
|
|
exitErr = fmt.Errorf("unable to check unpack for %v: %w", image.Name(), err)
|
|
}
|
|
log.G(ctx).WithError(err).Errorf("unable to check unpack for %v", image.Name())
|
|
}
|
|
|
|
if !quiet {
|
|
fmt.Fprintf(tw, "%v\t%v\t%v\t%v\t%v\t%t\n",
|
|
image.Name(),
|
|
image.Target().MediaType,
|
|
image.Target().Digest,
|
|
status,
|
|
size,
|
|
unpacked)
|
|
} else {
|
|
if complete {
|
|
fmt.Println(image.Name())
|
|
}
|
|
}
|
|
}
|
|
if !quiet {
|
|
tw.Flush()
|
|
}
|
|
return exitErr
|
|
},
|
|
}
|
|
|
|
var removeCommand = cli.Command{
|
|
Name: "delete",
|
|
Aliases: []string{"del", "remove", "rm"},
|
|
Usage: "remove one or more images by reference",
|
|
ArgsUsage: "[flags] <ref> [<ref>, ...]",
|
|
Description: "remove one or more images by reference",
|
|
Flags: []cli.Flag{
|
|
cli.BoolFlag{
|
|
Name: "sync",
|
|
Usage: "Synchronously remove image and all associated resources",
|
|
},
|
|
},
|
|
Action: func(context *cli.Context) error {
|
|
client, ctx, cancel, err := commands.NewClient(context)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer cancel()
|
|
var (
|
|
exitErr error
|
|
imageStore = client.ImageService()
|
|
)
|
|
for i, target := range context.Args() {
|
|
var opts []images.DeleteOpt
|
|
if context.Bool("sync") && i == context.NArg()-1 {
|
|
opts = append(opts, images.SynchronousDelete())
|
|
}
|
|
if err := imageStore.Delete(ctx, target, opts...); err != nil {
|
|
if !errdefs.IsNotFound(err) {
|
|
if exitErr == nil {
|
|
exitErr = fmt.Errorf("unable to delete %v: %w", target, err)
|
|
}
|
|
log.G(ctx).WithError(err).Errorf("unable to delete %v", target)
|
|
continue
|
|
}
|
|
// image ref not found in metadata store; log not found condition
|
|
log.G(ctx).Warnf("%v: image not found", target)
|
|
} else {
|
|
fmt.Println(target)
|
|
}
|
|
}
|
|
|
|
return exitErr
|
|
},
|
|
}
|
|
|
|
var pruneCommand = cli.Command{
|
|
Name: "prune",
|
|
Usage: "Remove unused images",
|
|
Flags: []cli.Flag{
|
|
cli.BoolFlag{
|
|
Name: "all", // TODO: add more filters
|
|
Usage: "Remove all unused images, not just dangling ones (if all is not specified no images will be pruned)",
|
|
},
|
|
},
|
|
// adapted from `nerdctl`:
|
|
// https://github.com/containerd/nerdctl/blob/272dc9c29fc1434839d3ec63194d7efa24d7c0ef/cmd/nerdctl/image_prune.go#L86
|
|
Action: func(context *cli.Context) error {
|
|
client, ctx, cancel, err := commands.NewClient(context)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer cancel()
|
|
|
|
all := context.Bool("all")
|
|
if !all {
|
|
log.G(ctx).Warn("No images pruned. `image prune` requires --all to be specified.")
|
|
// NOP
|
|
return nil
|
|
}
|
|
|
|
var (
|
|
imageStore = client.ImageService()
|
|
containerStore = client.ContainerService()
|
|
)
|
|
imageList, err := imageStore.List(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
containerList, err := containerStore.List(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
usedImages := make(map[string]struct{})
|
|
for _, container := range containerList {
|
|
usedImages[container.Image] = struct{}{}
|
|
}
|
|
|
|
var removedImages []string
|
|
for _, image := range imageList {
|
|
if _, ok := usedImages[image.Name]; ok {
|
|
continue
|
|
}
|
|
removedImages = append(removedImages, image.Name)
|
|
}
|
|
|
|
var delOpts []images.DeleteOpt
|
|
for i, imageName := range removedImages {
|
|
// Delete the last image reference synchronously to trigger garbage collection.
|
|
// This is best effort. It is possible that the image reference is deleted by
|
|
// someone else before this point.
|
|
if i == len(removedImages)-1 {
|
|
delOpts = []images.DeleteOpt{images.SynchronousDelete()}
|
|
}
|
|
if err := imageStore.Delete(ctx, imageName, delOpts...); err != nil {
|
|
if !errdefs.IsNotFound(err) {
|
|
log.G(ctx).WithError(err).Warnf("failed to delete image %s", imageName)
|
|
}
|
|
continue
|
|
}
|
|
log.G(ctx).Infof("deleted image: %s\n", imageName)
|
|
}
|
|
return nil
|
|
},
|
|
}
|