opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-20 00:27:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update man pages for checkpoint/restore --print-stats

Browse Source 
This commit updates the man pages for checkpoint and restore to describe
the '--print-stats' parameter.

Signed-off-by: Adrian Reber <areber@redhat.com>
This commit is contained in:
Adrian Reber
2021-11-10 12:43:12 +00:00
parent 80e56fa12b
commit 914f4c8905
2 changed files with 60 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/source/markdown/podman-container-checkpoint.1.md
View File

@ -68,6 +68,40 @@ Dump the *container's* memory information only, leaving the *container* running.
operations will supersede prior dumps. It only works on `runc 1.0-rc3` or `higher`.\
The default is **false**.
#### **--print-stats**
Print out statistics about checkpointing the container(s). The output is
rendered in a JSON array and contains information about how much time different
checkpoint operations required. Many of the checkpoint statistics are created
by CRIU and just passed through to Podman. The following information is provided
in the JSON array:
- **podman_checkpoint_duration**: Overall time (in microseconds) needed to create
all checkpoints.
- **runtime_checkpoint_duration**: Time (in microseconds) the container runtime
needed to create the checkpoint.
- **freezing_time**: Time (in microseconds) CRIU needed to pause (freeze) all
processes in the container (measured by CRIU).
- **frozen_time**: Time (in microseconds) all processes in the container were
paused (measured by CRIU).
- **memdump_time**: Time (in microseconds) needed to extract all required memory
pages from all container processes (measured by CRIU).
- **memwrite_time**: Time (in microseconds) needed to write all required memory
pages to the corresponding checkpoint image files (measured by CRIU).
- **pages_scanned**: Number of memory pages scanned to determine if they need
to be checkpointed (measured by CRIU).
- **pages_written**: Number of memory pages actually written to the checkpoint
image files (measured by CRIU).
The default is **false**.
#### **--tcp-established**
Checkpoint a *container* with established TCP connections. If the checkpoint
@ -106,7 +140,7 @@ Dump the container's memory information of the latest container into an archive
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-container-restore(1)](podman-container-restore.1.md)**
**[podman(1)](podman.1.md)**, **[podman-container-restore(1)](podman-container-restore.1.md)**, **criu(8)**
## HISTORY
September 2018, Originally compiled by Adrian Reber <areber@redhat.com>

26
docs/source/markdown/podman-container-restore.1.md
View File

@ -102,6 +102,30 @@ from (see **[podman pod create --share](podman-pod-create.1.md#--share)**).
This option requires at least CRIU 3.16.
#### **--print-stats**
Print out statistics about restoring the container(s). The output is
rendered in a JSON array and contains information about how much time different
restore operations required. Many of the restore statistics are created
by CRIU and just passed through to Podman. The following information is provided
in the JSON array:
- **podman_restore_duration**: Overall time (in microseconds) needed to restore
all checkpoints.
- **runtime_restore_duration**: Time (in microseconds) the container runtime
needed to restore the checkpoint.
- **forking_time**: Time (in microseconds) CRIU needed to create (fork) all
processes in the restored container (measured by CRIU).
- **restore_time**: Time (in microseconds) CRIU needed to restore all processes
in the container (measured by CRIU).
- **pages_restored**: Number of memory pages restored (measured by CRIU).
The default is **false**.
#### **--publish**, **-p**=*port*
Replaces the ports that the *container* publishes, as configured during the
@ -137,7 +161,7 @@ $ podman run --rm -p 2345:80 -d webserver
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-container-checkpoint(1)](podman-container-checkpoint.1.md)**, **[podman-run(1)](podman-run.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**
**[podman(1)](podman.1.md)**, **[podman-container-checkpoint(1)](podman-container-checkpoint.1.md)**, **[podman-run(1)](podman-run.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**, **criu(8)**
## HISTORY
September 2018, Originally compiled by Adrian Reber <areber@redhat.com>