zishuo/runc
1
0
Fork 0
mirror of https://github.com/opencontainers/runc.git synced 2025-10-07 08:21:01 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
1079288bef1261a22b74d49fdbfa5d380cab901b
runc/man/runc-checkpoint.8.md
Kir Kolyshkin dfc0f0695a man/*: revamp 
Current runc man pages are ugly (no proper man page formatting)
and very short (mostly just a copy-paste from the "runc <command>
--help" output. They are also somewhat obsoleted as not all CLI updates
were propagated to man/*.

This commits makes the first step to solving this.

In short:
 - added some more information about some options;
 - lots of formatting fixes;
 - use references to other man pages and web pages;
 - fix SYNOPSYS (formatting, mostly);
 - removed the repeated description of <container_id> from every page;
 - added SEE ALSO;
 - something else I forgot.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
2021-06-16 12:42:06 -07:00

2.4 KiB
Raw Blame History

% runc-checkpoint "8"

NAME

runc-checkpoint - checkpoint a running container

SYNOPSIS

runc checkpoint [option ...] container-id

DESCRIPTION

The checkpoint command saves the state of the running container instance with the help of criu(8) tool, to be restored later.

OPTIONS

--image-path path
Set path for saving criu image files. The default is ./checkpoint.
--work-path path
Set path for saving criu work files and logs. The default is to reuse the image files directory.
--parent-path path
Set path for previous criu image files, in pre-dump.
--leave-running
Leave the process running after checkpointing.
--tcp-established
Allow checkpoint/restore of established TCP connections. See criu --tcp-establised option.
--ext-unix-sk
Allow checkpoint/restore of external unix sockets. See criu --ext-unix-sk option.
--shell-job
Allow checkpoint/restore of shell jobs.
--lazy-pages
Use lazy migration mechanism. See criu --lazy-pages option.
--status-fd fd
Pass a file descriptor fd to criu. Once lazy-pages server is ready, criu writes \0 (a zero byte) to that fd. Used together with --lazy-pages.
--page-server IP-address:port
Start a page server at the specified IP-address and port. This is used together with criu lazy-pages. See criu lazy migration.
--file-locks
Allow checkpoint/restore of file locks. See criu --file-locks option.
--pre-dump
Do a pre-dump, i.e. dump container's memory information only, leaving the container running. See criu iterative migration.
--manage-cgroups-mode soft|full|strict.
Cgroups mode. Default is soft. See criu --manage-cgroups option.
--empty-ns namespace
Checkpoint a namespace, but don't save its properties. See criu --empty-ns option.
--auto-dedup
Enable auto deduplication of memory images. See criu --auto-dedup option.

SEE ALSO

criu(8), runc-restore(8), runc(8), criu(8).