diskimage-builder/elements/baremetal/README.rst

.. _element-baremetal:

=========
baremetal
=========

This is the baremetal (IE: real hardware) element.

Does the following:

 * extracts the kernel and initial ramdisk of the built image.

Optional parameters:

 * DIB_BAREMETAL_KERNEL_PATTERN and DIB_BAREMETAL_INITRD_PATTERN
   may be supplied to specify which kernel files are preferred; this
   can be of use when using custom kernels that don't fit the
   standard naming patterns. Both variables must be provided in
   order for them to have any effect.
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d 2015-04-27 14:50:37 +00:00			`.. _element-baremetal:`

Create docs site containing element READMEs We currently do not have the ability to create a docs site which outlines all the elements. Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b 2015-02-07 10:30:02 +00:00			`=========`
			`baremetal`
			`=========`

Create a new baremetal element Rather than using a script to mount the image using nbd to extract the kernel and ramdisk, make a new element called baremetal, which contains a cleanup.d script that will copy them out to <image name>.{vmlinuz,initrd}. Closes-Bug: 1224669 Change-Id: I8f3569aa12148d18b1c8242b6fbbd8857894b26f 2014-01-20 12:00:21 +00:00			`This is the baremetal (IE: real hardware) element.`

baremetal element: Enable stable interface names By default most cloud images have disabled the udev rules which give us stable network interface names. While this is a reasonable default for something like EC2 (the target for these images) this is very bad behavour on bare metal and can cause a "musical NICs" situation to occur where on reboot the NIC names get swapped. In this commit we re-enable stable interface naming by removing the dev nulled rules softlink and installing the biosdevname package. Once this is done interface names should again show up as em1, em2 instead of the old eth0, eth1. We also remove some the common, statically configured eth0 config files on some distributions. Equivalent files (if needed) may be auto-generated by using the dhcp-all-interfaces element. Change-Id: Idd67977342719e2f295e2fa2c0ed6cfa8602171a 2014-02-07 21:18:28 +00:00			`Does the following:`

			`* extracts the kernel and initial ramdisk of the built image.`
Parameterise PXE kernel and initrd selection When using custom-built kernels, their filenames may not necessarily follow the standard naming conventions for the stock systems in question. This patch permits the specification of an alternative pattern to use when looking for the correct kernel to construct the PXE images from. Example: export DIB_BAREMETAL_KERNEL_PATTERN="kerneljang" export DIB_BAREMETAL_INITRD_PATTERN="initrdjang" Change-Id: I86e5254051addd5e89dd4e363e9bba117e65353d 2014-03-19 14:17:58 +00:00
			`Optional parameters:`

			`* DIB_BAREMETAL_KERNEL_PATTERN and DIB_BAREMETAL_INITRD_PATTERN`
			`may be supplied to specify which kernel files are preferred; this`
			`can be of use when using custom kernels that don't fit the`
			`standard naming patterns. Both variables must be provided in`
			`order for them to have any effect.`