2016-09-08 13:11:39 -04:00
|
|
|
package image
|
|
|
|
|
|
|
|
import (
|
2018-05-03 21:02:44 -04:00
|
|
|
"context"
|
2016-09-08 13:11:39 -04:00
|
|
|
"io"
|
|
|
|
|
2024-08-06 08:48:39 -04:00
|
|
|
"github.com/containerd/platforms"
|
2017-04-17 18:07:56 -04:00
|
|
|
"github.com/docker/cli/cli"
|
|
|
|
"github.com/docker/cli/cli/command"
|
2022-03-30 09:27:25 -04:00
|
|
|
"github.com/docker/cli/cli/command/completion"
|
2024-09-12 13:18:46 -04:00
|
|
|
"github.com/docker/docker/api/types/image"
|
2016-09-08 13:11:39 -04:00
|
|
|
"github.com/docker/docker/pkg/jsonmessage"
|
2022-08-27 08:49:24 -04:00
|
|
|
"github.com/moby/sys/sequential"
|
2017-03-09 13:23:45 -05:00
|
|
|
"github.com/pkg/errors"
|
2016-09-08 13:11:39 -04:00
|
|
|
"github.com/spf13/cobra"
|
|
|
|
)
|
|
|
|
|
|
|
|
type loadOptions struct {
|
2024-08-06 08:48:39 -04:00
|
|
|
input string
|
|
|
|
quiet bool
|
|
|
|
platform string
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewLoadCommand creates a new `docker load` command
|
2017-03-30 20:21:14 -04:00
|
|
|
func NewLoadCommand(dockerCli command.Cli) *cobra.Command {
|
2016-09-08 13:11:39 -04:00
|
|
|
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 {
|
2023-09-09 18:27:44 -04:00
|
|
|
return runLoad(cmd.Context(), dockerCli, opts)
|
2016-09-08 13:11:39 -04:00
|
|
|
},
|
cli: use custom annotation for aliases
Cobra allows for aliases to be defined for a command, but only allows these
to be defined at the same level (for example, `docker image ls` as alias for
`docker image list`). Our CLI has some commands that are available both as a
top-level shorthand as well as `docker <object> <verb>` subcommands. For example,
`docker ps` is a shorthand for `docker container ps` / `docker container ls`.
This patch introduces a custom "aliases" annotation that can be used to print
all available aliases for a command. While this requires these aliases to be
defined manually, in practice the list of aliases rarely changes, so maintenance
should be minimal.
As a convention, we could consider the first command in this list to be the
canonical command, so that we can use this information to add redirects in
our documentation in future.
Before this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Options:
-a, --all Show all images (default hides intermediate images)
...
With this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Aliases:
docker image ls, docker image list, docker images
Options:
-a, --all Show all images (default hides intermediate images)
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-06-28 04:52:25 -04:00
|
|
|
Annotations: map[string]string{
|
|
|
|
"aliases": "docker image load, docker load",
|
|
|
|
},
|
2022-03-30 09:27:25 -04:00
|
|
|
ValidArgsFunction: completion.NoComplete,
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
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")
|
2024-08-06 08:48:39 -04:00
|
|
|
flags.StringVar(&opts.platform, "platform", "", `Load only the given platform variant. Formatted as "os[/arch[/variant]]" (e.g., "linux/amd64")`)
|
|
|
|
_ = flags.SetAnnotation("platform", "version", []string{"1.48"})
|
2016-09-08 13:11:39 -04:00
|
|
|
|
2024-08-06 08:48:39 -04:00
|
|
|
_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms)
|
2016-09-08 13:11:39 -04:00
|
|
|
return cmd
|
|
|
|
}
|
|
|
|
|
2023-09-09 18:27:44 -04:00
|
|
|
func runLoad(ctx context.Context, dockerCli command.Cli, opts loadOptions) error {
|
2016-09-08 13:11:39 -04:00
|
|
|
var input io.Reader = dockerCli.In()
|
|
|
|
if opts.input != "" {
|
2022-08-27 08:49:24 -04:00
|
|
|
// We use sequential.Open to use sequential file access on Windows, avoiding
|
2016-11-01 18:44:06 -04:00
|
|
|
// depleting the standby list un-necessarily. On Linux, this equates to a regular os.Open.
|
2022-08-27 08:49:24 -04:00
|
|
|
file, err := sequential.Open(opts.input)
|
2016-09-08 13:11:39 -04:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer file.Close()
|
|
|
|
input = file
|
|
|
|
}
|
2016-10-31 08:12:10 -04:00
|
|
|
|
|
|
|
// 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 opts.input == "" && dockerCli.In().IsTerminal() {
|
2017-03-09 13:23:45 -05:00
|
|
|
return errors.Errorf("requested load from stdin, but stdin is empty")
|
2016-10-31 08:12:10 -04:00
|
|
|
}
|
|
|
|
|
2024-08-06 08:48:39 -04:00
|
|
|
var options image.LoadOptions
|
2024-09-12 13:18:46 -04:00
|
|
|
if opts.quiet || !dockerCli.Out().IsTerminal() {
|
2024-08-06 08:48:39 -04:00
|
|
|
options.Quiet = true
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
2024-09-12 13:18:46 -04:00
|
|
|
|
2024-08-06 08:48:39 -04:00
|
|
|
if opts.platform != "" {
|
|
|
|
p, err := platforms.Parse(opts.platform)
|
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "invalid platform")
|
|
|
|
}
|
|
|
|
options.Platform = &p
|
|
|
|
}
|
|
|
|
|
|
|
|
response, err := dockerCli.Client().ImageLoad(ctx, input, options)
|
2016-09-08 13:11:39 -04:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer response.Body.Close()
|
|
|
|
|
|
|
|
if response.Body != nil && response.JSON {
|
|
|
|
return jsonmessage.DisplayJSONMessagesToStream(response.Body, dockerCli.Out(), nil)
|
|
|
|
}
|
|
|
|
|
|
|
|
_, err = io.Copy(dockerCli.Out(), response.Body)
|
|
|
|
return err
|
|
|
|
}
|