Document needs-external-kernel template option.

[mclu.git] / mclu.pod

diff --git a/mclu.pod b/mclu.pod
index 54bc6f0..63b9b20 100644 (file)
--- a/mclu.pod
+++ b/mclu.pod
@@ -274,6 +274,12 @@ probe.
 
 The output format (eg. C<qcow2>).
 
+=item C<$guest_arch>
+
+The guest architecture (eg. "x86_64").  This is the output of the
+C<guest-arch> probe.  If the template doesn't provide that, it
+defaults to the cluster node's host architecture.
+
 =item C<$name>
 
 The hostname.
@@ -298,6 +304,14 @@ template can choose a default size.
 The template MAY print the disk type supported by this guest.  Possible
 values include C<ide>, C<virtio>, C<virtio-scsi>.
 
+=item guest-arch
+
+The template MAY print the guest architecture.
+
+If supplied, this acts as a hint when generating the XML in the C<mclu
+boot> subcommand.  The default is to assume the guest architecture is
+the same as the cluster host on which the guest runs.
+
 =item minimum-memory
 
 The template MAY print the minimum memory (RAM) required by this
@@ -308,6 +322,14 @@ guest.  Abbreviations like C<1G> are supported.
 The template MAY print the minimum disk space required by this guest.
 Abbreviations like C<10G> are supported.
 
+=item needs-external-kernel
+
+The template MAY print C<yes> or C<1>.  If it does so then after the
+guest has been built, L<virt-get-kernel(1)> is run to extract the
+kernel and initrd from the guest, and these are used to boot the guest
+with an external kernel and initrd (ie. using the libvirt
+C<E<lt>kernelE<gt>> and C<E<lt>initrdE<gt>> directives).
+
 =item network-model
 
 The template MAY print the network type supported by this guest.