package containerd import ( "context" "fmt" "io" "os" "strings" "time" "github.com/containerd/containerd" cerrdefs "github.com/containerd/containerd/errdefs" "github.com/containerd/containerd/images" "github.com/containerd/containerd/pkg/snapshotters" "github.com/containerd/containerd/platforms" "github.com/containerd/containerd/remotes/docker" "github.com/containerd/log" "github.com/distribution/reference" "github.com/docker/docker/api/types/events" registrytypes "github.com/docker/docker/api/types/registry" dimages "github.com/docker/docker/daemon/images" "github.com/docker/docker/distribution" "github.com/docker/docker/errdefs" "github.com/docker/docker/internal/compatcontext" "github.com/docker/docker/pkg/progress" "github.com/docker/docker/pkg/streamformatter" "github.com/docker/docker/pkg/stringid" ocispec "github.com/opencontainers/image-spec/specs-go/v1" "github.com/pkg/errors" ) // PullImage initiates a pull operation. baseRef is the image to pull. // If reference is not tagged, all tags are pulled. func (i *ImageService) PullImage(ctx context.Context, baseRef reference.Named, platform *ocispec.Platform, metaHeaders map[string][]string, authConfig *registrytypes.AuthConfig, outStream io.Writer) (retErr error) { start := time.Now() defer func() { if retErr == nil { dimages.ImageActions.WithValues("pull").UpdateSince(start) } }() out := streamformatter.NewJSONProgressOutput(outStream, false) if !reference.IsNameOnly(baseRef) { return i.pullTag(ctx, baseRef, platform, metaHeaders, authConfig, out) } tags, err := distribution.Tags(ctx, baseRef, &distribution.Config{ RegistryService: i.registryService, MetaHeaders: metaHeaders, AuthConfig: authConfig, }) if err != nil { return err } for _, tag := range tags { ref, err := reference.WithTag(baseRef, tag) if err != nil { log.G(ctx).WithFields(log.Fields{ "tag": tag, "baseRef": baseRef, }).Warn("invalid tag, won't pull") continue } if err := i.pullTag(ctx, ref, platform, metaHeaders, authConfig, out); err != nil { return fmt.Errorf("error pulling %s: %w", ref, err) } } return nil } func (i *ImageService) pullTag(ctx context.Context, ref reference.Named, platform *ocispec.Platform, metaHeaders map[string][]string, authConfig *registrytypes.AuthConfig, out progress.Output) error { var opts []containerd.RemoteOpt if platform != nil { opts = append(opts, containerd.WithPlatform(platforms.Format(*platform))) } resolver, _ := i.newResolverFromAuthConfig(ctx, authConfig, ref) opts = append(opts, containerd.WithResolver(resolver)) old, err := i.resolveDescriptor(ctx, ref.String()) if err != nil && !errdefs.IsNotFound(err) { return err } p := platforms.Default() if platform != nil { p = platforms.Only(*platform) } jobs := newJobs() h := images.HandlerFunc(func(ctx context.Context, desc ocispec.Descriptor) ([]ocispec.Descriptor, error) { if images.IsLayerType(desc.MediaType) { jobs.Add(desc) } return nil, nil }) opts = append(opts, containerd.WithImageHandler(h)) pp := pullProgress{store: i.content, showExists: true} finishProgress := jobs.showProgress(ctx, out, pp) var outNewImg *containerd.Image defer func() { finishProgress() // Send final status message after the progress updater has finished. // Otherwise the layer/manifest progress messages may arrive AFTER the // status message have been sent, so they won't update the previous // progress leaving stale progress like: // 70f5ac315c5a: Downloading [> ] 0B/3.19kB // Digest: sha256:4f53e2564790c8e7856ec08e384732aa38dc43c52f02952483e3f003afbf23db // 70f5ac315c5a: Download complete // Status: Downloaded newer image for hello-world:latest // docker.io/library/hello-world:latest if outNewImg != nil { img := *outNewImg progress.Message(out, "", "Digest: "+img.Target().Digest.String()) writeStatus(out, reference.FamiliarString(ref), old.Digest != img.Target().Digest) } }() var sentPullingFrom, sentSchema1Deprecation bool ah := images.HandlerFunc(func(ctx context.Context, desc ocispec.Descriptor) ([]ocispec.Descriptor, error) { if desc.MediaType == images.MediaTypeDockerSchema1Manifest && !sentSchema1Deprecation { err := distribution.DeprecatedSchema1ImageError(ref) if os.Getenv("DOCKER_ENABLE_DEPRECATED_PULL_SCHEMA_1_IMAGE") == "" { log.G(context.TODO()).Warn(err.Error()) return nil, err } progress.Message(out, "", err.Error()) sentSchema1Deprecation = true } if images.IsLayerType(desc.MediaType) { id := stringid.TruncateID(desc.Digest.String()) progress.Update(out, id, "Pulling fs layer") } if images.IsManifestType(desc.MediaType) { if !sentPullingFrom { var tagOrDigest string if tagged, ok := ref.(reference.Tagged); ok { tagOrDigest = tagged.Tag() } else { tagOrDigest = ref.String() } progress.Message(out, tagOrDigest, "Pulling from "+reference.Path(ref)) sentPullingFrom = true } available, _, _, missing, err := images.Check(ctx, i.content, desc, p) if err != nil { return nil, err } // If we already have all the contents pull shouldn't show any layer // download progress, not even a "Already present" message. if available && len(missing) == 0 { pp.hideLayers = true } } return nil, nil }) opts = append(opts, containerd.WithImageHandler(ah)) opts = append(opts, containerd.WithPullUnpack) // TODO(thaJeztah): we may have to pass the snapshotter to use if the pull is part of a "docker run" (container create -> pull image if missing). See https://github.com/moby/moby/issues/45273 opts = append(opts, containerd.WithPullSnapshotter(i.snapshotter)) // AppendInfoHandlerWrapper will annotate the image with basic information like manifest and layer digests as labels; // this information is used to enable remote snapshotters like nydus and stargz to query a registry. infoHandler := snapshotters.AppendInfoHandlerWrapper(ref.String()) opts = append(opts, containerd.WithImageHandlerWrapper(infoHandler)) // Allow pulling application/vnd.docker.distribution.manifest.v1+prettyjws images // by converting them to OCI manifests. opts = append(opts, containerd.WithSchema1Conversion) //nolint:staticcheck // Ignore SA1019: containerd.WithSchema1Conversion is deprecated: use Schema 2 or OCI images. img, err := i.client.Pull(ctx, ref.String(), opts...) if err != nil { if errors.Is(err, docker.ErrInvalidAuthorization) { // Match error returned by containerd. // https://github.com/containerd/containerd/blob/v1.7.8/remotes/docker/authorizer.go#L189-L191 if strings.Contains(err.Error(), "no basic auth credentials") { return err } return errdefs.NotFound(fmt.Errorf("pull access denied for %s, repository does not exist or may require 'docker login'", reference.FamiliarName(ref))) } return err } logger := log.G(ctx).WithFields(log.Fields{ "digest": img.Target().Digest, "remote": ref.String(), }) logger.Info("image pulled") // The pull succeeded, so try to remove any dangling image we have for this target err = i.images.Delete(compatcontext.WithoutCancel(ctx), danglingImageName(img.Target().Digest)) if err != nil && !cerrdefs.IsNotFound(err) { // Image pull succeeded, but cleaning up the dangling image failed. Ignore the // error to not mark the pull as failed. logger.WithError(err).Warn("unexpected error while removing outdated dangling image reference") } i.LogImageEvent(reference.FamiliarString(ref), reference.FamiliarName(ref), events.ActionPull) outNewImg = &img return nil } // writeStatus writes a status message to out. If newerDownloaded is true, the // status message indicates that a newer image was downloaded. Otherwise, it // indicates that the image is up to date. requestedTag is the tag the message // will refer to. func writeStatus(out progress.Output, requestedTag string, newerDownloaded bool) { if newerDownloaded { progress.Message(out, "", "Status: Downloaded newer image for "+requestedTag) } else { progress.Message(out, "", "Status: Image is up to date for "+requestedTag) } }