summaryrefslogtreecommitdiffstats
path: root/builder/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'builder/INSTALL')
-rw-r--r--builder/INSTALL19
1 files changed, 19 insertions, 0 deletions
diff --git a/builder/INSTALL b/builder/INSTALL
new file mode 100644
index 00000000..e52f0c39
--- /dev/null
+++ b/builder/INSTALL
@@ -0,0 +1,19 @@
+This subfolder is dedicated to dracut related files.
+
+The folder 'dnbd3-qcow2-rootfs' is a dracut module used to setup
+a client's rootfs based on a (read-only) dnbd3 export made writable
+through the qcow2 container format of the qemu ecosystem.
+
+To use this module within dracut, you simply need to copy/link/mount
+the above mentioned folder to '/usr/lib/dracut/modules.d' prefixed
+with a numerical priority. We used '90' so far, so the module was linked
+to '/usr/lib/dracut/modules.d/90dnbd3-qcow2-rootfs'.
+
+Once the module has been integrated in dracut's modules, you can build
+the initramfs with the following command:
+
+ dracut --no-hostonly --modules "dnbd3-qcow2-rootfs" <target_path>
+
+Note that the '--no-hostonly' is critical if the machine dracut is
+executed on and the clients supposed to boot the resulting initramfs
+differ.