From a777f1ac88c2205174c92991092078314c2a4cce Mon Sep 17 00:00:00 2001 From: Pete Fotheringham Date: Wed, 26 Nov 2014 18:02:09 +0000 Subject: Add more information on existing parameters. Add AUTOSTART parameter --- morphlib/exts/kvm.write.help | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/morphlib/exts/kvm.write.help b/morphlib/exts/kvm.write.help index ad0e25f0..0b428e48 100644 --- a/morphlib/exts/kvm.write.help +++ b/morphlib/exts/kvm.write.help @@ -17,11 +17,19 @@ help: | * `testsys` is the name of the new guest VM'; * `/home/alice/testys.img` is the pathname of the disk image files on the target host. - * HOSTNAME: the hostname of the **guest** VM within the network into which - it is being deployed - * DISK_SIZE: the size of the VM's primary virtual hard disk - * RAM_SIZE: The amount of RAM that the virtual machine should allocate for - itself from the host. - * VCPUS: the number of virtual CPUs for the VM - * INITRAMFS_PATH: the location of an initramfs for the bootloader to tell - Linux to use, rather than booting the rootfs directly. + * HOSTNAME=name: the hostname of the **guest** VM within the network into + which it is being deployed + * DISK_SIZE=X: the size of the VM's primary virtual hard disk. `X` should + use a suffix of `K`, `M`, or `G` (in upper or lower case) to indicate + kilo-, mega-, or gigabytes. For example, `DISK_SIZE=100G` would create a + 100 gigabyte disk image. **This parameter is mandatory**. + * RAM_SIZE=X: The amount of RAM that the virtual machine should allocate for + itself from the host. `X` is interpreted in the same was as for + DISK_SIZE`, and defaults to `1G` + * VCPUS=n: the number of virtual CPUs for the VM. Allowed values 1-32. Do + not use more CPU cores than you have available physically (real cores, no + hyperthreads) + * INITRAMFS_PATH=path: the location of an initramfs for the bootloader to + tell Linux to use, rather than booting the rootfs directly. + * AUTOSTART=` - allowed values are `yes` and `no` (default). If the + value is 'yes', the VM will be started when it has been deployed -- cgit v1.2.1