README.md in foreman_bootdisk-3.1.2 vs README.md in foreman_bootdisk-3.2.0

- old
+ new

@@ -92,24 +92,35 @@ <th>Type</th> <th>Generic</th> <th>DHCP required</th> <th>DHCP reservation</th> <th>Pre-register host</th> + <th>OS-specific</th> </tr> <tr> <td>Per-host image</td> <td>No</td> <td>No</td> <td>No</td> <td>Yes</td> + <td>No</td> </tr> <tr> + <td>Full host image</td> + <td>No</td> + <td>No</td> + <td>No</td> + <td>Yes</td> + <td>Yes</td> + </tr> + <tr> <td>Generic image</td> <td>Yes</td> <td>Yes</td> <td>No</td> <td>Yes</td> + <td>No</td> </tr> </table> ### Per-host images @@ -132,10 +143,36 @@ hammer bootdisk host --host client.example.com See the hammer_cli_foreman_bootdisk documentation for more advanced usage. +### Per-host full images + +A variant of the per-host image, this version doesn't chainload from Foreman, +but contains the initial OS bootloader. It can be useful for hosts that fail +to chainload correctly, but has the downsides that it may become out of date +if the host OS, bootloader or templates change, or build tokens are required +and expire. + +To generate the image from the web interface, view the host page, click the +"Boot disk" button and select "Full host 'FQDN' image". This image may take +a while to generate, as it downloads the OS bootloaders which can be +considerable in size. + +To generate from the command line on the Foreman server: + + foreman-rake bootdisk:generate:full_host NAME=foo.example.com + +Optionally set `OUTPUT=/path/foo.iso` to change the output destination. + +To generate using the Hammer CLI, install the [hammer_cli_foreman_bootdisk](https://github.com/theforeman/hammer_cli_foreman_bootdisk) +plugin and run: + + hammer bootdisk host --host client.example.com --full true + +See the hammer_cli_foreman_bootdisk documentation for more advanced usage. + ### Generic image This provides a single ISO that can be used by all registered hosts, but since IP details can't be stored inside, it requires a DHCP pool on the network to bootstrap. It will boot and contact Foreman for template of a registered host @@ -185,17 +222,22 @@ * `bootdisk_generic_host_template` is the name of the generic boot disk template These templates are baked into the downloaded ISO files and generally don't need to be modified. +Full host images boot directly into the OS PXELinux template via ISOLinux, +with no intermediate template or bootloader. + ### Settings Some more advanced settings are available under Administer>Settings>Bootdisk in the Foreman UI. * `bootdisk_ipxe_dir` points to the directory containing ipxe.lkrn * `bootdisk_syslinux_dir` points to the directory containing syslinux images * `bootdisk_mkiso_command` is the name of genisoimage/mkisofs on your OS +* `bootdisk_cache_media` controls whether to cache OS boot files from + installation media for full host images # Issues Report issues on the Redmine project: [foreman_bootdisk](http://projects.theforeman.org/projects/bootdisk/issues/new)