README.md in foreman_bootdisk-1.1.0 vs README.md in foreman_bootdisk-1.2.0
- old
+ new
@@ -37,10 +37,11 @@
Some configuration is set under More>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_host_template` is the name of the per-host boot disk template
+* `bootdisk_generic_host_template` is the name of the generic boot disk template
For per-host images, ensure host IP addresses and subnets are populated, and
the subnet's gateway, subnet mask and DNS resolver(s) are correctly configured
under More>Provisioning>Subnets in Foreman.
@@ -59,36 +60,86 @@
static IP details required to configure the OS. For a kickstart file, the
following configuration will do this:
network --bootproto <%= @static ? "static" : "dhcp" %> --hostname <%= @host %> <%= "--ip=#{@host.ip} --netmask=#{@host.subnet.mask} --gateway=#{@host.subnet.gateway} --nameserver=#{@host.subnet.dns_primary},#{@host.subnet.dns_secondary}" if @static %>
-## USB images
+## Available images
-The ISO images generated are run through `isohybrid` which makes them bootable
-as disks too, suitable for copying to a USB device.
+The image types have trade-offs, but are all meant for environments without
+total control over the network infrastructure - so no DHCP reservations or
+TFTP settings are needed.
-Use `dd if=fqdn.iso of=/dev/sdb` or similar to copy the image to a USB disk.
-Ensure the device name is correct to avoid writing over the wrong disk.
+<table>
+ <tr>
+ <th>Type</th>
+ <th>Generic</th>
+ <th>DHCP required</th>
+ <th>DHCP reservation</th>
+ <th>Pre-register host</th>
+ </tr>
+ <tr>
+ <td>Per-host image</td>
+ <td>No</td>
+ <td>No</td>
+ <td>No</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>Generic image</td>
+ <td>Yes</td>
+ <td>Yes</td>
+ <td>No</td>
+ <td>Yes</td>
+ </tr>
+</table>
-## Per-host images
+### Per-host images
Using the host and subnet data in Foreman, per-host images can be created with
fully static networking. The behaviour is dynamic, as the image chainloads
from Foreman, so the current OS and build state will be provided by Foreman
instead of being stored in the image.
-To generate the image from the web interface, view the host page and click the
-"Boot disk" button.
+To generate the image from the web interface, view the host page, click the
+"Boot disk" button and select "Host 'FQDN' image".
To generate from the command line:
foreman-rake bootdisk:generate:host NAME=foo.example.com
Optionally set `OUTPUT=/path/foo.iso` to change the output destination.
-## Generic host group images
+### Generic image
+This provides a single ISO that can be used by all 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 matching a
+MAC address or the IP the host was assigned by DHCP.
+
+The installation can continue on either the DHCP or static IP depending on how
+the OS gPXE template is configured, and could configure the assigned IP
+address statically for the installed system via the kickstart file.
+
+To generate the image from the web interface, view a host page, click the
+"Boot disk" button and select "Generic image".
+
+To generate from the command line:
+
+ foreman-rake bootdisk:generate:generic
+
+Optionally set `OUTPUT=/path/foo.iso` to change the output destination.
+
+### Host group images
+
TODO
+
+### USB images
+
+The ISO images generated are run through `isohybrid` which makes them bootable
+as disks too, suitable for copying to a USB device.
+
+Use `dd if=fqdn.iso of=/dev/sdb` or similar to copy the image to a USB disk.
+Ensure the device name is correct to avoid writing over the wrong disk.
# Issues
Report issues on the Redmine project: [foreman_bootdisk](http://projects.theforeman.org/projects/bootdisk/issues/new)