From a031b83a09a8628435317a03f199cdc18b78262f Mon Sep 17 00:00:00 2001 From: Matthew Heon Date: Wed, 1 Nov 2017 11:24:59 -0400 Subject: Initial checkin from CRI-O repo Signed-off-by: Matthew Heon --- cmd/kpod/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 cmd/kpod/README.md (limited to 'cmd/kpod/README.md') 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. -- cgit v1.2.3-54-g00ecf