summaryrefslogtreecommitdiff
path: root/morphlib/exts/nfsboot.write.help
diff options
context:
space:
mode:
Diffstat (limited to 'morphlib/exts/nfsboot.write.help')
-rw-r--r--morphlib/exts/nfsboot.write.help12
1 files changed, 12 insertions, 0 deletions
diff --git a/morphlib/exts/nfsboot.write.help b/morphlib/exts/nfsboot.write.help
new file mode 100644
index 00000000..598b1b23
--- /dev/null
+++ b/morphlib/exts/nfsboot.write.help
@@ -0,0 +1,12 @@
+help: |
+ Deploy a system image and kernel to an nfsboot server.
+
+ An nfsboot server is defined as a baserock system that has
+ tftp and nfs servers running, the tftp server is exporting
+ the contents of /srv/nfsboot/tftp/ and the user has sufficient
+ permissions to create nfs roots in /srv/nfsboot/nfs/.
+
+ The `location` argument is the hostname of the nfsboot server.
+
+ The extension will connect to root@HOST via ssh to copy the
+ kernel and rootfs, and configure the nfs server.