aboutsummaryrefslogtreecommitdiff
path: root/docs/podman-container-cleanup.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2018-06-22 16:44:59 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-06-29 15:25:21 +0000
commit7fc1a329bd014d61f9895fc212aef452f6fb8f84 (patch)
tree9b67a2f36197369d487dd80927124e2dcb7056b8 /docs/podman-container-cleanup.1.md
parent41bd607c120dbd8b315eb30feb0fe63e079c821d (diff)
downloadpodman-7fc1a329bd014d61f9895fc212aef452f6fb8f84.tar.gz
podman-7fc1a329bd014d61f9895fc212aef452f6fb8f84.tar.bz2
podman-7fc1a329bd014d61f9895fc212aef452f6fb8f84.zip
Add `podman container cleanup` to CLI
When we run containers in detach mode, nothing cleans up the network stack or the mount points. This patch will tell conmon to execute the cleanup code when the container exits. It can also be called to attempt to cleanup previously running containers. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #942 Approved by: mheon
Diffstat (limited to 'docs/podman-container-cleanup.1.md')
-rw-r--r--docs/podman-container-cleanup.1.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/podman-container-cleanup.1.md b/docs/podman-container-cleanup.1.md
new file mode 100644
index 000000000..50054afe2
--- /dev/null
+++ b/docs/podman-container-cleanup.1.md
@@ -0,0 +1,38 @@
+% podman-container-cleanup "1"
+
+## NAME
+podman\-container\-cleanup - Cleanup Container storage and networks
+
+## SYNOPSIS
+**podman container cleanup [OPTIONS] CONTAINER**
+
+## DESCRIPTION
+`podman container cleanup` cleans up exited containers by removing all mountpoints and network configuration from the host. The container name or ID can be used. The cleanup command does not remove the containers. Running containers will not be cleaned up.
+Sometimes container's mount points and network stacks can remain if the podman command was killed or the container ran in daemon mode. This command is automatically executed when you run containers in daemon mode by the conmon process when the container exits.
+
+## OPTIONS
+
+**--all, a**
+
+Cleanup all containers.
+
+**--latest, -l**
+Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
+to run containers such as CRI-O, the last started container could be from either of those methods.
+## EXAMPLE
+
+`podman container cleanup mywebserver`
+
+`podman container cleanup mywebserver myflaskserver 860a4b23`
+
+`podman container cleanup 860a4b23`
+
+`podman container-cleanup -a`
+
+`podman container cleanup --latest`
+
+## SEE ALSO
+podman(1), podman-container(1)
+
+## HISTORY
+Jun 2018, Originally compiled by Dan Walsh <dwalsh@redhat.com>