diff options
| author | Daniel J Walsh <dwalsh@redhat.com> | 2017-12-15 16:58:36 -0500 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2017-12-18 16:46:05 +0000 |
| commit | 5770dc2640c216525ab84031e3712fcc46b3b087 (patch) | |
| tree | 8a1c5c4e4a6ce6a35a3767247623a62bfd698f77 /cmd/podman/README.md | |
| parent | de3468e120d489d046c08dad72ba2262e222ccb1 (diff) | |
| download | podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.gz podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.bz2 podman-5770dc2640c216525ab84031e3712fcc46b3b087.zip | |
Rename all references to kpod to podman
The decision is in, kpod is going to be named podman.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Closes: #145
Approved by: umohnani8
Diffstat (limited to 'cmd/podman/README.md')
| -rw-r--r-- | cmd/podman/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/cmd/podman/README.md b/cmd/podman/README.md new file mode 100644 index 000000000..6978b056a --- /dev/null +++ b/cmd/podman/README.md @@ -0,0 +1,16 @@ +# podman - Simple debugging tool for pods and images +podman is a simple client only tool to help with debugging issues when daemons such as CRI runtime and the kubelet are not responding or +failing. A shared API layer could be created to share code between the daemon and podman. podman does not require any daemon running. podman +utilizes the same underlying components that crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate, runc or +any other OCI compatible runtime. podman shares state with crio and so has the capability to debug pods/images created by crio. + +## Use cases +1. List pods. +2. Launch simple pods (that require no daemon support). +3. Exec commands in a container in a pod. +4. Launch additional containers in a pod. +5. List images. +6. Remove images not in use. +7. Pull images. +8. Check image size. +9. Report pod disk resource usage. |