@@ -27,8 +27,8 @@ This program tries to provide a similar functionality for containers, allowing y
27
27
28
28
## Usage
29
29
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 `
32
32
so ` container-hotplug ` can find it.
33
33
34
34
It 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
43
43
}
44
44
}
45
45
```
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.
47
47
``` bash
48
48
sudo docker run --runtime hotplug -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest
49
49
```
@@ -53,7 +53,7 @@ For podman, you can specify the path directly, by:
53
53
sudo podman run --runtime /path/to/container-hotplug/binary -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest
54
54
```
55
55
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:
57
57
``` toml
58
58
[plugins ."io .containerd .grpc .v1 .cri" .containerd .runtimes .hotplug ]
59
59
runtime_type = " io.containerd.runc.v2"
@@ -71,7 +71,7 @@ metadata:
71
71
name : hotplug
72
72
handler : hotplug
73
73
` ` `
74
- and use it in pod with
74
+ and use it in a pod with
75
75
` ` ` yaml
76
76
apiVersion : v1
77
77
kind : Pod
0 commit comments