summaryrefslogtreecommitdiff
path: root/cmd/podman/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/podman/README.md')
-rw-r--r--cmd/podman/README.md16
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.