The JSON field was added in [moby@9fd2c0f], to address [moby#19177], which reported an incompatibility with Classic (V1) Swarm, which produced a non- standard response; > Make docker load to output json when the response content type is json > Swarm hijacks the response from docker load and returns JSON rather > than plain text like the Engine does. This makes the API library to return > information to figure that out. A later change in [moby@96d7db6] added additional logic to make sure the correct content-type was returned, depending on whether the `quiet` option was set (which produced a non-JSON response). This caused inconsistency in the API response, and [moby@2f27632] changed the endpoint to always produce JSON (only skipping the "progress" output if `quiet` was set). This means that the "load" endpoint ([`imageRouter.postImagesLoad`]) now unconditionally returns JSON, making the `JSON` field fully redundant. This patch removes the use of the JSON field, as it's redundant, and the way it handles the content-type is incorrect because it would not handle correct, but different formatted response-headers (`application/json; charset=utf-8`), which could result in malformed output on the client. [moby@9fd2c0f]:9fd2c0feb0[moby#19177]: https://github.com/moby/moby/issues/19177 [moby@96d7db6]:96d7db665b[moby@2f27632]:2f27632cde[`imageRouter.postImagesLoad`]:7b9d2ef6e5/api/server/router/image/image_routes.go (L248-L255)Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
102 lines
3.1 KiB
Go
102 lines
3.1 KiB
Go
package image
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
|
|
"github.com/containerd/platforms"
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/completion"
|
|
"github.com/docker/cli/internal/jsonstream"
|
|
"github.com/moby/moby/client"
|
|
"github.com/moby/sys/sequential"
|
|
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type loadOptions struct {
|
|
input string
|
|
quiet bool
|
|
platform []string
|
|
}
|
|
|
|
// newLoadCommand creates a new "docker image load" command.
|
|
func newLoadCommand(dockerCLI command.Cli) *cobra.Command {
|
|
var opts loadOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "load [OPTIONS]",
|
|
Short: "Load an image from a tar archive or STDIN",
|
|
Args: cli.NoArgs,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return runLoad(cmd.Context(), dockerCLI, opts)
|
|
},
|
|
Annotations: map[string]string{
|
|
"aliases": "docker image load, docker load",
|
|
},
|
|
ValidArgsFunction: cobra.NoFileCompletions,
|
|
DisableFlagsInUseLine: true,
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
|
|
flags.StringVarP(&opts.input, "input", "i", "", "Read from tar archive file, instead of STDIN")
|
|
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Suppress the load output")
|
|
flags.StringSliceVar(&opts.platform, "platform", []string{}, `Load only the given platform(s). Formatted as a comma-separated list of "os[/arch[/variant]]" (e.g., "linux/amd64,linux/arm64/v8").`)
|
|
_ = flags.SetAnnotation("platform", "version", []string{"1.48"})
|
|
|
|
_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms())
|
|
return cmd
|
|
}
|
|
|
|
func runLoad(ctx context.Context, dockerCli command.Cli, opts loadOptions) error {
|
|
var input io.Reader = dockerCli.In()
|
|
|
|
// TODO(thaJeztah): add support for "-" as STDIN to match other commands, possibly making it a required positional argument.
|
|
switch opts.input {
|
|
case "":
|
|
// To avoid getting stuck, verify that a tar file is given either in
|
|
// the input flag or through stdin and if not display an error message and exit.
|
|
if dockerCli.In().IsTerminal() {
|
|
return errors.New("requested load from stdin, but stdin is empty")
|
|
}
|
|
default:
|
|
// We use sequential.Open to use sequential file access on Windows, avoiding
|
|
// depleting the standby list un-necessarily. On Linux, this equates to a regular os.Open.
|
|
file, err := sequential.Open(opts.input)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer func() { _ = file.Close() }()
|
|
input = file
|
|
}
|
|
|
|
var options []client.ImageLoadOption
|
|
if opts.quiet || !dockerCli.Out().IsTerminal() {
|
|
options = append(options, client.ImageLoadWithQuiet(true))
|
|
}
|
|
|
|
platformList := []ocispec.Platform{}
|
|
for _, p := range opts.platform {
|
|
pp, err := platforms.Parse(p)
|
|
if err != nil {
|
|
return fmt.Errorf("invalid platform: %w", err)
|
|
}
|
|
platformList = append(platformList, pp)
|
|
}
|
|
if len(platformList) > 0 {
|
|
options = append(options, client.ImageLoadWithPlatforms(platformList...))
|
|
}
|
|
|
|
res, err := dockerCli.Client().ImageLoad(ctx, input, options...)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer func() { _ = res.Close() }()
|
|
|
|
return jsonstream.Display(ctx, res, dockerCli.Out())
|
|
}
|