From c0b7ec0fd1587a25190677a70104263ab516c8a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jake=20Buchholz=20G=C3=B6kt=C3=BCrk?= Date: Thu, 27 Jan 2022 18:49:32 -0800 Subject: [PATCH] add hotplug module info to README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e216137..1d02a3f 100644 --- a/README.md +++ b/README.md @@ -136,4 +136,17 @@ new image will also run Tiny Cloud init scripts during their first boot. ### `vnic_eth_hotplug` -### `nvme_ebs_links` \ No newline at end of file +This hotplug module adds and removes ethernet interfaces as virtual NICs are +attached/detached from the instance. + +An `ifupdown-ng` executor also syncs the interfaces' secondary IPv4 and IPV6 +addresses associated with those VNICs, if the cloud's IMDS provides that +configuration data. + +### `nvme_ebs_links` + +EBS volumes are attached to AWS EC2 Nitro instances using the NVMe driver. +Unfortunately, the `/dev/nvme*` device names do not match the device name +assigned to the attached EBS volume. This hotplug module figures out what the +assigned device name is, and sets up `/dev/xvd*` and `/dev/sd*` symlinks to +the right NVMe devices for EBS volumes and their partitions.