summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@gmail.com>2018-05-11 10:43:34 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-05-11 15:32:27 +0000
commitc339c5bb6e1d3d894d8020dc63ae8cf3c2f50e56 (patch)
tree160604c63b39a762a2a1c1e07102a381784c231d
parent4c907ce81ab2c86ecbc70166561b686f393d7382 (diff)
downloadpodman-c339c5bb6e1d3d894d8020dc63ae8cf3c2f50e56.tar.gz
podman-c339c5bb6e1d3d894d8020dc63ae8cf3c2f50e56.tar.bz2
podman-c339c5bb6e1d3d894d8020dc63ae8cf3c2f50e56.zip
Update Podman-specific readme
Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #754 Approved by: baude
-rw-r--r--cmd/podman/README.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/cmd/podman/README.md b/cmd/podman/README.md
index 6978b056a..0fee7eafa 100644
--- a/cmd/podman/README.md
+++ b/cmd/podman/README.md
@@ -1,16 +1,15 @@
# 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.
+podman is a daemonless container runtime for managing containers, pods, and container images.
+It is intended as a counterpart to CRI-O, to provide low-level debugging not available through the CRI interface used by Kubernetes.
+It can also act as a container runtime independent of CRI-O, creating and managing its own set of containers.
## 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.
+1. Create containers
+2. Start, stop, signal, attach to, and inspect existing containers
+3. Run new commands in existing containers
+4. Push and pull images
+5. List and inspect existing images
+6. Create new images by committing changes within a container
+7. Create pods
+8. Start, stop, signal, and inspect existing pods
+9. Populate pods with containers