summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Doffman <mark.doffman@codethink.co.uk>2014-04-01 03:27:53 +0000
committerMark Doffman <mark.doffman@codethink.co.uk>2014-04-01 03:27:53 +0000
commitfaa30c752633303baf53cf61de5bae42f43f6ab0 (patch)
tree8205281f872ac67222cdf103be22f1ccd68abe1a
parent703572829cb5e4d2a45109020a8f7a32c031f554 (diff)
downloaddefinitions-faa30c752633303baf53cf61de5bae42f43f6ab0.tar.gz
Add help files for nfsboot, rawdisk and tar.
Begin adding help documentation for configuration and write extensions starting with nfsboot.write, rawdisk.write and tar.write.
-rw-r--r--nfsboot.write.help12
-rw-r--r--rawdisk.write.help7
-rw-r--r--tar.write.help5
3 files changed, 24 insertions, 0 deletions
diff --git a/nfsboot.write.help b/nfsboot.write.help
new file mode 100644
index 00000000..598b1b23
--- /dev/null
+++ b/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/rawdisk.write.help b/rawdisk.write.help
new file mode 100644
index 00000000..a514a4e8
--- /dev/null
+++ b/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/tar.write.help b/tar.write.help
new file mode 100644
index 00000000..f052ac03
--- /dev/null
+++ b/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.