2015-06-21 16:41:38 -04:00
|
|
|
# save
|
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
<!---MARKER_GEN_START-->
|
2016-07-07 14:43:18 -04:00
|
|
|
Save one or more images to a tar archive (streamed to STDOUT by default)
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
### Aliases
|
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
|
|
|
`docker image save`, `docker save`
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
2024-08-06 08:46:04 -04:00
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|:--------------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------|
|
|
|
|
| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT |
|
|
|
|
| [`--platform`](#platform) | `string` | | Save only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`) |
|
2023-01-06 13:04:05 -05:00
|
|
|
|
|
|
|
|
|
|
|
<!---MARKER_GEN_END-->
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Description
|
|
|
|
|
2015-06-21 16:41:38 -04:00
|
|
|
Produces a tarred repository to the standard output stream.
|
|
|
|
Contains all parent layers, and all tags + versions, or specified `repo:tag`, for
|
|
|
|
each argument provided.
|
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
### Create a backup that can then be used with `docker load`.
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2017-02-07 18:42:48 -05:00
|
|
|
$ docker save busybox > busybox.tar
|
|
|
|
|
|
|
|
$ ls -sh busybox.tar
|
|
|
|
|
|
|
|
2.7M busybox.tar
|
|
|
|
|
|
|
|
$ docker save --output busybox.tar busybox
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
$ ls -sh busybox.tar
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
2.7M busybox.tar
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
$ docker save -o fedora-all.tar fedora
|
|
|
|
|
|
|
|
$ docker save -o fedora-latest.tar fedora:latest
|
|
|
|
```
|
|
|
|
|
2019-03-21 17:49:21 -04:00
|
|
|
### Save an image to a tar.gz file using gzip
|
|
|
|
|
|
|
|
You can use gzip to save the image file and make the backup smaller.
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
|
|
|
$ docker save myimage:latest | gzip > myimage_latest.tar.gz
|
2019-03-21 17:49:21 -04:00
|
|
|
```
|
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
### Cherry-pick particular tags
|
|
|
|
|
|
|
|
You can even cherry-pick particular tags of an image repository.
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2017-02-07 18:42:48 -05:00
|
|
|
$ docker save -o ubuntu.tar ubuntu:lucid ubuntu:saucy
|
|
|
|
```
|
2024-08-06 08:46:04 -04:00
|
|
|
|
|
|
|
### <a name="platform"></a> Save a specific platform (--platform)
|
|
|
|
|
|
|
|
The `--platform` option allows you to specify which platform variant of the
|
|
|
|
image to save. By default, `docker save` saves all platform variants that
|
|
|
|
are present in the daemon's image store. Use the `--platform` option
|
|
|
|
to specify which platform variant of the image to save. An error is produced
|
|
|
|
if the given platform is not present in the local image store.
|
|
|
|
|
|
|
|
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 pulls the RISC-V variant of the `alpine:latest` image
|
|
|
|
and saves it to a tar archive.
|
|
|
|
|
|
|
|
```console
|
|
|
|
$ docker pull --platform=linux/riscv64 alpine:latest
|
|
|
|
latest: Pulling from library/alpine
|
|
|
|
8c4a05189a5f: Download complete
|
|
|
|
Digest: sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d
|
|
|
|
Status: Downloaded newer image for alpine:latest
|
|
|
|
docker.io/library/alpine:latest
|
|
|
|
|
|
|
|
$ docker image save --platform=linux/riscv64 -o alpine-riscv.tar alpine:latest
|
|
|
|
|
|
|
|
$ ls -lh image.tar
|
|
|
|
-rw------- 1 thajeztah staff 3.9M Oct 7 11:06 alpine-riscv.tar
|
|
|
|
```
|
|
|
|
|
|
|
|
The following example attempts to save a platform variant of `alpine:latest`
|
|
|
|
that doesn't exist in the local image store, resulting in an error.
|
|
|
|
|
|
|
|
```console
|
|
|
|
$ docker image ls --tree
|
|
|
|
IMAGE ID DISK USAGE CONTENT SIZE IN USE
|
|
|
|
alpine:latest beefdbd8a1da 10.6MB 3.37MB
|
|
|
|
├─ linux/riscv64 80cde017a105 10.6MB 3.37MB
|
|
|
|
├─ linux/amd64 33735bd63cf8 0B 0B
|
|
|
|
├─ linux/arm/v6 50f635c8b04d 0B 0B
|
|
|
|
├─ linux/arm/v7 f2f82d424957 0B 0B
|
|
|
|
├─ linux/arm64/v8 9cee2b382fe2 0B 0B
|
|
|
|
├─ linux/386 b3e87f642f5c 0B 0B
|
|
|
|
├─ linux/ppc64le c7a6800e3dc5 0B 0B
|
|
|
|
└─ linux/s390x 2b5b26e09ca2 0B 0B
|
|
|
|
|
|
|
|
$ docker image save --platform=linux/s390x -o alpine-s390x.tar alpine:latest
|
|
|
|
Error response from daemon: no suitable export target found for platform linux/s390x
|
|
|
|
```
|