opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-10-13 01:06:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation around checkpoints

Browse Source 
Checkpoint archives can now be zstd compressed, and are so by default.
Update the documentation to match.

Signed-off-by: Philipp Wagner <phw@ibm.com>
This commit is contained in:
Philipp Wagner
2025-07-04 21:31:24 +02:00
parent c8272b23a5
commit c5c6e44d7d
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/markdown/podman-container-checkpoint.1.md
View File

@ -84,10 +84,11 @@ to do the checkpoint:
#### **--export**, **-e**=*archive* #### **--export**, **-e**=*archive*
Export the checkpoint to a tar.gz file. The exported checkpoint can be used Export the checkpoint to an archive. The archive type is specified with
to import the *container* on another system and thus enabling container live **--compress**. The exported checkpoint can be used to import the *container* on
migration. This checkpoint archive also includes all changes to the *container's* another system and thus enabling container live migration. This checkpoint
root file-system, if not explicitly disabled using **--ignore-rootfs**. archive also includes all changes to the *container's* root file-system, if not
explicitly disabled using **--ignore-rootfs**.
#### **--file-locks** #### **--file-locks**
@ -99,7 +100,7 @@ The default is **false**.
#### **--ignore-rootfs** #### **--ignore-rootfs**
If a checkpoint is exported to a tar.gz file it is possible with the help of **--ignore-rootfs** to explicitly disable including changes to the root file-system into the checkpoint archive file.\ If a checkpoint is exported to an archive it is possible with the help of **--ignore-rootfs** to explicitly disable including changes to the root file-system into the checkpoint archive file.\
The default is **false**.\ The default is **false**.\
*IMPORTANT: This OPTION only works in combination with __--export, -e__.* *IMPORTANT: This OPTION only works in combination with __--export, -e__.*
@ -107,7 +108,7 @@ The default is **false**.\
This OPTION must be used in combination with the **--export, -e** OPTION. This OPTION must be used in combination with the **--export, -e** OPTION.
When this OPTION is specified, the content of volumes associated with When this OPTION is specified, the content of volumes associated with
the *container* is not included into the checkpoint tar.gz file.\ the *container* is not included into the checkpoint archive.\
The default is **false**. The default is **false**.
#### **--keep**, **-k** #### **--keep**, **-k**
@ -205,12 +206,12 @@ Create a checkpoint image for the container "mywebserver".
Dumps the container's memory information of the latest container into an archive. Dumps the container's memory information of the latest container into an archive.
``` ```
# podman container checkpoint -P -e pre-checkpoint.tar.gz -l # podman container checkpoint -P -e pre-checkpoint.tar.zst -l
``` ```
Keep the container's memory information from an older dump and add the new container's memory information. Keep the container's memory information from an older dump and add the new container's memory information.
``` ```
# podman container checkpoint --with-previous -e checkpoint.tar.gz -l # podman container checkpoint --with-previous -e checkpoint.tar.zst -l
``` ```
Dump the container's memory information of the latest container into an archive with the specified compress method. Dump the container's memory information of the latest container into an archive with the specified compress method.