container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-20 09:13:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add checkpoint and restore man pages

Browse source 
This adds the podman-container-checkpoint and
podman-container-restore man pages.

Signed-off-by: Adrian Reber <areber@redhat.com>
This commit is contained in:
Adrian Reber 2018-09-19 16:58:34 +00:00 committed by Adrian Reber
parent f7c8fd8a3d
commit e2b639a32f
Failed to extract signature
3 changed files with 69 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/podman-container-checkpoint.1.md Normal file
View file

@ -0,0 +1,30 @@
% podman-container-checkpoint(1)
## NAME
podman\-container\-checkpoint - Checkpoints one or more running containers
## SYNOPSIS
**podman container checkpoint** [*options*] *container* ...
## DESCRIPTION
Checkpoints all the processes in one or more containers. You may use container IDs or names as input.
## OPTIONS
**-k**, **--keep**
Keep all temporary log and statistics files created by CRIU during checkpointing. These files
are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these
files are theoretically not needed, but if these files are needed Podman can keep the files
for further analysis.
## EXAMPLE
podman container checkpoint mywebserver
podman container checkpoint 860a4b23
## SEE ALSO
podman(1), podman-container-restore(1)
## HISTORY
September 2018, Originally compiled by Adrian Reber <areber@redhat.com>

37
docs/podman-container-restore.1.md Normal file
View file

@ -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>

2
docs/podman-container.1.md
View file

@ -14,6 +14,7 @@ The container command allows you to manage containers
| Command | Man Page | Description |
| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
| attach | [podman-attach(1)](podman-attach.1.md) | Attach to a running container. |
| checkpoint | [podman-container-checkpoint(1)](podman-container-checkpoint.1.md) | Checkpoints one or more containers. |
| cleanup | [podman-container-cleanup(1)](podman-container-cleanup.1.md) | Cleanup containers network and mountpoints. |
| commit | [podman-commit(1)](podman-commit.1.md) | Create new image based on the changed container. |
| create | [podman-create(1)](podman-create.1.md) | Create a new container. |
@ -29,6 +30,7 @@ The container command allows you to manage containers
| port | [podman-port(1)](podman-port.1.md) | List port mappings for the container. |
| refresh | [podman-refresh(1)](podman-container-refresh.1.md) | Refresh the state of all containers |
| restart | [podman-restart(1)](podman-restart.1.md) | Restart one or more containers. |
| restore | [podman-container-restore(1)](podman-container-restore.1.md) | Restores one or more containers from a checkpoint. |
| rm | [podman-rm(1)](podman-rm.1.md) | Remove one or more containers. |
| run | [podman-run(1)](podman-run.1.md) | Run a command in a container. |
| start | [podman-start(1)](podman-start.1.md) | Starts one or more containers. |