X-Git-Url: http://git.onelab.eu/?p=bootcd.git;a=blobdiff_plain;f=build.sh;h=a051700d2be0d8790ede14d557ca0dabf3a202ae;hp=bff2262edfcd0ac6103639486bcee1b67ad7b569;hb=HEAD;hpb=38d28a2ffec0d8715e69c76d7e71e0736a0c3ce6 diff --git a/build.sh b/build.sh index bff2262..a051700 100755 --- a/build.sh +++ b/build.sh @@ -1,163 +1,325 @@ #!/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 # Mark Huang -# Copyright (C) 2004-2006 The Trustees of Princeton University -# -# $Id: build.sh,v 1.40 2006/07/25 23:51:39 mlhuang Exp $ +# Copyright (C) 2004-2007 The Trustees of Princeton University # +# Jan 2015 - f21 comes with isolinux 6.03 (was 4.05 in f20) +# http://www.syslinux.org/wiki/index.php/ISOLINUX +COMMAND=$(basename $0) +DIRNAME=$(dirname $0) PATH=/sbin:/bin:/usr/sbin:/usr/bin -CONFIGURATION=default +# debugging flags +# keep KERNEL_DEBUG_ARGS void for production +KERNEL_DEBUG_ARGS="" +# add more flags here for debugging +# KERNEL_DEBUG_ARGS="$KERNEL_DEBUG_ARGS some_other_kernel_arg" +# see also +# (*) GetBootMedium that has some provisions for common +# kargs, like e.g. for removing the hangcheck feature, +# or for turning on debug messages for systemd +# these can be turned on with tags on the node +# (*) tests default config, that uses this feature so +# the tests can benefit these features, without deploying +# them by default in production + +# defaults +DEFAULT_TYPES="usb iso" +# Leave 4 MB of free space +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" +# isolinux-debug.bin is supposedly helpful as well if available, +# when things don't work as expected +#MKISOFS_OPTS="-R -J -r -f -b isolinux-debug.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table" + +FREE_SPACE=4096 + +# command-line settable args NODE_CONFIGURATION_FILE= -ALL=0 - -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 " -a Build all images (default: only base images)" - echo " -h This message" +CUSTOM_DIR= +OUTPUT_BASE= +DRY_RUN="" +OUTPUT_NAME="" +TYPES="" +KERNEL_ARGS="" + +# various globals +BUILDTMP="" +FULL_VERSION_STRING="" +ISOREF="" +ISOFS="" +OVERLAY="" +IS_SERIAL="" +console_dev="" +console_baud="" +console_spec="" +console_serial_line="" + + +#################### compute all supported types +# removing support for serial in the type +# this is because kargs.txt goes in the overlay, that is computed only once +# so we cannot handle serial and graphic modes within the same invokation of this script + +ALL_TYPES="" +for x in iso usb usb_partition; do for c in "" "_cramfs" ; do + t="${x}${c}" + case $t in + usb_partition_cramfs) + # unsupported + ;; + *) + ALL_TYPES="$ALL_TYPES $t" ;; + esac +done; done + +#################### cleanup utilities +declare -a _CLEANUPS=() +function do_cleanup() { + cd / ; for i in "${_CLEANUPS[@]}"; do $i ; done +} +function push_cleanup() { + _CLEANUPS=( "${_CLEANUPS[@]}" "$*" ) +} +function pop_cleanup() { + unset _CLEANUPS[$((${#_CLEANUPS[@]} - 1))] +} + +#################### initialization +function init_and_check () { + + # Change to our source directory + local srcdir=$(cd $DIRNAME && pwd -P) + pushd $srcdir + + # Root of the isofs + ISOREF=$PWD/${VARIANT} + + # The reference image is expected to have been built by prep.sh (see .spec) + # we disable the initial logic that called prep.sh if that was not the case + # this is because prep.sh needs to know pldistro + if [ ! -f $ISOREF/isofs/bootcd.img -o ! -f $ISOREF/version.txt ] ; then + echo "Could not find isofs and version.txt in $ISOREF" + if [ "$VARIANT" == "build" ] ; then + echo "You have to run prep.sh prior to calling $COMMAND" + else + echo "You need to create your variant image, see kvariant.sh" + fi + echo "Exiting .." + exit 1 + fi + + # build/version.txt written by prep.sh + BOOTCD_VERSION=$(cat ${VARIANT}/version.txt) + + if [ -f /etc/planetlab/plc_config ] ; then + # Source PLC configuration + . /etc/planetlab/plc_config + fi + + # use /var/tmp that should be large enough on both chroot- or vserver-based myplc + BUILDTMP=/var/tmp + + FULL_VERSION_STRING="${PLC_NAME} BootCD ${BOOTCD_VERSION}" + +} + +# 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: $COMMAND [OPTION]..." + echo " -f plnode.txt Node to customize CD for (default: none)" + echo " -t 'types' Build the specified images (default: $DEFAULT_TYPES)" + echo " NOTE: mentioning 'serial' as part of the type is not supported anymore" + 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 " -S equivalent to -s default" + 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 " -V variant Use a variant - see kvariant.sh" + echo " -n Dry run - mostly for debug/test purposes" + echo " -k Add additional parameters to the kargs.txt file" + echo " -h This message" + echo "All known types: $ALL_TYPES" exit 1 } -# Get options -while getopts "c:f:ah" opt ; do - case $opt in - c) - CONFIGURATION=$OPTARG - ;; - f) - NODE_CONFIGURATION_FILE=$OPTARG - ;; - a) - ALL=1 - ;; - h|*) - usage - ;; - esac -done - -# Do not tolerate errors -set -e - -# Change to our source directory -srcdir=$(cd $(dirname $0) && pwd -P) -pushd $srcdir - -# Root of the isofs -isofs=$PWD/build/isofs - -# Build reference image if it does not exist. This should only need to -# be executed once at build time, never at run time. -if [ ! -f $isofs/bootcd.img ] ; then - ./prep.sh -fi - -# build/version.txt written by prep.sh -BOOTCD_VERSION=$(cat build/version.txt) - -if [ -f /etc/planetlab/plc_config ] ; then - # Source PLC configuration - . /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" +#################### +function parse_command_line () { + + # init + TYPES="" + # Get options + while getopts "f:t:as:SO:o:C:V:k:nh" opt ; do + case $opt in + f) NODE_CONFIGURATION_FILE=$OPTARG ;; + t) TYPES="$TYPES $OPTARG" ;; + a) TYPES="$ALL_TYPES" ;; + s) CONSOLE_INFO="$OPTARG" ;; + S) CONSOLE_INFO=$SERIAL_CONSOLE ;; + O) OUTPUT_BASE="$OPTARG" ;; + o) OUTPUT_NAME="$OPTARG" ;; + C) CUSTOM_DIR="$OPTARG" ;; + V) VARIANT="$OPTARG" ;; + k) KERNEL_ARGS="$KERNEL_ARGS $OPTARG" ;; + n) DRY_RUN=true ;; + h|*) usage ;; + esac + done + + # use defaults if not set + [ -z "$TYPES" ] && TYPES="$DEFAULT_TYPES" + [ -z "$VARIANT" ] && VARIANT="build" + [ "$CONSOLE_INFO" == "default" ] && CONSOLE_INFO=$SERIAL_CONSOLE + + if [ -n "$NODE_CONFIGURATION_FILE" ] ; then + # check existence of NODE_CONFIGURATION_FILE and normalize as we will change directory + if [ ! -f "$NODE_CONFIGURATION_FILE" ] ; then + echo "Node configuration file $NODE_CONFIGURATION_FILE not found - exiting" + exit 1 + fi + cf_dir="$(dirname $NODE_CONFIGURATION_FILE)" + cf_dir="$(cd $cf_dir; pwd -P)" + cf_file="$(basename $NODE_CONFIGURATION_FILE)" + NODE_CONFIGURATION_FILE="$cf_dir"/"$cf_file" + fi + + # check TYPES + local matcher="XXX$(echo $ALL_TYPES | sed -e 's,\W,XXX,g')XXX" + for t in $TYPES; do + echo Checking type $t + echo $matcher | grep XXX${t}XXX &> /dev/null + if [ "$?" != 0 ] ; then + echo Unknown type $t + usage + fi + done + +} + +#################### +function init_serial () { + local console=$1; shift + if [ "$console" == "$GRAPHIC_CONSOLE" ] ; then + IS_SERIAL= + console_spec="" + echo "Standard, graphic, non-serial mode" + else + IS_SERIAL=true + console_dev=$(echo "$console" | awk -F: ' {print $1}') + console_baud=$(echo "$console" | awk -F: ' {print $2}') + [ -z "$console_baud" ] && console_baud="115200" + local console_parity=$(echo "$console" | awk -F: ' {print $3}') + [ -z "$console_parity" ] && console_parity="n" + local console_bits=$(echo "$console" | awk -F: ' {print $4}') + [ -z "$console_bits" ] && console_bits="8" + console_spec="console=${console_dev},${console_baud}${console_parity}${console_bits}" + local tty_nb=$(echo $console_dev | sed -e 's,[a-zA-Z],,g') + console_serial_line="SERIAL ${tty_nb} ${console_baud}" + echo "Serial mode" + echo "console_serial_line=${console_serial_line}" + echo "console_spec=${console_spec}" 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" - -echo "* Building images for $FULL_VERSION_STRING" - -# From within a myplc chroot /tmp is too small to build -# all possible images, whereas /data is part of the host -# filesystem and usually has sufficient space. What we -# should do is check whether the expected amount of space -# is available. -[ -d /data ] && BUILDTMP=/data || BUILDTMP=/tmp - -# Root of the ISO and USB images -echo "* Populating root filesystem..." -overlay=$(mktemp -d ${BUILDTMP}/overlay.XXXXXX) -install -d -m 755 $overlay -trap "rm -rf $overlay" ERR INT - -# Create version files -echo "* Creating version files" - -# Boot Manager compares pl_version in both places to make sure that -# the right CD is mounted. We used to boot from an initrd and mount -# the CD on /usr. Now we just run everything out of the initrd. -for file in $overlay/pl_version $overlay/usr/isolinux/pl_version ; do - mkdir -p $(dirname $file) - echo "$FULL_VERSION_STRING" >$file -done - -# Install boot server configuration files -echo "* Installing boot server configuration files" - -# We always intended to bring up and support backup boot servers, -# but never got around to it. Just install the same parameters for -# both for now. -for dir in $overlay/usr/boot $overlay/usr/boot/backup ; do - install -D -m 644 $PLC_BOOT_CA_SSL_CRT $dir/cacert.pem - install -D -m 644 $PLC_ROOT_GPG_KEY_PUB $dir/pubring.gpg - echo "$PLC_BOOT_HOST" >$dir/boot_server - echo "$PLC_BOOT_SSL_PORT" >$dir/boot_server_port - echo "/boot/" >$dir/boot_server_path -done - -# (Deprecated) Install old-style boot server configuration files -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 -echo "$PLC_BOOT_HOST" >$overlay/usr/bootme/BOOTSERVER_IP -echo "$PLC_BOOT_SSL_PORT" >$overlay/usr/bootme/BOOTPORT - -# Generate /etc/issue -echo "* Generating /etc/issue" - -if [ "$PLC_WWW_PORT" = "443" ] ; then - PLC_WWW_URL="https://$PLC_WWW_HOST/" -elif [ "$PLC_WWW_PORT" != "80" ] ; then - PLC_WWW_URL="http://$PLC_WWW_HOST:$PLC_WWW_PORT/" -else - PLC_WWW_URL="http://$PLC_WWW_HOST/" -fi - -mkdir -p $overlay/etc -cat >$overlay/etc/issue <$file + done + + # Install boot server configuration files + echo "* Installing boot server configuration files" + + # We always intended to bring up and support backup boot servers, + # but never got around to it. Just install the same parameters for + # both for now. + for dir in $OVERLAY/usr/boot $OVERLAY/usr/boot/backup ; do + install -D -m 644 $PLC_BOOT_CA_SSL_CRT $dir/cacert.pem + install -D -m 644 $PLC_ROOT_GPG_KEY_PUB $dir/pubring.gpg + echo "$PLC_BOOT_HOST" >$dir/boot_server + echo "$PLC_BOOT_SSL_PORT" >$dir/boot_server_port + echo "/boot/" >$dir/boot_server_path + done + + # 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 + echo "$PLC_BOOT_HOST" >$OVERLAY/usr/bootme/BOOTSERVER_IP + echo "$PLC_BOOT_SSL_PORT" >$OVERLAY/usr/bootme/BOOTPORT + + # Generate /etc/issue + echo "* Generating /etc/issue" + + if [ "$PLC_WWW_PORT" = "443" ] ; then + PLC_WWW_URL="https://$PLC_WWW_HOST/" + elif [ "$PLC_WWW_PORT" != "80" ] ; then + PLC_WWW_URL="http://$PLC_WWW_HOST:$PLC_WWW_PORT/" + else + PLC_WWW_URL="http://$PLC_WWW_HOST/" + fi + + mkdir -p $OVERLAY/etc + cat >$OVERLAY/etc/issue <$overlay/etc/passwd - -# 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" - install -D -m 644 $NODE_CONFIGURATION_FILE $overlay/usr/boot/plnode.txt -fi - -# Pack overlay files into a compressed archive -echo "* Compressing overlay image" -(cd $overlay && find . | cpio --quiet -c -o) | gzip -9 >$isofs/overlay.img - -rm -rf $overlay -trap - ERR INT - -# Calculate ramdisk size (total uncompressed size of both archives) -ramdisk_size=$(gzip -l $isofs/bootcd.img $isofs/overlay.img | tail -1 | awk '{ print $2; }') # bytes -ramdisk_size=$((($ramdisk_size + 1023) / 1024)) # kilobytes - -# Write isolinux configuration -echo "$FULL_VERSION_STRING" >$isofs/pl_version -cat >$isofs/isolinux.cfg < $OVERLAY/etc/passwd + +# this is more harmful than helpful +# idea being, since we start a full-featured fedora system now, it would +# have been nice to be able to enter sshd very early on - before bm has even been downloaded +# however somehow it appears that these lines ruin all chances to enter ssh at all +# either early or even later on; +# plus, it is unclear what this would give on non=systemd nodes, so I am backing off for now +# # recent bootCDs rely on a standard systemd startup sequence +# # so allow debug key to enter in this context whenever that makes sense +# mkdir -p $OVERLAY/root/.ssh +# chmod 700 $OVERLAY/root/.ssh +# cp $PLC_DEBUG_SSH_KEY_PUB $OVERLAY/root/.ssh/authorized_keys +# chmod 600 $OVERLAY/root/.ssh/authorized_keys + + # 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 $NODE_CONFIGURATION_FILE -> /usr/boot/plnode.txt of the bootcd image" + install -D -m 644 $NODE_CONFIGURATION_FILE $OVERLAY/usr/boot/plnode.txt + NODE_ID=$(source $NODE_CONFIGURATION_FILE; echo $NODE_ID) + echo "* Building network configuration for $NODE_ID" + plnet -- --root $OVERLAY --files-only --program BootCD $NODE_ID + fi + + [ -n "$IS_SERIAL" ] && KERNEL_ARGS="$KERNEL_ARGS ${console_spec}" + + # making sure the network interfaces are still numbered eth0 and above + KERNEL_ARGS="$KERNEL_ARGS biosdevname=0" + # this apparently is required instead (or in addition to) starting with f29 + KERNEL_ARGS="$KERNEL_ARGS net.ifnames=0" + # making sure selinux is turned off - somehow this is needed with lxc/f14 + KERNEL_ARGS="$KERNEL_ARGS selinux=0" + # add any debug flag if any (defined in the header of this script) + KERNEL_ARGS="$KERNEL_ARGS $KERNEL_DEBUG_ARGS" + # propagate kernel args for later boot stages + [ -n "$KERNEL_ARGS" ] && echo "$KERNEL_ARGS" > $OVERLAY/kargs.txt + + # Pack overlay files into a compressed archive + echo "* Compressing overlay image" + (cd $OVERLAY && find . | cpio --quiet -c -o) | gzip -9 >$ISOFS/overlay.img + + rm -rf $OVERLAY + pop_cleanup + + if [ -n "$CUSTOM_DIR" ]; then + echo "* Compressing custom image" + (cd "$CUSTOM_DIR" && find . | cpio --quiet -c -o) | gzip -9 >$ISOFS/custom.img + fi + + # Calculate ramdisk size (total uncompressed size of both archives) + ramdisk_size=$(gzip -l $ISOFS/bootcd.img $ISOFS/overlay.img ${CUSTOM_DIR:+$ISOFS/custom.img} | tail -1 | awk '{ print $2; }') # bytes + ramdisk_size=$((($ramdisk_size + 1023) / 1024)) # kilobytes + + echo "$FULL_VERSION_STRING" >$ISOFS/pl_version + + popd +} + +#################### plain ISO +function build_iso() { + local iso="$1" ; shift + local custom="$1" + + # Write isolinux configuration + cat >$ISOFS/isolinux.cfg <$isofs/isolinux.cfg <${BUILDTMP}/mtools.conf<$tmp/syslinux.cfg <$tmp </dev/null || : + mcopy -i "$usb" "$tmp" z:/syslinux.cfg + rm -f "$tmp" + rm -f "${MTOOLSRC}" + unset MTOOLSRC -echo "making USB image bootable." -$srcdir/syslinux/unix/syslinux "$usb" + echo "making USB image bootable." + syslinux -o $offset "$usb" +} -# Create USB image with serial line support -echo -n "* Creating USB image... " -usb="$PLC_NAME-BootCD-$BOOTCD_VERSION-serial.usb" +#################### plain USB +function build_usb() { + echo -n "* Creating USB image... " + local usb="$1" ; shift + local custom="$1" -# Leave 1 MB of free space on the VFAT filesystem -mkfs.vfat -C "$usb" $(($(du -sk $isofs | awk '{ print $1; }') + 1024)) + rm -f "$usb" + mkfs.vfat -C "$usb" $(($(du -Lsk $ISOFS | awk '{ print $1; }') + $FREE_SPACE)) -# Mount it -tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX) -mount -o loop "$usb" $tmp -trap "umount $tmp; rm -rf $tmp" ERR INT + cat >${BUILDTMP}/mtools.conf<$tmp/syslinux.cfg <$tmp </dev/null || : + mcopy -i "$usb" "$tmp" ::/syslinux.cfg + rm -f "$tmp" + rm -f "${MTOOLSRC}" + unset MTOOLSRC + + echo "making USB image bootable." + syslinux "$usb" +} -#overwrite fstab to mount / as cramfs and /tmp as tmpfs -echo "* Overwriting etc/fstab to use cramfs and tmpfs" -rm -f ./etc/fstab -cat >./etc/fstab <./etc/fstab <> etc/inittab + # and let root log in + echo "$console_dev" >> etc/securetty + fi -# update etc/inittab to start with pl_rsysinit -sed -i 's,pl_sysinit,pl_rsysinit,' etc/inittab + # 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 -#calculate the size of /tmp based on the size of /etc & /var + 8MB slack -etcsize=$(du -s ./etc | awk '{ print $1 }') -varsize=$(du -s ./etc | awk '{ print $1 }') -let msize=($vsize+$esize+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 < etc/rc.d/init.d/pl_rsysinit <$tmp/isolinux.cfg <$tmp/isolinux.cfg <$tmp/isolinux.cfg <$tmp/syslinux.cfg <$tmp/syslinux.cfg <$tmp <