Skip to content

Commit cbb35f7

Browse files
authored
Merge pull request #41407 from Ritikaa96/fix-deprecation-notice
fixing deprecation note for map-crictl-dockercli deprecation
2 parents 801c341 + 90151db commit cbb35f7

File tree

1 file changed

+6
-63
lines changed

1 file changed

+6
-63
lines changed

content/en/docs/reference/tools/map-crictl-dockercli.md

Lines changed: 6 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,70 +4,13 @@ content_type: reference
44
weight: 10
55
---
66

7-
{{% thirdparty-content %}}
8-
9-
`crictl` is a command-line interface for {{<glossary_tooltip term_id="cri" text="CRI">}}-compatible container runtimes.
10-
You can use it to inspect and debug container runtimes and applications on a
11-
Kubernetes node. `crictl` and its source are hosted in the
12-
[cri-tools](https://github.com/kubernetes-sigs/cri-tools) repository.
13-
14-
This page provides a reference for mapping common commands for the `docker`
15-
command-line tool into the equivalent commands for `crictl`.
16-
17-
## Mapping from docker CLI to crictl
18-
19-
The exact versions for the mapping table are for `docker` CLI v1.40 and `crictl`
20-
v1.19.0. This list is not exhaustive. For example, it doesn't include
21-
experimental `docker` CLI commands.
227

238
{{< note >}}
24-
The output format of `crictl` is similar to `docker` CLI, despite some missing
25-
columns for some CLI. Make sure to check output for the specific command if your
26-
command output is being parsed programmatically.
27-
{{< /note >}}
28-
29-
### Retrieve debugging information
30-
31-
{{< table caption="mapping from docker cli to crictl - retrieve debugging information" >}}
32-
docker cli | crictl | Description | Unsupported Features
33-
-- | -- | -- | --
34-
`attach` | `attach` | Attach to a running container | `--detach-keys`, `--sig-proxy`
35-
`exec` | `exec` | Run a command in a running container | `--privileged`, `--user`, `--detach-keys`
36-
`images` | `images` | List images |  
37-
`info` | `info` | Display system-wide information |  
38-
`inspect` | `inspect`, `inspecti` | Return low-level information on a container, image or task |  
39-
`logs` | `logs` | Fetch the logs of a container | `--details`
40-
`ps` | `ps` | List containers |  
41-
`stats` | `stats` | Display a live stream of container(s) resource usage statistics | Column: NET/BLOCK I/O, PIDs
42-
`version` | `version` | Show the runtime (Docker, ContainerD, or others) version information |  
43-
{{< /table >}}
44-
45-
### Perform Changes
46-
47-
{{< table caption="mapping from docker cli to crictl - perform changes" >}}
48-
docker cli | crictl | Description | Unsupported Features
49-
-- | -- | -- | --
50-
`create` | `create` | Create a new container |  
51-
`kill` | `stop` (timeout = 0) | Kill one or more running container | `--signal`
52-
`pull` | `pull` | Pull an image or a repository from a registry | `--all-tags`, `--disable-content-trust`
53-
`rm` | `rm` | Remove one or more containers |  
54-
`rmi` | `rmi` | Remove one or more images |  
55-
`run` | `run` | Run a command in a new container |  
56-
`start` | `start` | Start one or more stopped containers | `--detach-keys`
57-
`stop` | `stop` | Stop one or more running containers |  
58-
`update` | `update` | Update configuration of one or more containers | `--restart`, `--blkio-weight` and some other resource limit not supported by CRI.
59-
{{< /table >}}
609

61-
### Supported only in crictl
10+
This page is being directed to
11+
https://v1-24.docs.kubernetes.io/docs/reference/tools/map-crictl-dockercli/ because of the
12+
[removal of dockershim from crictl in v1.24](https://github.com/kubernetes-sigs/cri-tools/issues/870).
13+
As per our community policy, deprecated documents are not maintained beyond next three versions.
14+
The reason for deprecation is explained in [Dockershim-FAQ](https://kubernetes.io/blog/2020/12/02/dockershim-faq/).
6215

63-
{{< table caption="mapping from docker cli to crictl - supported only in crictl" >}}
64-
crictl | Description
65-
-- | --
66-
`imagefsinfo` | Return image filesystem info
67-
`inspectp` | Display the status of one or more pods
68-
`port-forward` | Forward local port to a pod
69-
`pods` | List pods
70-
`runp` | Run a new pod
71-
`rmp` | Remove one or more pods
72-
`stopp` | Stop one or more running pods
73-
{{< /table >}}
16+
{{</ note >}}

0 commit comments

Comments
 (0)