From f2cd92fe951019f65555b7b851822538d10564e1 Mon Sep 17 00:00:00 2001 From: Gary Guo Date: Fri, 26 Apr 2024 17:28:15 +0100 Subject: [PATCH] Apply README suggestions from code review Co-authored-by: James Wainwright --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 30eba02..b8ad42d 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,8 @@ This program tries to provide a similar functionality for containers, allowing y ## Usage -This tool wraps `runc` command, with the additional hotplug feature. Therefore, it can be used as a drop in replace for -many container managers/orchestrators that makes use of runc as runtime. You need to ensure `runc` is available in your `PATH` +This tool wraps `runc` with the additional hotplug feature, therefore it can be used as a drop in replace for +many container managers/orchestrators such as Docker, Podman, and Kubernetes. You need to ensure `runc` is available in your `PATH` so `container-hotplug` can find it. 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 } } ``` -and use it by `--runtime hotplug` and appropriate annotation, e.g. +and use it with the `--runtime hotplug` flag and appropriate annotation, e.g. ```bash sudo docker run --runtime hotplug -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest ``` @@ -53,7 +53,7 @@ For podman, you can specify the path directly, by: sudo podman run --runtime /path/to/container-hotplug/binary -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest ``` -For containerd (e.g. when using kubernetes), you can `/etc/containerd/config.toml` to add: +For containerd (e.g. when using kubernetes), you can edit `/etc/containerd/config.toml` to add: ```toml [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.hotplug] runtime_type = "io.containerd.runc.v2" @@ -71,7 +71,7 @@ metadata: name: hotplug handler: hotplug ``` -and use it in pod with +and use it in a pod with ```yaml apiVersion: v1 kind: Pod