Merge remote-tracking branch 'petefoth/petefoth/generic-params2'

Reviewed-By: James Thomas <james.thomas@codethink.co.uk>
Reviewed-By: Sam Thursfield <sam.thursfield@codethink.co.uk>

5 files changed, 109 insertions, 4 deletions

diff --git a/kvm.write.help b/kvm.write.help
index 26a54d9c..04393b8a 100644
--- a/kvm.write.help
+++ b/kvm.write.help
@@ -42,6 +42,35 @@ help: |
     * AUTOSTART=<VALUE>` - boolean. If it is set, the VM will be started when
       it has been deployed.
 
+    * DTB_PATH=path: **(MANDATORY)** for systems that require a device tree
+      binary - Give the full path (without a leading /) to the location of the
+      DTB in the built system image . The deployment will fail if `path` does
+      not exist.
+
+    * BOOTLOADER_INSTALL=value: the bootloader to be installed
+      **(MANDATORY)** for non-x86 systems
+
+        allowed values =
+        - 'extlinux' (default) - the extlinux bootloader will
+           be installed
+        - 'none' - no bootloader will be installed by `morph deploy`. A
+           bootloader must be installed manually. This value must be used when
+           deploying non-x86 systems such as ARM.
+
+    * BOOTLOADER_CONFIG_FORMAT=value: the bootloader format to be used.
+      If not specified for x86-32 and x86-64 systems, 'extlinux' will be used
+
+        allowed values =
+        - 'extlinux'
+
+    * KERNEL_ARGS=args: optional additional kernel command-line parameters to
+      be appended to the default set. The default set is:
+
+        'rw init=/sbin/init rootfstype=btrfs \
+          rootflags=subvol=systems/default/run \
+          root=[name or UUID of root filesystem]'
+
+        (See https://www.kernel.org/doc/Documentation/kernel-parameters.txt)
+
     (See `morph help deploy` for details of how to pass parameters to write
     extensions)
-    
diff --git a/nfsboot.write b/nfsboot.write
index 8d3d6df7..49d71174 100755
--- a/nfsboot.write
+++ b/nfsboot.write
@@ -17,6 +17,16 @@
 
 '''A Morph deployment write extension for deploying to an nfsboot server
 
+*** DO NOT USE ***
+- This was written before 'proper' deployment mechanisms were in place
+It is unlikely to work at all and will not work correctly
+
+Use the pxeboot write extension instead
+
+***
+
+
+
 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
@@ -125,7 +135,7 @@ class NFSBootWriteExtension(morphlib.writeexts.WriteExtension):
 
         self.status(msg='Creating destination directories')
         try:
-            cliapp.ssh_runcmd('root@%s' % location, 
+            cliapp.ssh_runcmd('root@%s' % location,
                               ['mkdir', '-p', orig_path, run_path])
         except cliapp.AppException:
             raise cliapp.AppException('Could not create dirs %s and %s on %s'
@@ -191,4 +201,3 @@ mv "$temp" "$target"
 
 
 NFSBootWriteExtension().run()
-
diff --git a/nfsboot.write.help b/nfsboot.write.help
index 598b1b23..310fd7a4 100644
--- a/nfsboot.write.help
+++ b/nfsboot.write.help
@@ -1,6 +1,13 @@
 help: |
+    *** DO NOT USE ***
+    - This was written before 'proper' deployment mechanisms were in place.
+    It is unlikely to work at all, and will not work correctly.
+
+    Use the pxeboot write extension instead
+
+    ***
     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
diff --git a/rawdisk.write.help b/rawdisk.write.help
index 81f35024..54af81c4 100644
--- a/rawdisk.write.help
+++ b/rawdisk.write.help
@@ -34,5 +34,35 @@ help: |
     * INITRAMFS_PATH=path: the location of an initramfs for the bootloader to
       tell Linux to use, rather than booting the rootfs directly.
 
+    * DTB_PATH=path: **(MANDATORY)** for systems that require a device tree
+      binary - Give the full path (without a leading /) to the location of the
+      DTB in the built system image . The deployment will fail if `path` does
+      not exist.
+
+    * BOOTLOADER_INSTALL=value: the bootloader to be installed
+      **(MANDATORY)** for non-x86 systems
+
+        allowed values =
+        - 'extlinux' (default) - the extlinux bootloader will
+           be installed
+        - 'none' - no bootloader will be installed by `morph deploy`. A
+           bootloader must be installed manually. This value must be used when
+           deploying non-x86 systems such as ARM.
+
+    * BOOTLOADER_CONFIG_FORMAT=value: the bootloader format to be used.
+      If not specified for x86-32 and x86-64 systems, 'extlinux' will be used
+
+        allowed values =
+        - 'extlinux'
+
+    * KERNEL_ARGS=args: optional additional kernel command-line parameters to
+      be appended to the default set. The default set is:
+
+        'rw init=/sbin/init rootfstype=btrfs \
+          rootflags=subvol=systems/default/run \
+          root=[name or UUID of root filesystem]'
+
+        (See https://www.kernel.org/doc/Documentation/kernel-parameters.txt)
+
     (See `morph help deploy` for details of how to pass parameters to write
     extensions)
diff --git a/virtualbox-ssh.write.help b/virtualbox-ssh.write.help
index b4c59553..cb50acc0 100644
--- a/virtualbox-ssh.write.help
+++ b/virtualbox-ssh.write.help
@@ -41,6 +41,36 @@ help: |
     * INITRAMFS_PATH=path: the location of an initramfs for the bootloader to
       tell Linux to use, rather than booting the rootfs directly.
 
+    * DTB_PATH=path: **(MANDATORY)** for systems that require a device tree
+      binary - Give the full path (without a leading /) to the location of the
+      DTB in the built system image . The deployment will fail if `path` does
+      not exist.
+
+    * BOOTLOADER_INSTALL=value: the bootloader to be installed
+      **(MANDATORY)** for non-x86 systems
+
+        allowed values =
+        - 'extlinux' (default) - the extlinux bootloader will
+           be installed
+        - 'none' - no bootloader will be installed by `morph deploy`. A
+           bootloader must be installed manually. This value must be used when
+           deploying non-x86 systems such as ARM.
+
+    * BOOTLOADER_CONFIG_FORMAT=value: the bootloader format to be used.
+      If not specified for x86-32 and x86-64 systems, 'extlinux' will be used
+
+        allowed values =
+        - 'extlinux'
+
+    * KERNEL_ARGS=args: optional additional kernel command-line parameters to
+      be appended to the default set. The default set is:
+
+        'rw init=/sbin/init rootfstype=btrfs \
+          rootflags=subvol=systems/default/run \
+          root=[name or UUID of root filesystem]'
+
+        (See https://www.kernel.org/doc/Documentation/kernel-parameters.txt)
+
     * AUTOSTART=<VALUE> - boolean. If it is set, the VM will be started when
       it has been deployed.