1podman-container-checkpoint(1)()              podman-container-checkpoint(1)()
2
3
4

NAME

6       podman-container-checkpoint  - Checkpoints one or more running contain‐
7       ers
8
9

SYNOPSIS

11       podman container checkpoint [options] container [container ...]
12
13

DESCRIPTION

15       podman container checkpoint checkpoints all the  processes  in  one  or
16       more  containers.  A  container  can be restored from a checkpoint with
17       podman-container-restore. The container IDs or names are used as input.
18
19

OPTIONS

21   --all, -a
22       Checkpoint all running containers.
23       The default is false.
24       IMPORTANT: This OPTION does not need a container name or  ID  as  input
25       argument.
26
27
28   --compress, -c=zstd | none | gzip
29       Specify  the compression algorithm used for the checkpoint archive cre‐
30       ated with the --export, -e OPTION. Possible algorithms are  zstd,  none
31       and gzip.
32       One  possible reason to use none is to enable faster creation of check‐
33       point archives. Not compressing the checkpoint archive  can  result  in
34       faster checkpoint archive creation.
35       The default is zstd.
36
37
38   --export, -e=archive
39       Export  the checkpoint to a tar.gz file. The exported checkpoint can be
40       used to import the container on another system and thus  enabling  con‐
41       tainer  live  migration.  This  checkpoint  archive  also  includes all
42       changes to the container's root file-system, if not explicitly disabled
43       using --ignore-rootfs.
44
45
46   --ignore-rootfs
47       If  a  checkpoint  is exported to a tar.gz file it is possible with the
48       help of --ignore-rootfs to explicitly disable including changes to  the
49       root file-system into the checkpoint archive file.
50       The default is false.
51       *IMPORTANT: This OPTION only works in combination with --export, -e.*
52
53
54   --ignore-volumes
55       This  OPTION  must be used in combination with the --export, -e OPTION.
56       When this OPTION is specified, the content of volumes  associated  with
57       the container will not be included into the checkpoint tar.gz file.
58       The default is false.
59
60
61   --keep, -k
62       Keep  all  temporary  log  and  statistics files created by CRIU during
63       checkpointing. These files are not deleted if checkpointing  fails  for
64       further  debugging. If checkpointing succeeds these files are theoreti‐
65       cally not needed, but if these files are needed  Podman  can  keep  the
66       files for further analysis.
67       The default is false.
68
69
70   --latest, -l
71       Instead  of  providing  the  container ID or name, use the last created
72       container. If other methods than Podman are used to run containers such
73       as  CRI-O,  the  last  started  container could be from either of those
74       methods.
75       The default is false.
76       IMPORTANT: This OPTION is not available with the remote Podman  client.
77       This OPTION does not need a container name or ID as input argument.
78
79
80   --leave-running, -R
81       Leave the container running after checkpointing instead of stopping it.
82       The default is false.
83
84
85   --pre-checkpoint, -P
86       Dump  the  container's  memory  information only, leaving the container
87       running. Later operations will supersede prior dumps. It only works  on
88       runc 1.0-rc3 or higher.
89       The default is false.
90
91
92   --tcp-established
93       Checkpoint  a container with established TCP connections. If the check‐
94       point image contains established TCP connections, this  OPTION  is  re‐
95       quired  during  restore.  Defaults to not checkpointing containers with
96       established TCP connections.
97       The default is false.
98
99
100   --with-previous
101       Check out the container with previous criu image files in pre-dump.  It
102       only works on runc 1.0-rc3 or higher.
103       The default is false.
104       *IMPORTANT: This OPTION is not available with --pre-checkpoint*.
105
106

EXAMPLES

108       Make a checkpoint for the container "mywebserver".
109
110
111              # podman container checkpoint mywebserver
112
113
114
115       Dumps  the  container's memory information of the latest container into
116       an archive.
117
118
119              # podman container checkpoint -P -e pre-checkpoint.tar.gz -l
120
121
122
123       Keep the container's memory information from an older dump and add  the
124       new container's memory information.
125
126
127              # podman container checkpoint --with-previous -e checkpoint.tar.gz -l
128
129
130
131       Dump the container's memory information of the latest container into an
132       archive with the specified compress method.
133
134
135              # podman container checkpoint -l --compress=none --export=dump.tar
136              # podman container checkpoint -l --compress=gzip --export=dump.tar.gz
137
138
139

SEE ALSO

141       podman(1), podman-container-restore(1)
142
143

HISTORY

145       September 2018, Originally compiled by Adrian  Reber  areber@redhat.com
146       ⟨mailto:areber@redhat.com⟩
147
148
149
150                                              podman-container-checkpoint(1)()
Impressum