--- /dev/null
+#!/bin/bash
+
+# purpose : create a node-specific boot image
+
+# NOTE (see also bootcd/build.sh)
+# If you run your own myplc instance, and you dont need to
+# customize the bootcd, you might wish to use bootcd/build.sh
+# with the -f option
+# However cdcustom.sh might turn out useful if
+# (*) you only have an iso or usb image and nothing else
+# (*) or you want to generate several images in a single run
+# (*) or you run myplc rpm, but need to customize the bootcd image,
+# because the myplc rpm does not come with the required sources
+
+# See usage for full details
+
+######## Implementation notes
+# (*) as of may 2007, this script supports both iso and usb images
+# this becomes a bit tricky sometimes
+# in particular the startup is only partially lazy..
+# most names are kept from former version for easier merge
+# (*) in a former release (iso only) it was possible to perform faster by
+# loopback-mounting the generic iso image
+# Unfortunately mkisofs cannot graft a file that already exists on the
+# original tree (so overlay.img cannot be overridden)
+# to make things worse we cannot loopback-mount the cpio-gzipped
+# overlay image either, so all this stuff is way more complicated
+# than it used to be.
+#
+# (*) as of 2006 jun 28 we use a third image named custom.img for
+# overriding files in bootcd.img, which let us use bootcd.img intact
+# and thus notably speeds things up
+#
+######## Logic
+# here is how we do this for ISO
+# for efficiency, we do only once:
+# (*) mount the generic image
+# (*) copy it into a temp dir
+# (*) unzip/unarchive overlay image into another temp dir
+# (*) if required prepare a custom.img
+# then for each node, we
+# (*) insert plnode.txt at the right place if not a default iso
+# (*) rewrap a gzipped/cpio overlay.img, that we push onto the
+# copied iso tree
+# (*) rewrap this into an iso image
+
+# for USB
+# in principle it's simpler here, but for better code factorization we
+# do the same startup thing, but slightly different
+# only once:
+# (*) mount the generic image
+# (*) unzip/unarchive overlay image into another temp dir
+# then for each node, we
+# (*) copy the generic image into the node-dep image
+# (*) loopback mount it (write enabled)
+# (*) insert plnode.txt at the right place,
+# (*) rewrap a gzipped/cpio overlay.img, that we push onto the
+# mounted image
+# (*) unmount
+
+set -e
+COMMANDSH=$(basename $0)
+COMMAND=$(basename $0 .sh)
+REVISION="$Id$"
+
+function usage () {
+
+ echo "Usage: $COMMANDSH [-f] [ -c bootcd-dir] [generic-image|image-dir] node-config [.. node-configs]"
+ echo " Creates a node-specific boot (iso or usb) image"
+ echo "*Options"
+ echo -e " -f\r\t\tForces overwrite of output images"
+ echo -e " -c bootcd-dir\r\t\tis taken as the root of a set of custom bootcd files"
+ echo -e "\t\ti.e. the files under dir take precedence"
+ echo -e "\t\tover the ones in the generic bootcd"
+ echo -e "\t\tThis is available for ISO images only, and is experimental code"
+ echo -e "-C dir\r\t\tlike make -C, performs chdir prior to running anything"
+ echo -e "-O isoname\r\t\tWrite iso output image to isoname. Does not work with"
+ echo -e "\t\tmultiple node-config files."
+ echo "*Arguments"
+ echo -e " generic-image or image-dir\n\r\t\tThe generic image as downloaded from myplc"
+ echo -e "\t\ttypically from http://myplc.domain.org/download/"
+ echo -e "\t\tor, the already mounted or copied contents in a directory."
+ echo -e " node-config(s)\r\t\tnode config files (plnode.txt format)"
+ echo -e " default\r\t\tmentioned instead of a plnode.txt file, for generating"
+ echo -e "\t\ta node-independent iso image when -c is provided"
+ echo -e "\t\tThis is default behaviour when no node-config are provided"
+ echo "*Outputs"
+ echo " node-specific images are named after nodename[-bootcd-dir]"
+ echo " node-independant image is named after bootcd-dir"
+ echo " with extension .iso or .usb accordingly"
+ echo "*Examples"
+ echo "# $COMMANDSH /plc/data/var/www/html/download/Onelab-BootCD-4.0.usb node1.txt node2.txt"
+ echo " Creates node1.usb and node2.usb that are self-contained USB images for both nodes"
+ echo "# $COMMANDSH -c onelab-bootcd /plc/data/var/www/html/download/onelab-BootCD-4.0.iso"
+ echo " Creates onelab-bootcd.iso that has no plnode.txt embedded and that uses"
+ echo " the hw init scripts located under onelab-bootcd/etc/rc.d/init.d/"
+ echo "*Version $REVISION"
+ exit 1
+}
+
+### read config file in a subshell and echoes host_name
+function host_name () {
+ export CONFIG="$1"; shift
+ ( . "$CONFIG" ; echo "${HOST_NAME}.${DOMAIN_NAME}" )
+}
+
+### Globals
+# we set this to iso or usb according to the generic-image provided
+IMAGE_TYPE=
+PLNODE_PATH=/usr/boot
+PLNODE=plnode.txt
+DEFAULT_TARGET=default
+# defined on the command-line
+CUSTOM_DIR=
+## arg-provided generic iso
+ISO_GENERIC=
+# node-dep conf file
+NODE_CONFIG=
+# resulting iso image and log
+NODE_ISO=
+NODE_LOG=
+## mount points and temps
+ISO_MOUNT="/tmp/$COMMAND-$$-mount"
+ISO_ROOT="/tmp/$COMMAND-$$-iso"
+OVERLAY_ROOT="/tmp/$COMMAND-$$-overlay"
+# node-dep cpio/gzip image
+NODE_OVERLAY=
+
+CPIO_OARGS="-oc --quiet"
+CPIO_IARGS="-id --quiet"
+CPIO_PARGS="-pdu --quiet"
+
+# export DEBUG=true
+# for enabling debug messages (set -x)
+
+# export VERBOSE=true for enabling this
+function verbose () {
+ if [ -n "$VERBOSE" ] ; then
+ echo "$@"
+ fi
+ }
+
+function message () { echo -e "$COMMAND : $@" ; }
+function message-n () { echo -en "$COMMAND : $@" ; }
+function message-done () { echo Done ; }
+function error () { echo -e "$COMMAND : ERROR $@ - exiting" ; exit 1 ;}
+
+# lazy startup
+STARTED_UP=
+function startup () {
+
+ trap abort int hup quit err
+ set -e
+
+ [[ -n "$DEBUG" ]] && set -x
+
+ # lazy : run only once
+ if [ -z "$STARTED_UP" ] ; then
+ message "lazy start up"
+
+ ### checking
+ [ ! -f "$ISO_GENERIC" ] && [ ! -d "$ISO_GENERIC" ] && error "Could not find template ISO image"
+ [ -d "$ISO_MOUNT" ] && error "$ISO_MOUNT already exists"
+ [ -d "$ISO_ROOT" ] && [ ! -d "$ISO_GENERIC" ] && error "$ISO_ROOT already exists"
+ [ -d "$OVERLAY_ROOT" ] && error "$OVERLAY_ROOT already exists"
+
+ verbose "Creating temp dirs"
+ mkdir -p "$ISO_MOUNT" "$ISO_ROOT" "$OVERLAY_ROOT"
+
+ if [[ "$IMAGE_TYPE" = "usb" || "$IMAGE_TYPE" = "iso" ]] ; then
+ verbose "Mounting generic ISO $ISO_GENERIC under $ISO_MOUNT"
+ mount -o ro,loop "$ISO_GENERIC" "$ISO_MOUNT"
+ else
+ # the iso_generic name is the directory from which files are available
+ ISO_MOUNT=$ISO_GENERIC
+ fi
+
+ if [[ "$IMAGE_TYPE" = "iso" || "$IMAGE_TYPE" = "dir" ]] ; then
+ ### ISO
+ ### DONT!! use tar for duplication
+ message "Duplicating ISO image in $ISO_ROOT"
+ (cd "$ISO_MOUNT" ; find . | cpio $CPIO_PARGS "$ISO_ROOT" )
+
+ if [ -n "$CUSTOM_DIR" ] ; then
+ [ -d "$CUSTOM_DIR" ] || error "Directory $CUSTOM_DIR not found"
+ prepare_custom_image
+ fi
+ fi
+ ### USB specifics are done unconditionnally, see below
+
+ message "Extracting generic overlay image in $OVERLAY_ROOT"
+ gzip -d -c "$ISO_MOUNT/overlay.img" | ( cd "$OVERLAY_ROOT" ; cpio $CPIO_IARGS )
+
+ STARTED_UP=true
+ fi
+
+ # for USB: do this for every node
+ if [ "$IMAGE_TYPE" = "usb" ] ; then
+ message "Duplicating $ISO_GENERIC into $NODE_ISO"
+ cp "$ISO_GENERIC" "$NODE_ISO"
+ message "Mounting write-enabled"
+ mount -o loop "$NODE_ISO" "$ISO_ROOT"
+ fi
+
+}
+
+function prepare_custom_image () {
+
+ # Cleaning any sequel
+ rm -f custom.img
+ [ -f custom.img ] && error "Could not cleanup custom.img"
+
+ message "WARNING : You are creating *custom* boot CDs"
+
+ message-n "Creating $ISO_ROOT/custom.img"
+ (cd $"CUSTOM_DIR" ; find . | cpio $CPIO_OARGS) | gzip -9 > "$ISO_ROOT"/custom.img
+ message-done
+
+}
+
+function node_cleanup () {
+ verbose "Cleaning node-dependent cpio image"
+ rm -rf "$NODE_OVERLAY"
+
+}
+
+function cleanup () {
+
+ echo "$COMMAND : cleaning up"
+ [[ -n "$DEBUG" ]] && set -x
+
+ verbose "Cleaning overlay image"
+ rm -rf "$OVERLAY_ROOT"
+ verbose "Cleaning ISO image"
+ rm -rf "$ISO_ROOT"
+ verbose "Cleaning node-dep overlay image"
+ rm -f "$NODE_OVERLAY"
+ if [[ "$IMAGE_TYPE" = "iso" || "$IMAGE_TYPE" = "usb" ]]; then
+ verbose "Unmounting $ISO_MOUNT"
+ umount "$ISO_MOUNT" 2> /dev/null
+ rmdir "$ISO_MOUNT"
+ fi
+ exit
+}
+
+function abort () {
+ echo "$COMMAND : Aborting"
+ message "Cleaning $NODE_ISO"
+ rm -f "$NODE_ISO"
+ cleanup
+}
+
+function main () {
+
+ trap abort int hup quit err
+ set -e
+
+ [[ -n "$DEBUG" ]] && set -x
+
+ # accept -b as -c, I am used to it now
+ while getopts "c:b:O:C:fh" opt ; do
+ case "$opt" in
+ c|b)
+# not sure about the status of this, you are warned
+# echo "The custom option in $COMMAND is broken " ; exit 1
+ echo "WARNING : The custom option in $COMMAND is maybe broken "
+ echo -n "You will have been warned, proceed ? "
+ read answer
+ CUSTOM_DIR="$OPTARG" ;;
+ C)
+ cd "$OPTARG" ;;
+ O)
+ NODEOUTPUT="$OPTARG" ;;
+ f)
+ FORCE_OUTPUT=true ;;
+ h|*)
+ usage ;;
+ esac
+ done
+
+ shift $(($OPTIND-1))
+
+ [[ -z "$@" ]] && usage
+ ISO_GENERIC="$1"; shift
+
+ if [[ -z "$@" ]] ; then
+ nodes="$DEFAULT_TARGET"
+ else
+ nodes="$@"
+ fi
+
+ ### getting image type
+ iso="${ISO_GENERIC%.iso}"
+ usb="${ISO_GENERIC%.usb}"
+
+ if [ -d "$ISO_GENERIC" ] ; then
+ IMAGE_TYPE=dir
+ elif [ "$ISO_GENERIC" != "$iso" ] ; then
+ IMAGE_TYPE=iso
+ elif [ "$ISO_GENERIC" != "$usb" ] ; then
+ IMAGE_TYPE=usb
+ else
+ echo "Could not figure type of $ISO_GENERIC -- exiting"
+ exit 1
+ fi
+
+# perform that later (lazily)
+# so that (1st) node-dep checking are done before we bother to unpack
+# startup
+
+ for NODE_CONFIG in $nodes ; do
+
+ if [ "$NODE_CONFIG" = "$DEFAULT_TARGET" ] ; then
+ NODE_DEP=""
+ # default node without customization does not make sense
+ if [ -z "$CUSTOM_DIR" ] ; then
+ message "creating a non-custom node-indep. image refused\n(Would have no effect)"
+ continue
+ else
+ NODENAME="$DEFAULT_TARGET"
+ NODEOUTPUT=$(basename "$CUSTOM_DIR")
+ fi
+ else
+ NODE_DEP=true
+ NODENAME=$(host_name "$NODE_CONFIG")
+ case "$NODENAME" in
+ .*|*.)
+ message "HOST_NAME or DOMAIN_NAME not found in $NODE_CONFIG - skipped"
+ continue ;;
+ esac
+ if [ -z "$NODEOUTPUT" ] ; then
+ if [ -z "$CUSTOM_DIR" ] ; then
+ NODEOUTPUT="$NODENAME"
+ else
+ NODEOUTPUT="${NODENAME}"-$(basename "$CUSTOM_DIR")
+ fi
+ fi
+ fi
+
+ message "$COMMAND : dealing with node $NODENAME"
+
+ if [[ "$IMAGE_TYPE" = "iso" || "$IMAGE_TYPE" = "dir" ]] ; then
+ NODE_ISO="$NODEOUTPUT.iso"
+ NODE_LOG="$NODEOUTPUT-iso.log"
+ else
+ NODE_ISO="$NODEOUTPUT.usb"
+ NODE_LOG="$NODEOUTPUT-usb.log"
+ fi
+
+ ### checking
+ if [ -e "$NODE_ISO" ] ; then
+ if [ -n "$FORCE_OUTPUT" ] ; then
+ message "$NODE_ISO exists, will overwrite (-f)"
+ rm "$NODE_ISO"
+ else
+ message "$NODE_ISO exists, please remove first - skipped" ; continue
+ fi
+ fi
+ if [ -n "$NODE_DEP" -a ! -f "$NODE_CONFIG" ] ; then
+ message "Could not find node-specifig config - skipped" ; continue
+ fi
+
+ startup
+
+ if [ -n "$NODE_DEP" ] ; then
+ verbose "Pushing node config into overlay image"
+ mkdir -p "$OVERLAY_ROOT"/"$PLNODE_PATH"
+ cp "$NODE_CONFIG" "$OVERLAY_ROOT"/"$PLNODE_PATH"/"$PLNODE"
+ else
+ verbose "Cleaning node config for node-indep. image"
+ rm -f "$OVERLAY_ROOT"/"$PLNODE_PATH"/"$PLNODE"
+ fi
+
+ echo "$COMMAND : Creating overlay image for $NODENAME"
+ (cd "$OVERLAY_ROOT" ; find . | cpio $CPIO_OARGS) | gzip -9 > "$ISO_ROOT"/overlay.img
+
+ if [[ "$IMAGE_TYPE" = "iso" || "$IMAGE_TYPE" = "dir" ]] ; then
+ ### ISO
+ message "Refreshing isolinux.cfg"
+ # Calculate ramdisk size (total uncompressed size of both archives)
+
+ ##########
+ # N.B. Thierry Parmentelat - 2006-06-28
+ # the order in which these images need to be mentioned here for
+ # isolinux involved some - not so educated - guesses
+ # as per syslinux source code in syslinux/runkernel.inc, the
+ # config file is parsed left to right, and indeed it's in that
+ # order that the files are loaded right off the CD
+ # This does not tell however, in case a given file is present in
+ # two different images - and that's the very purpose here - which
+ # one will take precedence over the other
+ # I came up with this order on a trial-and-error basis, I would
+ # have preferred to find it described somewhere
+ # Might be worth checking with other versions of syslinux in case
+ # the custom files would turn out to not be taken into account
+ ##########
+
+ if [ -n "$CUSTOM_DIR" ] ; then
+ images="bootcd.img custom.img overlay.img"
+ else
+ images="bootcd.img overlay.img"
+ fi
+
+ ramdisk_size=$(cd "$ISO_ROOT" ; gzip -l $images | tail -1 | awk '{ print $2; }') # bytes
+ # keep safe, provision for cpio's block size
+ ramdisk_size=$(($ramdisk_size / 1024 + 1)) # kilobytes
+
+ initrd_images=$(echo "$images" | sed -e 's/ /,/g')
+ # Write isolinux configuration
+ cat > "$ISO_ROOT"/isolinux.cfg <<EOF
+DEFAULT kernel
+APPEND ramdisk_size=$ramdisk_size initrd=$initrd_images root=/dev/ram0 rw
+DISPLAY pl_version
+PROMPT 0
+TIMEOUT 40
+EOF
+
+ message-n "Writing custom image, log on $NODE_LOG .. "
+ mkisofs -o "$NODE_ISO" -R -allow-leading-dots -J -r -b isolinux.bin \
+ -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table \
+ "$ISO_ROOT" > "$NODE_LOG" 2>&1
+ message-done
+
+ else
+ ### USB
+ umount "$NODE_ISO"
+ fi
+ node_cleanup
+
+ message "Image for $NODENAME in $NODE_ISO"
+ done
+
+ cleanup
+
+}
+
+####################
+main "$@"
git://git.onelab.eu / bootcd.git / commitdiff