10000 docs: some minor touch-ups in checkpoint reference · docker/cli@8c73a93 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8c73a93

Browse files
committed
docs: some minor touch-ups in checkpoint reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent d8b33fa commit 8c73a93

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/reference/commandline/checkpoint.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ checkpoint and restore in Docker is available in this
1818

1919
### Installing CRIU
2020

21-
If you use a Debian system, you can add the CRIU PPA and install with apt-get
21+
If you use a Debian system, you can add the CRIU PPA and install with `apt-get`
2222
[from the criu launchpad](https://launchpad.net/~criu/+archive/ubuntu/ppa).
2323

2424
Alternatively, you can [build CRIU from source](https://criu.org/Installation).
2525

26-
You need at least version 2.0 of CRIU to run checkpoint/restore in Docker.
26+
You need at least version 2.0 of CRIU to run checkpoint and restore in Docker.
2727

28-
### Use cases for checkpoint & restore
28+
### Use cases for checkpoint and restore
2929

3030
This feature is currently focused on single-host use cases for checkpoint and< 10000 /div>
3131
restore. Here are a few:
@@ -35,21 +35,22 @@ restore. Here are a few:
3535
- "Rewinding" processes to an earlier point in time
3636
- "Forensic debugging" of running processes
3737

38-
Another primary use case of checkpoint & restore outside of Docker is the live
38+
Another primary use case of checkpoint and restore outside of Docker is the live
3939
migration of a server from one machine to another. This is possible with the
4040
current implementation, but not currently a priority (and so the workflow is
4141
not optimized for the task).
4242

43-
### Using checkpoint & restore
43+
### Using checkpoint and restore
4444

4545
A new top level command `docker checkpoint` is introduced, with three subcommands:
46-
- `create` (creates a new checkpoint)
47-
- `ls` (lists existing checkpoints)
48-
- `rm` (deletes an existing checkpoint)
4946

50-
Additionally, a `--checkpoint` flag is added to the container start command.
47+
- `docker checkpoint create` (creates a new checkpoint)
48+
- `docker checkpoint ls` (lists existing checkpoints)
49+
- `docker checkpoint rm` (deletes an existing checkpoint)
5150

52-
The options for checkpoint create:
51+
Additionally, a `--checkpoint` flag is added to the `docker container start` command.
52+
53+
The options for `docker checkpoint create`:
5354

5455
```console
5556
Usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT
@@ -66,7 +67,7 @@ And to restore a container:
6667
Usage: docker start --checkpoint CHECKPOINT_ID [OTHER OPTIONS] CONTAINER
6768
```
6869

69-
Example of using checkpoint & restore on a container:
70+
Example of using checkpoint and restore on a container:
7071

7172
```console
7273
$ docker run --security-opt=seccomp:unconfined --name cr -d busybox /bin/sh -c 'i=0; while true; do echo $i; i=$(expr $i + 1); sleep 1; done'
@@ -79,7 +80,7 @@ $ docker start --checkpoint checkpoint1 cr
7980
abc0123
8081
```
8182

82-
This process just logs an incrementing counter to stdout. If you `docker logs`
83+
This process just logs an incrementing counter to stdout. If you run `docker logs`
8384
in between running/checkpoint/restoring you should see that the counter
8485
increases while the process is running, stops while it's checkpointed, and
8586
resumes from the point it left off once you restore.

0 commit comments

Comments
 (0)
0