mirror of
https://github.com/docker/cli.git
synced 2025-08-27 13:42:00 +03:00
80b1285fec
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>
126 lines
4.1 KiB
Markdown
126 lines
4.1 KiB
Markdown
---
|
|
title: "push"
|
|
description: "The push command description and usage"
|
|
keywords: "share, push, image"
|
|
---
|
|
|
|
# push
|
|
|
|
```markdown
|
|
Usage: docker push [OPTIONS] NAME[:TAG]
|
|
|
|
Upload an image to a registry
|
|
|
|
Aliases:
|
|
docker image push, docker push
|
|
|
|
Options:
|
|
-a, --all-tags Push all tags of an image to the repository
|
|
--disable-content-trust Skip image signing (default true)
|
|
--help Print usage
|
|
-q, --quiet Suppress verbose output
|
|
```
|
|
|
|
## Description
|
|
|
|
Use `docker image push` to share your images to the [Docker Hub](https://hub.docker.com)
|
|
registry or to a self-hosted one.
|
|
|
|
Refer to the [`docker image tag`](tag.md) reference for more information about valid
|
|
image and tag names.
|
|
|
|
Killing the `docker image push` process, for example by pressing `CTRL-c` while it is
|
|
running in a terminal, terminates the push operation.
|
|
|
|
Progress bars are shown during docker push, which show the uncompressed size.
|
|
The actual amount of data that's pushed will be compressed before sending, so
|
|
the uploaded size will not be reflected by the progress bar.
|
|
|
|
Registry credentials are managed by [docker login](login.md).
|
|
|
|
### Concurrent uploads
|
|
|
|
By default the Docker daemon will push five layers of an image at a time.
|
|
If you are on a low bandwidth connection this may cause timeout issues and you may want to lower
|
|
this via the `--max-concurrent-uploads` daemon option. See the
|
|
[daemon documentation](dockerd.md) for more details.
|
|
|
|
## Examples
|
|
|
|
### Push a new image to a registry
|
|
|
|
First save the new image by finding the container ID (using [`docker container ls`](ps.md))
|
|
and then committing it to a new image name. Note that only `a-z0-9-_.` are
|
|
allowed when naming images:
|
|
|
|
```console
|
|
$ docker container commit c16378f943fe rhel-httpd:latest
|
|
```
|
|
|
|
Now, push the image to the registry using the image ID. In this example the
|
|
registry is on host named `registry-host` and listening on port `5000`. To do
|
|
this, tag the image with the host name or IP address, and the port of the
|
|
registry:
|
|
|
|
```console
|
|
$ docker image tag rhel-httpd:latest registry-host:5000/myadmin/rhel-httpd:latest
|
|
|
|
$ docker image push registry-host:5000/myadmin/rhel-httpd:latest
|
|
```
|
|
|
|
Check that this worked by running:
|
|
|
|
```console
|
|
$ docker image ls
|
|
```
|
|
|
|
You should see both `rhel-httpd` and `registry-host:5000/myadmin/rhel-httpd`
|
|
listed.
|
|
|
|
### <a name=all-tags></a> Push all tags of an image (-a, --all-tags)
|
|
|
|
Use the `-a` (or `--all-tags`) option to push all tags of a local image.
|
|
|
|
The following example creates multiple tags for an image, and pushes all those
|
|
tags to Docker Hub.
|
|
|
|
|
|
```console
|
|
$ docker image tag myimage registry-host:5000/myname/myimage:latest
|
|
$ docker image tag myimage registry-host:5000/myname/myimage:v1.0.1
|
|
$ docker image tag myimage registry-host:5000/myname/myimage:v1.0
|
|
$ docker image tag myimage registry-host:5000/myname/myimage:v1
|
|
```
|
|
|
|
The image is now tagged under multiple names:
|
|
|
|
```console
|
|
$ docker image ls
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
myimage latest 6d5fcfe5ff17 2 hours ago 1.22MB
|
|
registry-host:5000/myname/myimage latest 6d5fcfe5ff17 2 hours ago 1.22MB
|
|
registry-host:5000/myname/myimage v1 6d5fcfe5ff17 2 hours ago 1.22MB
|
|
registry-host:5000/myname/myimage v1.0 6d5fcfe5ff17 2 hours ago 1.22MB
|
|
registry-host:5000/myname/myimage v1.0.1 6d5fcfe5ff17 2 hours ago 1.22MB
|
|
```
|
|
|
|
When pushing with the `--all-tags` option, all tags of the `registry-host:5000/myname/myimage`
|
|
image are pushed:
|
|
|
|
|
|
```console
|
|
$ docker image push --all-tags registry-host:5000/myname/myimage
|
|
|
|
The push refers to repository [registry-host:5000/myname/myimage]
|
|
195be5f8be1d: Pushed
|
|
latest: digest: sha256:edafc0a0fb057813850d1ba44014914ca02d671ae247107ca70c94db686e7de6 size: 4527
|
|
195be5f8be1d: Layer already exists
|
|
v1: digest: sha256:edafc0a0fb057813850d1ba44014914ca02d671ae247107ca70c94db686e7de6 size: 4527
|
|
195be5f8be1d: Layer already exists
|
|
v1.0: digest: sha256:edafc0a0fb057813850d1ba44014914ca02d671ae247107ca70c94db686e7de6 size: 4527
|
|
195be5f8be1d: Layer already exists
|
|
v1.0.1: digest: sha256:edafc0a0fb057813850d1ba44014914ca02d671ae247107ca70c94db686e7de6 size: 4527
|
|
```
|
|
|