Add help files for nfsboot, rawdisk and tar.baserock/markdoffman/s10617/add-yaml-help-option

Begin adding help documentation for configuration
and write extensions starting with nfsboot.write,
rawdisk.write and tar.write.

3 files changed, 24 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.
diff --git a/morphlib/exts/rawdisk.write.help b/morphlib/exts/rawdisk.write.help
new file mode 100644
index 00000000..a514a4e8
--- /dev/null
+++ b/morphlib/exts/rawdisk.write.help
@@ -0,0 +1,7 @@
+help: |
+    Create a raw disk image during Morph's deployment.
+    
+    If the image already exists, it is upgraded.
+
+    The `location` argument is a pathname to the image to be
+    created or upgraded.
diff --git a/morphlib/exts/tar.write.help b/morphlib/exts/tar.write.help
new file mode 100644
index 00000000..f052ac03
--- /dev/null
+++ b/morphlib/exts/tar.write.help
@@ -0,0 +1,5 @@
+help: |
+    Create a .tar file of the deployed system.
+    
+    The `location` argument is a pathname to the .tar file to be
+    created.