#!/bin/bash
#
# Builds custom BootCD ISO and USB images in the current
-# directory. For backward compatibility, if an old-style static
-# configuration is specified, that configuration file will be parsed
-# instead of the current PLC configuration in
-# /etc/planetlab/plc_config.
+# directory.
#
# Aaron Klingaman <alk@absarokasoft.com>
# Mark Huang <mlhuang@cs.princeton.edu>
CONFIGURATION=default
NODE_CONFIGURATION_FILE=
-TYPES="usb iso usb_serial iso_serial"
+DEFAULT_TYPES="usb iso"
# Leave 4 MB of free space
FREE_SPACE=4096
CUSTOM_DIR=
OUTPUT_BASE=
+GRAPHIC_CONSOLE="graphic"
+SERIAL_CONSOLE="ttyS0:115200:n:8"
+CONSOLE_INFO=$GRAPHIC_CONSOLE
MKISOFS_OPTS="-R -J -r -f -b isolinux.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table"
+ALL_TYPES=""
+for x in iso usb usb_partition; do for s in "" "_serial" ; do for c in "" "_cramfs" ; do
+ t="${x}${c}${s}"
+ case $t in
+ usb_partition_cramfs|usb_partition_cramfs_serial)
+ # unsupported
+ ;;
+ *)
+ ALL_TYPES="$ALL_TYPES $t" ;;
+ esac
+done; done; done
+
+# NOTE
+# the custom-dir feature is designed to let a myplc try/ship a patched bootcd
+# without the need for a full devel environment
+# for example, you would create /root/custom-bootcd/etc/rc.d/init.d/pl_hwinit
+# and run this script with -C /root/custom-bootcd
+# this creates a third .img image of the custom dir, that 'hides' the files from
+# bootcd.img in the resulting unionfs
+# it seems that this feature has not been used nor tested in a long time, use with care
usage()
{
echo "Usage: build.sh [OPTION]..."
- echo " -c name (Deprecated) Static configuration to use (default: $CONFIGURATION)"
- echo " -f planet.cnf Node to customize CD for (default: none)"
- echo " -t 'types' Build the specified images (default: $TYPES)"
- echo " -a Build all supported images"
+ echo " -f plnode.txt Node to customize CD for (default: none)"
+ echo " -t 'types' Build the specified images (default: $DEFAULT_TYPES)"
+ echo " -a Build all known types as listed below"
+ echo " -s console-info Enable a serial line as console and also bring up getty on that line"
+ echo " console-info: tty:baud-rate:parity:bits"
+ echo " or 'default' shortcut for $SERIAL_CONSOLE"
+ echo " Using this is recommended, rather than mentioning 'serial' in a type"
+ echo " -O output-base The prefix of the generated files (default: PLC_NAME-BootCD-VERSION)"
+ echo " useful when multiple types are provided"
+ echo " can be a full path"
+ echo " -o output-name The full name of the generated file"
echo " -C custom-dir Custom directory"
- echo " -O output-base The basename of the generated files (default: PLC_NAME-BootCD-VERSION)"
+ echo " -n Dry run - mostly for debug/test purposes"
echo " -h This message"
+ echo "All known types: $ALL_TYPES"
exit 1
}
+# init
+TYPES=""
# Get options
-while getopts "O:c:f:t:C:ah" opt ; do
+while getopts "f:t:as:O:o:C:nh" opt ; do
case $opt in
- c)
- CONFIGURATION=$OPTARG
- ;;
f)
- NODE_CONFIGURATION_FILE=$OPTARG
- ;;
+ NODE_CONFIGURATION_FILE=$OPTARG ;;
t)
- TYPES="$OPTARG"
- ;;
- C)
- CUSTOM_DIR="$OPTARG"
- ;;
- O)
- OUTPUT_BASE="$OPTARG"
- ;;
+ TYPES="$TYPES $OPTARG" ;;
a)
- TYPES="usb iso usb_serial iso_serial usb_cramfs iso_cramfs usb_cramfs_serial iso_cramfs_serial"
- ;;
+ TYPES="$ALL_TYPES" ;;
+ s)
+ CONSOLE_INFO="$OPTARG"
+ [ "$CONSOLE_INFO" == "default" ] && CONSOLE_INFO=$SERIAL_CONSOLE
+ ;;
+ O)
+ OUTPUT_BASE="$OPTARG" ;;
+ o)
+ OUTPUT_NAME="$OPTARG" ;;
+ C)
+ CUSTOM_DIR="$OPTARG" ;;
+ n)
+ DRY_RUN=true ;;
h|*)
- usage
- ;;
+ usage ;;
esac
done
+# use default if not set
+[ -z "$TYPES" ] && TYPES="$DEFAULT_TYPES"
+
# Do not tolerate errors
set -e
. /etc/planetlab/plc_config
fi
-### This support for backwards compatibility can be taken out in the
-### future. RC1 based MyPLCs set $PLC_BOOT_SSL_CRT in the plc_config
-### file, but >=RC2 based bootcd assumes that $PLC_BOOT_CA_SSL_CRT is
-### set.
-if [ -z "$PLC_BOOT_CA_SSL_CRT" -a ! -z "$PLC_BOOT_SSL_CRT" ] ; then
- PLC_BOOT_CA_SSL_CRT=$PLC_BOOT_SSL_CRT
-fi
-
-# If PLC configuration is not valid, try a static configuration
-if [ -z "$PLC_BOOT_CA_SSL_CRT" -a -d configurations/$CONFIGURATION ] ; then
- # (Deprecated) Source static configuration
- . configurations/$CONFIGURATION/configuration
- PLC_NAME="PlanetLab"
- PLC_MAIL_SUPPORT_ADDRESS="support@planet-lab.org"
- PLC_WWW_HOST="www.planet-lab.org"
- PLC_WWW_PORT=80
- if [ -n "$EXTRA_VERSION" ] ; then
- BOOTCD_VERSION="$BOOTCD_VERSION $EXTRA_VERSION"
- fi
- PLC_BOOT_HOST=$PRIMARY_SERVER
- PLC_BOOT_SSL_PORT=$PRIMARY_SERVER_PORT
- PLC_BOOT_CA_SSL_CRT=configurations/$CONFIGURATION/$PRIMARY_SERVER_CERT
- PLC_ROOT_GPG_KEY_PUB=configurations/$CONFIGURATION/$PRIMARY_SERVER_GPG
-fi
-
-FULL_VERSION_STRING="$PLC_NAME BootCD $BOOTCD_VERSION"
+FULL_VERSION_STRING="${PLC_NAME} BootCD ${BOOTCD_VERSION}"
echo "* Building images for $FULL_VERSION_STRING"
echo "/boot/" >$dir/boot_server_path
done
-# (Deprecated) Install old-style boot server configuration files
+# Install old-style boot server configuration files
+# as opposed to what a former comment suggested,
+# this is still required, somewhere in the bootmanager apparently
install -D -m 644 $PLC_BOOT_CA_SSL_CRT $overlay/usr/bootme/cacert/$PLC_BOOT_HOST/cacert.pem
echo "$FULL_VERSION_STRING" >$overlay/usr/bootme/ID
echo "$PLC_BOOT_HOST" >$overlay/usr/bootme/BOOTSERVER
# Install node configuration file (e.g., if node has no floppy disk or USB slot)
if [ -f "$NODE_CONFIGURATION_FILE" ] ; then
- echo "* Installing node configuration file"
+ echo "* Installing node configuration file $NODE_CONFIGURATION_FILE -> /usr/boot/plnode.txt of the bootcd image"
install -D -m 644 $NODE_CONFIGURATION_FILE $overlay/usr/boot/plnode.txt
fi
popd
+function extract_console_dev()
+{
+ local console="$1"
+ dev=$(echo $console| awk -F: ' {print $1}')
+ echo $dev
+}
+
+function extract_console_baud()
+{
+ local console="$1"
+ baud=$(echo $console| awk -F: ' {print $2}')
+ [ -z "$baud" ] && baud="115200"
+ echo $baud
+}
+
+function extract_console_parity()
+{
+ local console="$1"
+ parity=$(echo $console| awk -F: ' {print $3}')
+ [ -z "$parity" ] && parity="n"
+ echo $parity
+}
+
+function extract_console_bits()
+{
+ local console="$1"
+ bits=$(echo $console| awk -F: ' {print $4}')
+ [ -z "$bits" ] && bits="8"
+ echo $bits
+}
+
function build_iso()
{
- local iso="$1"
- local serial=$2
- local custom=$3
+ local iso="$1" ; shift
+ local console="$1" ; shift
+ local custom="$1"
+ local serial=
+
+ if [ "$console" != "$GRAPHIC_CONSOLE" ] ; then
+ serial=1
+ console_dev=$(extract_console_dev $console)
+ console_baud=$(extract_console_baud $console)
+ console_parity=$(extract_console_parity $console)
+ console_bits=$(extract_console_bits $console)
+ fi
# Write isolinux configuration
cat >$isofs/isolinux.cfg <<EOF
-${serial:+SERIAL 0 115200}
+${serial:+SERIAL 0 ${console_baud}}
DEFAULT kernel
-APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=ttyS0,115200n8}
+APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
DISPLAY pl_version
PROMPT 0
TIMEOUT 40
+EOF
+
+ # write kargs.txt with additional args that should be executed by kexec to production mode
+ cat >$isofs/kargs.txt <<EOF
+${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
EOF
# Create ISO image
$MKISOFS_OPTS \
$isofs
}
+
function build_usb_partition()
{
- echo -n "* Creating USB image with partitions..."
- local usb="$1"
- local serial=$2
- local custom=$3
-
- local size=$(($(du -Lsk $isofs | awk '{ print $1; }') + $FREE_SPACE))
- size=$(( $size / 1024 ))
+ echo -n "* Creating USB image with partitions..."
+ local usb="$1" ; shift
+ local console="$1" ; shift
+ local custom="$1"
+ local serial=
+
+ if [ "$console" != "$GRAPHIC_CONSOLE" ] ; then
+ serial=1
+ console_dev=$(extract_console_dev $console)
+ console_baud=$(extract_console_baud $console)
+ console_parity=$(extract_console_parity $console)
+ console_bits=$(extract_console_bits $console)
+ fi
- local heads=64
- local sectors=32
- local cylinders=$(( ($size*1024*2)/($heads*$sectors) ))
- local offset=$(( $sectors*512 ))
+ local size=$(($(du -Lsk $isofs | awk '{ print $1; }') + $FREE_SPACE))
+ size=$(( $size / 1024 ))
- /usr/lib/syslinux/mkdiskimage -M -4 "$usb" $size $heads $sectors
+ local heads=64
+ local sectors=32
+ local cylinders=$(( ($size*1024*2)/($heads*$sectors) ))
+ local offset=$(( $sectors*512 ))
- cat >${BUILDTMP}/mtools.conf<<EOF
+ /usr/lib/syslinux/mkdiskimage -M -4 "$usb" $size $heads $sectors
+
+ cat >${BUILDTMP}/mtools.conf<<EOF
drive z:
file="${usb}"
cylinders=$cylinders
offset=$offset
mformat_only
EOF
- # environment variable for mtools
- export MTOOLSRC="${BUILDTMP}/mtools.conf"
+ # environment variable for mtools
+ export MTOOLSRC="${BUILDTMP}/mtools.conf"
- ### COPIED FROM build_usb() below!!!!
+ ### COPIED FROM build_usb() below!!!!
echo -n " populating USB image... "
mcopy -bsQ -i "$usb" "$isofs"/* z:/
# Use syslinux instead of isolinux to make the image bootable
tmp="${BUILDTMP}/syslinux.cfg"
cat >$tmp <<EOF
-${serial:+SERIAL 0 115200}
+${serial:+SERIAL 0 ${console_baud}}
DEFAULT kernel
-APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=ttyS0,115200n8}
+APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
DISPLAY pl_version
PROMPT 0
TIMEOUT 40
mcopy -i "$usb" "$tmp" z:/syslinux.cfg
rm -f "$tmp"
rm -f "${BUILDTMP}/mtools.conf"
- unset MTOOLSRC
+ unset MTOOLSRC
echo "making USB image bootable."
syslinux -o $offset "$usb"
function build_usb()
{
echo -n "* Creating USB image... "
- local usb="$1"
- local serial=$2
- local custom=$3
+ local usb="$1" ; shift
+ local console="$1" ; shift
+ local custom="$1"
+ local serial=
+
+ if [ "$console" != "$GRAPHIC_CONSOLE" ] ; then
+ serial=1
+ console_dev=$(extract_console_dev $console)
+ console_baud=$(extract_console_baud $console)
+ console_parity=$(extract_console_parity $console)
+ console_bits=$(extract_console_bits $console)
+ fi
mkfs.vfat -C "$usb" $(($(du -Lsk $isofs | awk '{ print $1; }') + $FREE_SPACE))
+ # write kargs.txt with additional args that should be executed by kexec to production mode
+ tmp="${BUILDTMP}/kargs.txt"
+ cat >$tmp <<EOF
+${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
+EOF
+ mcopy -i "$usb" "$tmp" ::/kargs.txt
+ rm -f "$tmp"
+
# Populate it
echo -n " populating USB image... "
mcopy -bsQ -i "$usb" "$isofs"/* ::/
# Use syslinux instead of isolinux to make the image bootable
tmp="${BUILDTMP}/syslinux.cfg"
cat >$tmp <<EOF
-${serial:+SERIAL 0 115200}
+${serial:+SERIAL 0 $console_baud}
DEFAULT kernel
-APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=ttyS0,115200n8}
+APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
DISPLAY pl_version
PROMPT 0
TIMEOUT 40
function prepare_cramfs()
{
[ -n "$CRAMFS_PREPARED" ] && return 0
- local custom=$1
+ local console=$1; shift
+ local custom=$1;
+ local serial=
+ if [ "$console" != "$GRAPHIC_CONSOLE" ] ; then
+ serial=1
+ console_dev=$(extract_console_dev $console)
+ console_baud=$(extract_console_baud $console)
+ fi
echo "* Setting up CRAMFS-based images"
local tmp="${BUILDTMP}/cramfs-tree"
sed -i 's,pl_sysinit,pl_rsysinit,' etc/inittab
# modify inittab to have a serial console
- echo "T0:23:respawn:/sbin/agetty -L ttyS0 9600 vt100" >> etc/inittab
- # and let root log in
- echo "ttyS0" >> etc/securetty
+ if [ -n "$serial" ] ; then
+ echo "T0:23:respawn:/sbin/agetty -L $console_dev $console_baud vt100" >> etc/inittab
+ # and let root log in
+ echo "$console_dev" >> etc/securetty
+ fi
# calculate the size of /tmp based on the size of /etc & /var + 8MB slack
etcsize=$(du -s ./etc | awk '{ print $1 }')
varsize=$(du -s ./var | awk '{ print $1 }')
let msize=($varsize+$etcsize+8192)/1024
+ # make dhclient happy
+ for i in $(seq 0 9); do ln -fs /tmp/etc/dhclient-eth${i}.conf etc/dhclient-eth${i}.conf ; done
+ ln -fs /tmp/etc/resolv.conf etc/resolv.conf
+ ln -fs /tmp/etc/resolv.conf.predhclient etc/resolv.conf.predhclient
# generate pl_rsysinit
cat > etc/rc.d/init.d/pl_rsysinit <<EOF
popd
echo "done"
+
# hand over to pl_sysinit
echo "pl_rsysinit: handing over to pl_sysinit"
/etc/init.d/pl_sysinit
# Create ISO CRAMFS image
function build_iso_cramfs()
{
- local iso="$1"
- local serial=$2
- prepare_cramfs $3
+ local iso="$1" ; shift
+ local console="$1" ; shift
+ local custom="$1"
+ local serial=
+
+ if [ "$console" != "$GRAPHIC_CONSOLE" ] ; then
+ serial=1
+ console_dev=$(extract_console_dev $console)
+ console_baud=$(extract_console_baud $console)
+ console_parity=$(extract_console_parity $console)
+ console_bits=$(extract_console_bits $console)
+ fi
+ prepare_cramfs "$console" "$custom"
echo "* Creating ISO CRAMFS-based image"
local tmp="${BUILDTMP}/cramfs-iso"
push_cleanup rm -rf $tmp
(cd $isofs && find . | grep -v "\.img$" | cpio -p -d -u $tmp/)
cat >$tmp/isolinux.cfg <<EOF
-${serial:+SERIAL 0 9600}
+${serial:+SERIAL 0 $console_baud}
DEFAULT kernel
-APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro ${serial:+console=ttyS0,9600n8}
+APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro ${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
DISPLAY pl_version
PROMPT 0
TIMEOUT 40
+EOF
+
+ # write kargs.txt with additional args that should be executed by kexec to production mode
+ cat >$tmp/kargs.txt <<EOF
+${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
EOF
cp ${BUILDTMP}/cramfs.img $tmp
# Create USB CRAMFS based image
function build_usb_cramfs()
{
- local usb="$1"
- local serial=$2
- prepare_cramfs $3
+ local usb="$1" ; shift
+ local console="$1" ; shift
+ local custom="$1"
+ local serial=
+
+ if [ "$console" != "$GRAPHIC_CONSOLE" ] ; then
+ serial=1
+ console_dev=$(extract_console_dev $console)
+ console_baud=$(extract_console_baud $console)
+ console_parity=$(extract_console_parity $console)
+ console_bits=$(extract_console_bits $console)
+ fi
+ prepare_cramfs "$console" "$custom"
echo "* Creating USB CRAMFS based image"
let vfat_size=${cramfs_size}+$FREE_SPACE
# Make VFAT filesystem for USB
mkfs.vfat -C "$usb" $vfat_size
+ # write kargs.txt with additional args that should be executed by kexec to production mode
+ tmp="${BUILDTMP}/kargs.txt"
+ cat >$tmp <<EOF
+${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
+EOF
+ mcopy -i "$usb" "$tmp" ::/kargs.txt
+ rm -f "$tmp"
+
# Populate it
echo "* Populating USB with overlay images and cramfs"
mcopy -bsQ -i "$usb" $isofs/kernel $isofs/pl_version ::/
# Use syslinux instead of isolinux to make the image bootable
tmp="${BUILDTMP}/syslinux.cfg"
cat >$tmp <<EOF
-${serial:+SERIAL 0 9600}
+${serial:+SERIAL 0 $console_baud}
DEFAULT kernel
-APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro ${serial:+console=ttyS0,9600n8}
+APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro ${serial:+console=${console_dev},${console_baud}${console_parity}${console_bits}}
DISPLAY pl_version
PROMPT 0
TIMEOUT 40
EOF
+
mcopy -bsQ -i "$usb" "$tmp" ::/syslinux.cfg
rm -f "$tmp"
echo $1 | sed '
s/usb$/.usb/;
s/usb_partition$/-partition.usb/;
- s/usb_serial$/-serial.usb/;
s/iso$/.iso/;
- s/iso_serial$/-serial.iso/;
s/usb_cramfs$/-cramfs.usb/;
- s/usb_cramfs_serial$/-cramfs-serial.usb/;
s/iso_cramfs$/-cramfs.iso/;
- s/iso_cramfs_serial$/-cramfs-serial.iso/;
'
}
[ -z "$OUTPUT_BASE" ] && OUTPUT_BASE="$PLC_NAME-BootCD-$BOOTCD_VERSION"
for t in $TYPES; do
- serial=
+ arg=$t
+ console=$CONSOLE_INFO
+
+ # figure if this is a serial image (can be specified in the type or with -s)
+ if [[ "$t" == *serial* || "$console" != "$GRAPHIC_CONSOLE" ]]; then
+ # remove serial from type
+ t=`echo $t | sed 's/_serial//'`
+ # check console
+ [ "$console" == "$GRAPHIC_CONSOLE" ] && console="$SERIAL_CONSOLE"
+ # compute filename part
+ if [ "$console" == "$SERIAL_CONSOLE" ] ; then
+ serial="-serial"
+ else
+ serial="-serial-$(echo $console | sed -e 's,:,,g')"
+ fi
+ else
+ serial=""
+ fi
+
tname=`type_to_name $t`
- if [[ "$t" == *_serial ]]; then
- serial=1
- t=`echo $t | sed 's/_serial$//'`
+ # if -o is specified (as it has no default)
+ if [ -n "$OUTPUT_NAME" ] ; then
+ output=$OUTPUT_NAME
+ else
+ output="${OUTPUT_BASE}${serial}${tname}"
+ fi
+
+ echo "*** Dealing with type=$arg"
+ echo '*' build_$t "$output" "$console" "$CUSTOM_DIR"
+ if [ ! -n "$DRY_RUN" ] ; then
+ build_$t "$output" "$console" "$CUSTOM_DIR"
fi
- build_$t "${OUTPUT_BASE}${tname}" $serial $CUSTOM_DIR
done
exit 0
git://git.onelab.eu / bootcd.git / blobdiff