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

     1  % runc-checkpoint "8"
     2  
     3  # NAME
     4  **runc-checkpoint** - checkpoint a running container
     5  
     6  # SYNOPSIS
     7  **runc checkpoint** [_option_ ...] _container-id_
     8  
     9  # DESCRIPTION
    10  The **checkpoint** command saves the state of the running container instance
    11  with the help of **criu**(8) tool, to be restored later.
    12  
    13  # OPTIONS
    14  **--image-path** _path_
    15  : Set path for saving criu image files. The default is *./checkpoint*.
    16  
    17  **--work-path** _path_
    18  : Set path for saving criu work files and logs. The default is to reuse the
    19  image files directory.
    20  
    21  **--parent-path** _path_
    22  : Set path for previous criu image files, in pre-dump.
    23  
    24  **--leave-running**
    25  : Leave the process running after checkpointing.
    26  
    27  **--tcp-established**
    28  : Allow checkpoint/restore of established TCP connections. See
    29  [criu --tcp-establised option](https://criu.org/CLI/opt/--tcp-established).
    30  
    31  **--ext-unix-sk**
    32  : Allow checkpoint/restore of external unix sockets. See
    33  [criu --ext-unix-sk option](https://criu.org/CLI/opt/--ext-unix-sk).
    34  
    35  **--shell-job**
    36  : Allow checkpoint/restore of shell jobs.
    37  
    38  **--lazy-pages**
    39  : Use lazy migration mechanism. See
    40  [criu --lazy-pages option](https://criu.org/CLI/opt/--lazy-pages).
    41  
    42  **--status-fd** _fd_
    43  : Pass a file descriptor _fd_ to **criu**. Once **lazy-pages** server is ready,
    44  **criu** writes **\0** (a zero byte) to that _fd_. Used together with
    45  **--lazy-pages**.
    46  
    47  **--page-server** _IP-address_:_port_
    48  : Start a page server at the specified _IP-address_ and _port_. This is used
    49  together with **criu lazy-pages**. See
    50  [criu lazy migration](https://criu.org/Lazy_migration).
    51  
    52  **--file-locks**
    53  : Allow checkpoint/restore of file locks. See
    54  [criu --file-locks option](https://criu.org/CLI/opt/--file-locks).
    55  
    56  **--pre-dump**
    57  : Do a pre-dump, i.e. dump container's memory information only, leaving the
    58  container running. See [criu iterative migration](https://criu.org/Iterative_migration).
    59  
    60  **--manage-cgroups-mode** **soft**|**full**|**strict**|**ignore**.
    61  : Cgroups mode. Default is **soft**. See
    62  [criu --manage-cgroups option](https://criu.org/CLI/opt/--manage-cgroups).
    63  
    64  **--empty-ns** _namespace_
    65  : Checkpoint a _namespace_, but don't save its properties. See
    66  [criu --empty-ns option](https://criu.org/CLI/opt/--empty-ns).
    67  
    68  **--auto-dedup**
    69  : Enable auto deduplication of memory images. See
    70  [criu --auto-dedup option](https://criu.org/CLI/opt/--auto-dedup).
    71  
    72  # SEE ALSO
    73  **criu**(8),
    74  **runc-restore**(8),
    75  **runc**(8),
    76  **criu**(8).