github.com/opencontainers/runc@v1.2.0-rc.1.0.20240520010911-492dc558cdd6/man/runc-restore.8.md (about)

     1  % runc-restore "8"
     2  
     3  # NAME
     4  **runc-restore** - restore a container from a previous checkpoint
     5  
     6  # SYNOPSIS
     7  **runc restore** [_option_ ...] _container-id_
     8  
     9  # DESCRIPTION
    10  Restores the container instance from a previously performed **runc checkpoint**.
    11  
    12  # OPTIONS
    13  **--console-socket** _path_
    14  : Path to an **AF_UNIX**  socket which will receive a file descriptor
    15  referencing the master end of the console's pseudoterminal.  See
    16  [docs/terminals](https://github.com/opencontainers/runc/blob/master/docs/terminals.md).
    17  
    18  **--image-path** _path_
    19  : Set path to get criu image files to restore from.
    20  
    21  **--work-path** _path_
    22  : Set path for saving criu work files and logs. The default is to reuse the
    23  image files directory.
    24  
    25  **--tcp-established**
    26  : Allow checkpoint/restore of established TCP connections. See
    27  [criu --tcp-establised option](https://criu.org/CLI/opt/--tcp-established).
    28  
    29  **--ext-unix-sk**
    30  : Allow checkpoint/restore of external unix sockets. See
    31  [criu --ext-unix-sk option](https://criu.org/CLI/opt/--ext-unix-sk).
    32  
    33  **--shell-job**
    34  : Allow checkpoint/restore of shell jobs.
    35  
    36  **--file-locks**
    37  : Allow checkpoint/restore of file locks. See
    38  [criu --file-locks option](https://criu.org/CLI/opt/--file-locks).
    39  
    40  **--manage-cgroups-mode** **soft**|**full**|**strict**|**ignore**.
    41  : Cgroups mode. Default is **soft**. See
    42  [criu --manage-cgroups option](https://criu.org/CLI/opt/--manage-cgroups).
    43  
    44  : In particular, to restore the container into a different cgroup,
    45  **--manage-cgroups-mode ignore** must be used during both
    46  **checkpoint** and **restore**, and the _container_id_ (or
    47  **cgroupsPath** property in OCI config, if set) must be changed.
    48  
    49  **--bundle**|**-b** _path_
    50  : Path to the root of the bundle directory. Default is current directory.
    51  
    52  **--detach**|**-d**
    53  : Detach from the container's process.
    54  
    55  **--pid-file** _path_
    56  : Specify the file to write the initial container process' PID to.
    57  
    58  **--no-subreaper**
    59  : Disable the use of the subreaper used to reap reparented processes.
    60  
    61  **--no-pivot**
    62  : Do not use pivot root to jail process inside rootfs. This should not be used
    63  except in exceptional circumstances, and may be unsafe from the security
    64  standpoint.
    65  
    66  **--empty-ns** _namespace_
    67  : Create a _namespace_, but don't restore its properties. See
    68  [criu --empty-ns option](https://criu.org/CLI/opt/--empty-ns).
    69  
    70  **--auto-dedup**
    71  : Enable auto deduplication of memory images. See
    72  [criu --auto-dedup option](https://criu.org/CLI/opt/--auto-dedup).
    73  
    74  **--lazy-pages**
    75  : Use lazy migration mechanism. This requires a running **criu lazy-pages**
    76  daemon. See [criu --lazy-pages option](https://criu.org/CLI/opt/--lazy-pages).
    77  
    78  **--lsm-profile** _type_:_label_
    79  : Specify an LSM profile to be used during restore. Here _type_ can either be
    80  **apparamor** or **selinux**, and _label_ is a valid LSM label. For example,
    81  **--lsm-profile "selinux:system_u:system_r:container_t:s0:c82,c137"**.
    82  By default, the checkpointed LSM profile is used upon restore.
    83  
    84  **--lsm-mount-context** _context_
    85  : Specify an LSM mount context to be used during restore. Only mounts with an
    86  existing context will have their context replaced. With this option it is
    87  possible to change SELinux mount options. Instead of mounting with the
    88  checkpointed context, the specified _context_ will be used.
    89  For example, **--lsm-mount-context "system_u:object_r:container_file_t:s0:c82,c137"**.
    90  
    91  # SEE ALSO
    92  **criu**(8),
    93  **runc-checkpoint**(8),
    94  **runc**(8).