diff options
| author | Matthew Heon <matthew.heon@gmail.com> | 2017-11-01 14:38:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-11-01 14:38:21 -0400 |
| commit | f5019df3f5da9030ce21e5c8ad3d3921a6585e7f (patch) | |
| tree | 05412dcc190ca026dbe51a4ef72bb91ff646e7c6 /cmd/kpod/README.md | |
| parent | 2b74391cd5281f6fdf391ff8ad50fd1490f6bf89 (diff) | |
| parent | eab0737f1189a7b88f0a37a6b894ca4345b6853f (diff) | |
| download | podman-f5019df3f5da9030ce21e5c8ad3d3921a6585e7f.tar.gz podman-f5019df3f5da9030ce21e5c8ad3d3921a6585e7f.tar.bz2 podman-f5019df3f5da9030ce21e5c8ad3d3921a6585e7f.zip | |
Merge pull request #1 from mheon/master
Initial checkin
Diffstat (limited to 'cmd/kpod/README.md')
| -rw-r--r-- | cmd/kpod/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/cmd/kpod/README.md b/cmd/kpod/README.md new file mode 100644 index 000000000..7a79e4893 --- /dev/null +++ b/cmd/kpod/README.md @@ -0,0 +1,16 @@ +# kpod - Simple debugging tool for pods and images +kpod 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 kpod. kpod does not require any daemon running. kpod +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. kpod 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. |