mirror of
https://github.com/opencontainers/runc.git
synced 2025-10-27 01:21:13 +08:00
dfc0f0695a
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>
82 lines
2.6 KiB
Markdown
82 lines
2.6 KiB
Markdown
% runc-restore "8"
|
|
|
|
# NAME
|
|
**runc-restore** - restore a container from a previous checkpoint
|
|
|
|
# SYNOPSIS
|
|
**runc restore** [_option_ ...] _container-id_
|
|
|
|
# DESCRIPTION
|
|
Restores the container instance from a previously performed **runc checkpoint**.
|
|
|
|
# OPTIONS
|
|
**--console-socket** _path_
|
|
: Path to an **AF_UNIX** socket which will receive a file descriptor
|
|
referencing the master end of the console's pseudoterminal. See
|
|
[docs/terminals](https://github.com/opencontainers/runc/blob/master/docs/terminals.md).
|
|
|
|
**--image-path** _path_
|
|
: Set path to get criu image files to restore from.
|
|
|
|
**--work-path** _path_
|
|
: Set path for saving criu work files and logs. The default is to reuse the
|
|
image files directory.
|
|
|
|
**--tcp-established**
|
|
: Allow checkpoint/restore of established TCP connections. See
|
|
[criu --tcp-establised option](https://criu.org/CLI/opt/--tcp-established).
|
|
|
|
**--ext-unix-sk**
|
|
: Allow checkpoint/restore of external unix sockets. See
|
|
[criu --ext-unix-sk option](https://criu.org/CLI/opt/--ext-unix-sk).
|
|
|
|
**--shell-job**
|
|
: Allow checkpoint/restore of shell jobs.
|
|
|
|
**--file-locks**
|
|
: Allow checkpoint/restore of file locks. See
|
|
[criu --file-locks option](https://criu.org/CLI/opt/--file-locks).
|
|
|
|
**--manage-cgroups-mode** **soft**|**full**|**strict**.
|
|
: Cgroups mode. Default is **soft**. See
|
|
[criu --manage-cgroups option](https://criu.org/CLI/opt/--manage-cgroups).
|
|
|
|
**--bundle**|**-b** _path_
|
|
: Path to the root of the bundle directory. Default is current directory.
|
|
|
|
**--detach**|**-d**
|
|
: Detach from the container's process.
|
|
|
|
**--pid-file** _path_
|
|
: Specify the file to write the initial container process' PID to.
|
|
|
|
**--no-subreaper**
|
|
: Disable the use of the subreaper used to reap reparented processes.
|
|
|
|
**--no-pivot**
|
|
: Do not use pivot root to jail process inside rootfs. This should not be used
|
|
except in exceptional circumstances, and may be unsafe from the security
|
|
standpoint.
|
|
|
|
**--empty-ns** _namespace_
|
|
: Create a _namespace_, but don't restore its properties. See
|
|
[criu --empty-ns option](https://criu.org/CLI/opt/--empty-ns).
|
|
|
|
**--auto-dedup**
|
|
: Enable auto deduplication of memory images. See
|
|
[criu --auto-dedup option](https://criu.org/CLI/opt/--auto-dedup).
|
|
|
|
**--lazy-pages**
|
|
: Use lazy migration mechanism. This requires a running **criu lazy-pages**
|
|
daemon. See [criu --lazy-pages option](https://criu.org/CLI/opt/--lazy-pages).
|
|
|
|
**--lsm-profile** _type_:_label_
|
|
: Specify an LSM profile to be used during restore. Here _type_ can either be
|
|
**apparamor** or **selinux**, and _label_ is a valid LSM label. For example,
|
|
**--lsm-profile "selinux:system_u:system_r:container_t:s0:c82,c137"**.
|
|
|
|
# SEE ALSO
|
|
**criu**(8),
|
|
**runc-checkpoint**(8),
|
|
**runc**(8).
|