Skip to content

Commit

Permalink
Merge pull request #483 from vorburger/patch-1
Browse files Browse the repository at this point in the history
clarify endpoints in crictl doc
  • Loading branch information
k8s-ci-robot authored Jul 14, 2019
2 parents f190a92 + 88ed5c3 commit c8292dd
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/crictl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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
Expand Down

0 comments on commit c8292dd

Please sign in to comment.