Skip to content

Commit cb55041

Browse files
committed
Add a mapping table from docker cli to crictl in crictl debugging doc
Signed-off-by: Qiutong Song <[email protected]>
1 parent b905af1 commit cb55041

File tree

1 file changed

+46
-1
lines changed
  • content/en/docs/tasks/debug-application-cluster

1 file changed

+46
-1
lines changed

content/en/docs/tasks/debug-application-cluster/crictl.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,4 +356,49 @@ CONTAINER ID IMAGE CREATED STATE
356356
See [kubernetes-sigs/cri-tools](https://github.com/kubernetes-sigs/cri-tools)
357357
for more information.
358358

359-
359+
## Mapping from docker cli to crictl
360+
361+
The exact versions for below mapping table are for docker cli v1.40 and crictl v1.19.0. Please note that the list is not exhaustive. For example, it doesn't include experimental commands of docker cli.
362+
363+
Warn: the output format of CRICTL is similar to Docker CLI, despite some missing columns for some CLI. Make sure to check output for the specific command if your script output parsing.
364+
365+
### Retrieve Debugging Information
366+
367+
368+
docker cli | crictl | Description | Unsupported Features
369+
-- | -- | -- | --
370+
attach | attach | Attach to a running container | --detach-keys, --sig-proxy
371+
exec | exec | Run a command in a running container | --privileged, --user, --detach-keys
372+
images | images | List images |  
373+
info | info | Display system-wide information |  
374+
inspect | inspectinspecti | Return low-level information on a container, image or task |  
375+
logs | logs | Fetch the logs of a container | --details
376+
ps | ps | List containers |  
377+
stats | stats | Display a live stream of container(s) resource usage statistics | Column: NET/BLOCK I/O, PIDs
378+
version | version | Show the runtime (Docker, ContainerD, or others) version information |  
379+
380+
### Perform Changes
381+
382+
docker cli | crictl | Description | Unsupported Features
383+
-- | -- | -- | --
384+
create | create | Create a new container |  
385+
kill | stop (timeout = 0) | Kill one or more running container | --signal
386+
pull | pull | Pull an image or a repository from a registry | --all-tags, --disable-content-trust
387+
rm | rm | Remove one or more containers |  
388+
rmi | rmi | Remove one or more images |  
389+
run | run | Run a command in a new container |  
390+
start | start | Start one or more stopped containers | --detach-keys
391+
stop | stop | Stop one or more running containers |  
392+
update | update | Update configuration of one or more containers | --restart, --blkio-weight and some other resource limit not supported by CRI.
393+
394+
### Supported only in crictl
395+
396+
crictl | Description
397+
-- | --
398+
imagefsinfo | Return image filesystem info
399+
inspectp | Display the status of one or more pods
400+
port-forward | Forward local port to a pod
401+
pods | List pods
402+
runp | Run a new pod
403+
rmp | Remove one or more pods
404+
stopp | Stop one or more running pods

0 commit comments

Comments
 (0)