mirror of
https://github.com/docker/cli.git
synced 2025-04-21 17:25:54 +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>
112 lines
4.4 KiB
Markdown
112 lines
4.4 KiB
Markdown
---
|
|
title: "commit"
|
|
description: "The commit command description and usage"
|
|
keywords: "commit, file, changes"
|
|
---
|
|
|
|
# commit
|
|
|
|
```markdown
|
|
Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
|
|
|
|
Create a new image from a container's changes
|
|
|
|
Aliases:
|
|
docker container commit, docker commit
|
|
|
|
Options:
|
|
-a, --author string Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
|
|
-c, --change value Apply Dockerfile instruction to the created image (default [])
|
|
--help Print usage
|
|
-m, --message string Commit message
|
|
-p, --pause Pause container during commit (default true)
|
|
```
|
|
|
|
## Description
|
|
|
|
It can be useful to commit a container's file changes or settings into a new
|
|
image. This allows you to debug a container by running an interactive shell, or to
|
|
export a working dataset to another server. Generally, it is better to use
|
|
Dockerfiles to manage your images in a documented and maintainable way.
|
|
[Read more about valid image names and tags](tag.md).
|
|
|
|
The commit operation will not include any data contained in
|
|
volumes mounted inside the container.
|
|
|
|
By default, the container being committed and its processes will be paused
|
|
while the image is committed. This reduces the likelihood of encountering data
|
|
corruption during the process of creating the commit. If this behavior is
|
|
undesired, set the `--pause` option to false.
|
|
|
|
The `--change` option will apply `Dockerfile` instructions to the image that is
|
|
created. Supported `Dockerfile` instructions:
|
|
`CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`LABEL`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
|
|
|
|
## Examples
|
|
|
|
### Commit a container
|
|
|
|
```console
|
|
$ docker ps
|
|
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky
|
|
197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton
|
|
|
|
$ docker commit c3f279d17e0a svendowideit/testimage:version3
|
|
|
|
f5283438590d
|
|
|
|
$ docker images
|
|
|
|
REPOSITORY TAG ID CREATED SIZE
|
|
svendowideit/testimage version3 f5283438590d 16 seconds ago 335.7 MB
|
|
```
|
|
|
|
### <a name=change></a> Commit a container with new configurations (--change)
|
|
|
|
```console
|
|
$ docker ps
|
|
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky
|
|
197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton
|
|
|
|
$ docker inspect -f "{{ .Config.Env }}" c3f279d17e0a
|
|
|
|
[HOME=/ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin]
|
|
|
|
$ docker commit --change "ENV DEBUG=true" c3f279d17e0a svendowideit/testimage:version3
|
|
|
|
f5283438590d
|
|
|
|
$ docker inspect -f "{{ .Config.Env }}" f5283438590d
|
|
|
|
[HOME=/ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin DEBUG=true]
|
|
```
|
|
|
|
### Commit a container with new `CMD` and `EXPOSE` instructions
|
|
|
|
```console
|
|
$ docker ps
|
|
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky
|
|
197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton
|
|
|
|
$ docker commit --change='CMD ["apachectl", "-DFOREGROUND"]' -c "EXPOSE 80" c3f279d17e0a svendowideit/testimage:version4
|
|
|
|
f5283438590d
|
|
|
|
$ docker run -d svendowideit/testimage:version4
|
|
|
|
89373736e2e7f00bc149bd783073ac43d0507da250e999f3f1036e0db60817c0
|
|
|
|
$ docker ps
|
|
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
89373736e2e7 testimage:version4 "apachectl -DFOREGROU" 3 seconds ago Up 2 seconds 80/tcp distracted_fermat
|
|
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky
|
|
197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton
|
|
```
|