From cb55041b1a06a08b58bc05a9a0a2a9b4ab2349fc Mon Sep 17 00:00:00 2001 From: Qiutong Song Date: Thu, 19 Nov 2020 10:16:33 +0000 Subject: [PATCH] Add a mapping table from docker cli to crictl in crictl debugging doc Signed-off-by: Qiutong Song --- .../tasks/debug-application-cluster/crictl.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/content/en/docs/tasks/debug-application-cluster/crictl.md b/content/en/docs/tasks/debug-application-cluster/crictl.md index ef80817082..e61ee50b60 100644 --- a/content/en/docs/tasks/debug-application-cluster/crictl.md +++ b/content/en/docs/tasks/debug-application-cluster/crictl.md @@ -356,4 +356,49 @@ CONTAINER ID IMAGE CREATED STATE See [kubernetes-sigs/cri-tools](https://github.com/kubernetes-sigs/cri-tools) for more information. +## Mapping from docker cli to crictl +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. + +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. + +### Retrieve Debugging Information + + +docker cli | crictl | Description | Unsupported Features +-- | -- | -- | -- +attach | attach | Attach to a running container | --detach-keys, --sig-proxy +exec | exec | Run a command in a running container | --privileged, --user, --detach-keys +images | images | List images |   +info | info | Display system-wide information |   +inspect | inspectinspecti | Return low-level information on a container, image or task |   +logs | logs | Fetch the logs of a container | --details +ps | ps | List containers |   +stats | stats | Display a live stream of container(s) resource usage statistics | Column: NET/BLOCK I/O, PIDs +version | version | Show the runtime (Docker, ContainerD, or others) version information |   + +### Perform Changes + +docker cli | crictl | Description | Unsupported Features +-- | -- | -- | -- +create | create | Create a new container |   +kill | stop (timeout = 0) | Kill one or more running container | --signal +pull | pull | Pull an image or a repository from a registry | --all-tags, --disable-content-trust +rm | rm | Remove one or more containers |   +rmi | rmi | Remove one or more images |   +run | run | Run a command in a new container |   +start | start | Start one or more stopped containers | --detach-keys +stop | stop | Stop one or more running containers |   +update | update | Update configuration of one or more containers | --restart, --blkio-weight and some other resource limit not supported by CRI. + +### Supported only in crictl + +crictl | Description +-- | -- +imagefsinfo | Return image filesystem info +inspectp | Display the status of one or more pods +port-forward | Forward local port to a pod +pods | List pods +runp | Run a new pod +rmp | Remove one or more pods +stopp | Stop one or more running pods