aboutsummaryrefslogtreecommitdiff
path: root/docs/podman-container-restore.1.md
diff options
context:
space:
mode:
authorAdrian Reber <areber@redhat.com>2018-09-19 16:58:34 +0000
committerAdrian Reber <adrian@lisas.de>2018-10-03 21:41:40 +0200
commite2b639a32fa2386c53d8a77fe18543bb054a95dd (patch)
tree926288907d812987cca930edcd697a5d3419199d /docs/podman-container-restore.1.md
parentf7c8fd8a3d6f289a3abee1e2f676bfb956f7195c (diff)
downloadpodman-e2b639a32fa2386c53d8a77fe18543bb054a95dd.tar.gz
podman-e2b639a32fa2386c53d8a77fe18543bb054a95dd.tar.bz2
podman-e2b639a32fa2386c53d8a77fe18543bb054a95dd.zip
docs: add checkpoint and restore man pages
This adds the podman-container-checkpoint and podman-container-restore man pages. Signed-off-by: Adrian Reber <areber@redhat.com>
Diffstat (limited to 'docs/podman-container-restore.1.md')
-rw-r--r--docs/podman-container-restore.1.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/podman-container-restore.1.md b/docs/podman-container-restore.1.md
new file mode 100644
index 000000000..6360bccb0
--- /dev/null
+++ b/docs/podman-container-restore.1.md
@@ -0,0 +1,37 @@
+% podman-container-restore(1)
+
+## NAME
+podman\-container\-restore - Restores one or more running containers
+
+## SYNOPSIS
+**podman container restore** [*options*] *container* ...
+
+## DESCRIPTION
+Restores a container from a checkpoint. You may use container IDs or names as input.
+
+## OPTIONS
+**-k**, **--keep**
+
+Keep all temporary log and statistics files created by CRIU during
+checkpointing as well as restoring. These files are not deleted if restoring
+fails for further debugging. If restoring succeeds these files are
+theoretically not needed, but if these files are needed Podman can keep the
+files for further analysis. This includes the checkpoint directory with all
+files created during checkpointing. The size required by the checkpoint
+directory is roughly the same as the amount of memory required by the
+processes in the checkpointed container.
+
+Without the **-k**, **--keep** option the checkpoint will be consumed and cannot be used
+again.
+
+## EXAMPLE
+
+podman container restore mywebserver
+
+podman container restore 860a4b23
+
+## SEE ALSO
+podman(1), podman-container-checkpoint(1)
+
+## HISTORY
+September 2018, Originally compiled by Adrian Reber <areber@redhat.com>