Convert FreeBSD ISO image for PXE bootstrap

Posted by: admin  :  Category: FreeBSD

Usually ISO’s of most Linux distros use isolinux as boot loader, so these may be served up easily for pxe bootstrap through pxelinux/memdisk.

For FreeBSD this does not hold true, so the vanilla ISO’s must be converted before they can be bootstrapped.

The basic idea is to convert the FreeBSD ISO into a harddisk image to circumvent a limitation in the ISO boot loader.

#1 Preparation

We need some staging directory where we can safely play around with the files.

#mkdir /tmp/build
#mkdir /tmp/build/iso.mnt
#mkdir /tmp/build/hd.mnt
#mkdir /tmp/build/mfs.mnt

#2 Get the ISO image

I usually use the ‘bootonly’ image because of it’s size (~25 MB). It would work with the full ISO’s of course, however will not only take longer to download via tftp but also require more memory on the client host.

#wget ftp://ftp.freebsd.org/pub/FreeBSD/ISO-IMAGES-i386/6.2/6.2-RELEASE-i386-bootonly.iso –output-document=/tmp/build/6.2-RELEASE-i386-bootonly.iso

Now we need to attach ‘md’ (memory device) to the ISO image and mount it.

#mdconfig -a -t vnode -f /tmp/build/6.2-RELEASE-i386-bootonly.iso
md0
#mount_cd9660 /dev/md0 /tmp/build/iso.mnt/

#3 Create a new harddisk image

Let’s create a new harddisk image of 32 MB in size. It make it a bit bigger than the original ISO so I could include further scripts with it.

#dd if=/dev/zero of=/tmp/build/6.2-RELEASE-i386-bootonly.hd bs=1m count=32
32+0 records in
32+0 records out
33554432 bytes transferred in 2.078232 secs (16145664 bytes/sec)

Then we attach a ‘md’ device to this one, too. Afterwards partition table and bsdlabel are initialized.

#mdconfig -a -t vnode -f /tmp/build/6.2-RELEASE-i386-bootonly.hd
md1
#fdisk -B -I /dev/md1
#bsdlabel -B -w /dev/md1

Now we would need to edit the bsdlabel to add the ‘a’ slice of type 4.2BSD covering the whole harddisk image.

#bsdlabel -e /dev/md1
# /dev/md1:
8 partitions:
# size offset fstype [fsize bsize bps/cpg]
a: 65520 16 4.2BSD
c: 65536 0 unused 0 0 # “raw” part, don’t edit

Finally, the slaved will be newfs’ed with UFS and mounted.
#newfs /dev/md1a
#mount /dev/md1a /tmp/build/hd.mnt

Now the ‘boot’ directory must be copied from the mounted ISO image onto the harddisk image.

#copy -r /tmp/build/iso.mnt/boot /tmp/build/hd.mnt/boot

#4 Optional: Prepare SysInstall for automatic installations

This step is completely optional, though will allow us to place an ‘install.cfg’ file to the image. SysInstall will use this file as configuration template for automatic installations. A sample of it is found within the source tree at /usr/src/usr.sbin/sysinstall/install.cfg. Optionally you can use mine as a starting point.

First we need to copy away mfsroot.gz into our build directory. It will then be extracted, attached to a vnode and mounted.

#cp /tmp/build/hd.mnt/boot/mfsroot.gz /tmp/build/hd.mnt
#gunzip /tmp/build/hd.mnt/mfsroot.gz
#mdconfig -a -t vnode -f /tmp/build/hd.mnt/mfsroot
md2
#mount /dev/md2 /tmp/build/mfs.mnt

Then add the install.cfg file to the mfsroot top level directory.

#cp /tmp/build/install.cfg /tmp/build/mfs.mnt

You are free to add further customizations, like self-built packages, to the mfsroot.
When finished unmount the mfsroot device, detach it from the ‘md’ device, compress and copy it back to the harddisk image.

#umount /tmp/build/mfs.mnt
#mdconfig -d -u 2
#gzip /tmp/build/mfsroot
#cp /tmp/build/mfsroot.gz /tmp/build/hd.mnt/boot

#5 Finalize

So let’s clean up little.

#umount /tmp/build/hd.mnt
#mdconfig -d -u 1
#umount /tmp/build/iso.mnt
#mdconfig -d -u 0

Let’s shift the harddisk image to the tftpd boot image directory, which is /var/tftpd/images for me.

#cp /tmp/build/6.2-RELEASE-i386-bootonly.hd /var/tftpd/images

Finally pxelinux must be instructed on how to boot this image.
The assistance of memdisk is required to achieve this by adding the lines below to pxelinux.cfg/default configuration file.

label fbsd62
kernel memdisk
append initrd=/images/6.2-RELEASE-i386-bootonly.hd harddisk

So from now on requesting ‘fbsd62’ at the pxelinux boot prompt should boot the image.

It happend to me occasionally that the FreeBSD boot loader crashed on some systems. So far this seems depending on the BIOS, because upgrading to the latest releases fixed it usually. I suspect that some BIOS versions mess up if a PXE bootstrapped image reports itself as beeing a harddisk.

It did not yet find a solution to this particular issue except using old-fashioned 1.44/2.88m floppy disk images for PXE bootstrap.

#6 Boot Environment and Configuration Files

This howto actually covers a topic which came up during development of a network installation environment.

The host acting as boot server is running FreeBSD with ISC dhpcd, stock tftpd and pxelinux serving as bootstrap loader.

I’m providing you with some basic configuration files to round up the picture.

My live-setup is in fact a bit more sophisticated than that and uses some additional scripting magic do achieve real automated setups not only for FreeBSD but also for various Linux distros. This however I am not allowed to publish in detail due to company policy.

dhcpd.conf

inetd.conf

pxelinux.cfg

install.cfg

11 Responses to “Convert FreeBSD ISO image for PXE bootstrap”

  1. Sascha Says:

    Hello!

    This is a pretty neat guide! I have only one question. For Linux installations I am fetching the config files from an http server. Assuming that wget is already present in mfsroot, where would I put my “wget http://…” line into? Under /etc is no startup script or anything. Any help would be appreciated.

    Thanks

  2. Gianpaolo Del Matto Says:

    FreeBSD’s stock setup disks are missing /etc (/etc/rc* in particular) because it’s simply not required for the setup.
    sysinstall assumes control in favor to init and does the appropriate tasks, nothing more, nothing less.

    It can therefore not be compared with a full-fledged system because it basically lacks everything else.

    This also means that if you want to do some scripted actions you will have to create your own boot disk with full-fledged /etc/ and /sbin/init or rely on sysinstall’s builtin exec functions otherwise.

    The latter one is not so sophisicated as sysinstall can only execute commands without arguments.
    They also run completely detached from the terminal so they may be completely non-interactive only.

    If you’re going the sysinstall way, an appropriate command in ‘install.cfg’ would be:

    command=’/path/to/scriptname.sh’
    system

    All commands placed on a stock mfs-root should preferrably be statically linked to avoid issues with missing libraries. Some of them may still not work if they fail to allocate a virtual terminal.

    As a sidenote: FreeBSD selects init from the kern.init_path sysctl, which defaults to “/sbin/init:/sbin/oinit:/sbin/init.bak:/stand/sysinstall”.

  3. free image host Says:

    Thanks a lot for this article

  4. chrisb Says:

    Nice article. I’m learning a lot.

  5. valiy Says:

    #!/bin/sh
    mkdir build
    mkdir build/iso.mnt
    mkdir build/hd.mnt
    mkdir build/mfs.mnt
    MD_ISO=`mdconfig -a -t vnode -f $1`
    mount_cd9660 /dev/${MD_ISO} build/iso.mnt
    IMG_SIZE=`ls -l $1 | awk ‘{print $5}’`
    dd if=/dev/zero of=$2 bs=`expr ${IMG_SIZE} + 36354048` count=1
    #dd if=/dev/zero of=$2 bs=${IMG_SIZE} count=1
    MD_IMG=`mdconfig -a -t vnode -f $2`
    fdisk -B -b build/iso.mnt/boot/mbr -I /dev/${MD_IMG}
    bsdlabel -B -b build/iso.mnt/boot/boot -w /dev/${MD_IMG}
    newfs -O1 -m 0 /dev/${MD_IMG}a
    mount /dev/${MD_IMG}a build/hd.mnt
    cp -r build/iso.mnt/* build/hd.mnt/
    cp -r build/iso.mnt/boot/kernel/* build/hd.mnt/boot/modules/
    umount build/hd.mnt
    mdconfig -d -u ${MD_IMG}
    umount build/iso.mnt
    mdconfig -d -u ${MD_ISO}
    rm -rf build

  6. Richard Says:

    Is there a way possible to automate this process?
    I want to make an auto installer with custom install.cfg each time.

  7. Flupp Says:

    The combination of the boot loader from FreeBSD 7.1 and memdisk out of Syslinux 3.63 crashes during the load of the ACPI module: “loading required module pci ‘apcpi’ autoload failed – no such file or directory”.

    The option “raw” to memdisk helped:

    LABEL fbsd71
    KERNEL memdisk
    APPEND initrd=fbsd71.hd harddisk raw

    HTH and thanks for this great Howto!

    Beat

  8. lop Says:

    when creating the .hd image, after attaching the .hd image to /dev/md1, and trying to fdisk -B -I /dev/md1, i get:

    *****Working on /dev/md1*****
    fdisk: Class not found

    this is on freebsd 8 release i386, using the freebsd 8 release i386 bootonly ISO.

    what is wrong ?

  9. Ilya Evseev Says:

    FreeBSD 8.1.
    Boot loader starts ok, but everything dies after selecting any item.
    Only “|” is displayed.
    “raw” keyword does not help.

  10. Gianpaolo Del Matto Says:

    well, didn’t have time to check this on fbsd 8.1 until now, maybe I get some time eventually.

  11. Dennis Dulay Says:

    This is a great guide!!! I can now add freebsd on our linux pxe server yuhoooo!!!

    thanks again!!!