From 88ed5c34cebcac4727b28701765cb9360012afde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Fri, 12 Jul 2019 21:23:48 +0200 Subject: [PATCH] clarify endpoints in crictl doc --- docs/crictl.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/crictl.md b/docs/crictl.md index d626fa8060..c9e213b574 100644 --- a/docs/crictl.md +++ b/docs/crictl.md @@ -61,9 +61,15 @@ Subcommands includes: - `completion`: Output bash shell completion code - `help, h`: Shows a list of commands or help for one command -crictl connects to Unix: `unix:///var/run/dockershim.sock` or Windows: `tcp://localhost:3735` by default. For other runtimes, the endpoint can be set in three ways: +crictl by default connects to Unix: `unix:///var/run/dockershim.sock` or Windows: `tcp://localhost:3735`. For other runtimes, use: -- By setting flags `--runtime-endpoint` and `--image-endpoint` +* [containerd](https://containerd.io): `unix:///run/containerd/containerd.sock` +* [cri-o](https://cri-o.io): `unix:///var/run/crio/crio.sock` +* [frakti](https://github.com/kubernetes/frakti): `unix:///var/run/frakti.sock` + +The endpoint can be set in three ways: + +- By setting flags `--runtime-endpoint` (`-r`) and `--image-endpoint` (`-i`) - By setting environment variables `CONTAINER_RUNTIME_ENDPOINT` and `IMAGE_SERVICE_ENDPOINT` - By setting the endpoint in the config file `--config=/etc/crictl.yaml` @@ -86,8 +92,6 @@ debug: true ## Additional options -- `--runtime-endpoint`, `-r`: CRI server runtime endpoint (default: Unix: `unix:///var/run/dockershim.sock` or Windows: `tcp://localhost:3735`). The default server is dockershim. If we want to debug other CRI server such as frakti, we can add flag `--runtime-endpoint=/var/run/frakti.sock` -- `--image-endpoint`, `-i`: CRI server image endpoint, default same as runtime endpoint. - `--timeout`, `-t`: Timeout of connecting to server (default: 10s) - `--debug`, `-D`: Enable debug output - `--help`, `-h`: show help