@@ -27,8 +27,8 @@ This program tries to provide a similar functionality for containers, allowing y
2727
2828## Usage
2929
30- This tool wraps ` runc ` command, with the additional hotplug feature. Therefore, it can be used as a drop in replace for
31- many container managers/orchestrators that makes use of runc as runtime . You need to ensure ` runc ` is available in your ` PATH `
30+ This tool wraps ` runc ` with the additional hotplug feature, therefore it can be used as a drop in replace for
31+ many container managers/orchestrators such as Docker, Podman, and Kubernetes . You need to ensure ` runc ` is available in your ` PATH `
3232so ` container-hotplug ` can find it.
3333
3434It supports two annotations, ` org.lowrisc.hotplug.device ` and ` org.lowrisc.hotplug.symlinks ` .
@@ -43,7 +43,7 @@ For Docker, you can specify an alternative runtime by [changing /etc/docker/daem
4343 }
4444}
4545```
46- and use it by ` --runtime hotplug ` and appropriate annotation, e.g.
46+ and use it with the ` --runtime hotplug ` flag and appropriate annotation, e.g.
4747``` bash
4848sudo docker run --runtime hotplug -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest
4949```
@@ -53,7 +53,7 @@ For podman, you can specify the path directly, by:
5353sudo podman run --runtime /path/to/container-hotplug/binary -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest
5454```
5555
56- For containerd (e.g. when using kubernetes), you can ` /etc/containerd/config.toml ` to add:
56+ For containerd (e.g. when using kubernetes), you can edit ` /etc/containerd/config.toml ` to add:
5757``` toml
5858[plugins ."io .containerd .grpc .v1 .cri" .containerd .runtimes .hotplug ]
5959 runtime_type = " io.containerd.runc.v2"
@@ -71,7 +71,7 @@ metadata:
7171 name : hotplug
7272handler : hotplug
7373` ` `
74- and use it in pod with
74+ and use it in a pod with
7575` ` ` yaml
7676apiVersion : v1
7777kind : Pod
0 commit comments