README.md in foreman_bootdisk-6.0.0 vs README.md in foreman_bootdisk-6.1.0
- old
+ new
@@ -121,10 +121,18 @@
<td>Yes</td>
<td>No</td>
<td>Yes</td>
<td>No</td>
</tr>
+ <tr>
+ <td>Subnet image</td>
+ <td>Yes</td>
+ <td>Yes</td>
+ <td>No</td>
+ <td>Yes</td>
+ <td>No</td>
+ </tr>
</table>
### Per-host images
Using the host and subnet data in Foreman, per-host images can be created with
@@ -152,12 +160,13 @@
### 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.
+if the host OS, bootloader or PXELinux templates change, or build tokens are
+required and expire. The provisioning template is still fetched from the
+Foreman server.
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.
@@ -202,10 +211,37 @@
foreman-rake bootdisk:generate:generic
Set `OUTPUT=/path` to change the output destination path (directory or file).
It must be writable by the 'foreman' user.
+### Subnet images
+
+Subnet images are similar to generic images, but chain-loading is done via the
+TFTP Smart Proxy assigned to the Subnet of the host. The smart proxy must have
+the "Templates" module enabled and configured.
+
+This image is generic for all hosts with a provisioning NIC on that subnet.
+
+To generate the image from the web interface, view a host page, click the
+"Boot disk" button and select "Subnet image".
+
+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 subnet --subnet local.lan
+
+See the hammer_cli_foreman_bootdisk documentation for more advanced usage.
+
+To generate from the command line on the Foreman server:
+
+ foreman-rake bootdisk:generate:subnet NAME=subnet-name
+
+Note that foreman-rake does connect to the foreman-proxy.
+
+Set `OUTPUT=/path` to change the output destination path (directory or file).
+It must be writable by the 'foreman' user.
+
### Host group images
TODO
### USB images
@@ -241,9 +277,17 @@
* `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
+
+### RBAC
+
+This plugin provides "Boot disk access" role which requires the following
+permissions to be present to allow host and subnet image downloading:
+
+* `view_hosts`
+* `view_subnets`
# Issues
Report issues on the Redmine project: [foreman_bootdisk](http://projects.theforeman.org/projects/bootdisk/issues/new)