2015-06-21 16:41:38 -04:00
|
|
|
# load
|
|
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
<!---MARKER_GEN_START-->
|
|
|
|
|
Load an image from a tar archive or STDIN
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
### Aliases
|
|
|
|
|
|
|
|
|
|
`docker image load`, `docker load`
|
|
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
2024-08-06 08:48:39 -04:00
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|
|:------------------------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------|
|
|
|
|
|
| [`-i`](#input), [`--input`](#input) | `string` | | Read from tar archive file, instead of STDIN |
|
|
|
|
|
| [`--platform`](#platform) | `string` | | Load only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`) |
|
|
|
|
|
| `-q`, `--quiet` | `bool` | | Suppress the load output |
|
2015-06-21 16:41:38 -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
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
<!---MARKER_GEN_END-->
|
2021-08-21 08:54:14 -04:00
|
|
|
|
2017-01-27 19:47:41 -05:00
|
|
|
## Description
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2018-01-05 16:49:16 -05:00
|
|
|
Load an image or repository from a tar archive (even if compressed with gzip,
|
2023-11-20 13:14:05 -05:00
|
|
|
bzip2, xz or zstd) from a file or STDIN. It restores both images and tags.
|
2017-02-07 18:42:48 -05:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2018-04-16 10:01:53 -04:00
|
|
|
$ docker image ls
|
2017-02-07 18:42:48 -05:00
|
|
|
|
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
2022-03-30 09:05:29 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Load images from STDIN
|
2017-02-07 18:42:48 -05:00
|
|
|
|
2022-03-30 09:05:29 -04:00
|
|
|
```console
|
2017-02-07 18:42:48 -05:00
|
|
|
$ docker load < busybox.tar.gz
|
|
|
|
|
|
|
|
|
|
Loaded image: busybox:latest
|
|
|
|
|
$ docker images
|
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
|
|
|
busybox latest 769b9341d937 7 weeks ago 2.489 MB
|
2022-03-30 09:05:29 -04:00
|
|
|
```
|
2017-02-07 18:42:48 -05:00
|
|
|
|
2023-01-06 13:28:29 -05:00
|
|
|
### <a name="input"></a> Load images from a file (--input)
|
2022-03-30 09:05:29 -04:00
|
|
|
|
|
|
|
|
```console
|
2017-02-07 18:42:48 -05:00
|
|
|
$ docker load --input fedora.tar
|
|
|
|
|
|
|
|
|
|
Loaded image: fedora:rawhide
|
|
|
|
|
Loaded image: fedora:20
|
|
|
|
|
|
|
|
|
|
$ docker images
|
|
|
|
|
|
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
|
|
|
busybox latest 769b9341d937 7 weeks ago 2.489 MB
|
|
|
|
|
fedora rawhide 0d20aec6529d 7 weeks ago 387 MB
|
|
|
|
|
fedora 20 58394af37342 7 weeks ago 385.5 MB
|
|
|
|
|
fedora heisenbug 58394af37342 7 weeks ago 385.5 MB
|
|
|
|
|
fedora latest 58394af37342 7 weeks ago 385.5 MB
|
|
|
|
|
```
|
2024-08-06 08:48:39 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### <a name="platform"></a> Load a specific platform (--platform)
|
|
|
|
|
|
|
|
|
|
The `--platform` option allows you to specify which platform variant of the
|
|
|
|
|
image to load. By default, `docker load` loads all platform variants that
|
|
|
|
|
are present in the archive. Use the `--platform` option to specify which
|
|
|
|
|
platform variant of the image to load. An error is produced if the given
|
|
|
|
|
platform is not present in the archive.
|
|
|
|
|
|
|
|
|
|
The platform option takes the `os[/arch[/variant]]` format; for example,
|
|
|
|
|
`linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
|
|
|
|
|
and default to the daemon's native architecture if omitted.
|
|
|
|
|
|
|
|
|
|
The following example loads the `linux/amd64` variant of an `alpine` image
|
|
|
|
|
from an archive that contains multiple platform variants.
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ docker image load -i image.tar --platform=linux/amd64
|
|
|
|
|
Loaded image: alpine:latest
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The following example attempts to load a `linux/ppc64le` image from an
|
|
|
|
|
archive, but the given platform is not present in the archive;
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ docker image load -i image.tar --platform=linux/ppc64le
|
|
|
|
|
requested platform (linux/ppc64le) not found: image might be filtered out
|
|
|
|
|
```
|
