working draft of boot cd v3 documentation
[bootcd.git] / build.sh
index 09fac14..398c335 100755 (executable)
--- a/build.sh
+++ b/build.sh
@@ -2,37 +2,24 @@
 
 set -e
 
-BOOTCD_VERSION="3.0-beta0.3"
-FULL_VERSION_STRING="PlanetLab BootCD $BOOTCD_VERSION"
+# where the boot cd build config files are stored (and certificats/keys)
+CONFIGURATIONS_DIR=configurations/
 
-# which boot server to contact
-BOOTSERVER='boot.planet-lab.org'
-
-# and on which port (protocol will be https)
-BOOTSERVER_PORT='443'
-
-# finally, what path to request from the server
-BOOTSERVER_PATH='boot/'
+# where built files are stored
+BUILD_DIR=build/
 
+BOOTCD_VERSION="3.1"
+FULL_VERSION_STRING="PlanetLab BootCD"
+OUTPUT_IMAGE_NAME='PlanetLab-BootCD'
+    
 SYSLINUX_SRC=sources/syslinux-2.11.tar.bz2
 
-ISO=cd.iso
-
-CD_ROOT=`pwd`/cdroot
-ROOT_PASSWD='$1$IdEn2srw$/TfrjZSPUC1xP244YCuIi0'
-
 BOOTCD_YUM_GROUP=BootCD
 
 CDRECORD_FLAGS="-v -dao"
 
 CONF_FILES_DIR=conf_files/
 
-# location of the uncompressed ramdisk image
-INITRD=$CD_ROOT/usr/isolinux/initrd
-
-# temporary mount point for rd
-INITRD_MOUNT=`pwd`/rd
-
 # size of the ram disk in MB
 RAMDISK_SIZE=64
 
@@ -40,6 +27,27 @@ RAMDISK_SIZE=64
 INITRD_BYTES_PER_INODE=1024
 
 
+# make sure the boot manager source is checked out in the same directory
+# as the bootcd_v3 repository
+BOOTMANAGER_DIR=../bootmanager/
+
+if [ ! -d $BOOTMANAGER_DIR ]; then
+    echo "the bootmanager repository needs to be checked out at the same"
+    echo "level as this directory, for the merge_hw_tables.py script"
+    exit
+fi
+
+
+function usage()
+{
+    echo "Usage: build.sh <action> [<configuration>]"
+    echo "Action: build burn clean"
+    echo
+    echo "If configuration is missing, 'default' is loaded"
+    exit
+}
+
+
 function build_cdroot()
 {
     if [ -f $CD_ROOT/.built ]; then
@@ -60,6 +68,9 @@ function build_cdroot()
     echo "setup rpm to install only en_US locale and no docs"
     mkdir -p $CD_ROOT/etc/rpm
     cp -f $CONF_FILES_DIR/macros $CD_ROOT/etc/rpm
+    # trick rpm and yum
+    export HOME=$PWD
+    cp -f $CONF_FILES_DIR/macros $PWD/.rpmmacros
 
     echo "initialize rpm db"
     mkdir -p $CD_ROOT/var/lib/rpm
@@ -92,7 +103,7 @@ function build_cdroot()
        --enablemd5 --enableshadow
 
     echo "setting root password"
-    sed -i "s#root::#root:$ROOT_PASSWD:#g" $CD_ROOT/etc/shadow
+    sed -i "s#root::#root:$ROOT_PASSWORD:#g" $CD_ROOT/etc/shadow
 
     echo "relocate some large directories out of the root system"
     # get /var/lib/rpm out, its 12mb. create in its place a 
@@ -101,21 +112,32 @@ function build_cdroot()
     mv $CD_ROOT/var/lib/rpm $CD_ROOT/usr/relocated/var/lib/
     (cd $CD_ROOT/var/lib && ln -s ../../usr/relocated/var/lib/rpm rpm)
 
+    # get /var/cache/yum out, its 100Mb. create in its place a 
+    # symbolic link to /usr/relocated/var/cache/yum
+    mkdir -p $CD_ROOT/usr/relocated/var/cache/
+    mv $CD_ROOT/var/cache/yum $CD_ROOT/usr/relocated/var/cache/
+    (cd $CD_ROOT/var/cache && ln -s ../../usr/relocated/var/cache/yum yum)
+
     # get /lib/tls out
     mkdir -p $CD_ROOT/usr/relocated/lib
     mv $CD_ROOT/lib/tls $CD_ROOT/usr/relocated/lib/
     (cd $CD_ROOT/lib && ln -s ../usr/relocated/lib/tls tls)
 
     echo "extracting syslinux, copying isolinux files to cd"
-    mkdir -p syslinux
     mkdir -p $CD_ROOT/usr/isolinux/
-    tar -C syslinux -xjvf $SYSLINUX_SRC
-    find syslinux -name isolinux.bin -exec cp -f {} $CD_ROOT/usr/isolinux/ \;
+    mkdir -p $BUILD_DIR/syslinux
+    tar -C $BUILD_DIR/syslinux -xjvf $SYSLINUX_SRC
+    find $BUILD_DIR/syslinux -name isolinux.bin \
+       -exec cp -f {} $CD_ROOT/usr/isolinux/ \;
 
     echo "moving kernel to isolinux directory"
     KERNEL=$CD_ROOT/boot/vmlinuz-*
     mv -f $KERNEL $CD_ROOT/usr/isolinux/kernel
 
+    echo "moving /usr/bin/find and /usr/bin/dirname to /bin"
+    mv $CD_ROOT/usr/bin/find $CD_ROOT/bin/
+    mv $CD_ROOT/usr/bin/dirname $CD_ROOT/bin/
+
     echo "creating version files"
     echo "$FULL_VERSION_STRING" > $CD_ROOT/usr/isolinux/pl_version
     echo "$FULL_VERSION_STRING" > $CD_ROOT/pl_version
@@ -155,14 +177,33 @@ function build_initrd()
     cp -f $CONF_FILES_DIR/default-net.cnf $CD_ROOT/usr/boot/
 
     echo "setup boot server configuration"
-    cp -f $CONF_FILES_DIR/cacert.pem $CD_ROOT/usr/boot/
-    cp -f $CONF_FILES_DIR/pubring.gpg $CD_ROOT/usr/boot/
-    echo "$BOOTSERVER" > $CD_ROOT/usr/boot/boot_server
-    echo "$BOOTSERVER_PORT" > $CD_ROOT/usr/boot/boot_server_port
-    echo "$BOOTSERVER_PATH" > $CD_ROOT/usr/boot/boot_server_path
+    cp -f $CURRENT_CONFIG_DIR/$PRIMARY_SERVER_CERT $CD_ROOT/usr/boot/cacert.pem
+    cp -f $CURRENT_CONFIG_DIR/$PRIMARY_SERVER_GPG $CD_ROOT/usr/boot/pubring.gpg
+    echo "$PRIMARY_SERVER" > $CD_ROOT/usr/boot/boot_server
+    echo "$PRIMARY_SERVER_PORT" > $CD_ROOT/usr/boot/boot_server_port
+    echo "$PRIMARY_SERVER_PATH" > $CD_ROOT/usr/boot/boot_server_path
+
+    echo "setup backup boot server configuration"
+    mkdir -p $CD_ROOT/usr/boot/backup
+    cp -f $CURRENT_CONFIG_DIR/$BACKUP_SERVER_CERT \
+       $CD_ROOT/usr/boot/backup/cacert.pem
+    cp -f $CURRENT_CONFIG_DIR/$BACKUP_SERVER_GPG \
+       $CD_ROOT/usr/boot/backup/pubring.gpg
+    echo "$BACKUP_SERVER" > $CD_ROOT/usr/boot/backup/boot_server
+    echo "$BACKUP_SERVER_PORT" > $CD_ROOT/usr/boot/backup/boot_server_port
+    echo "$BACKUP_SERVER_PATH" > $CD_ROOT/usr/boot/backup/boot_server_path
 
     echo "copying old boot cd directory bootme (TEMPORARY)"
     cp -r bootme_old $CD_ROOT/usr/bootme
+    echo "$FULL_VERSION_STRING" > $CD_ROOT/usr/bootme/ID
+    echo "$PRIMARY_SERVER" > $CD_ROOT/usr/bootme/BOOTSERVER
+    echo "$PRIMARY_SERVER" > $CD_ROOT/usr/bootme/BOOTSERVER_IP
+    echo "$PRIMARY_SERVER_PORT" > $CD_ROOT/usr/bootme/BOOTPORT
+
+    echo "copying cacert to old boot cd directory bootme (TEMPORARY)"
+    mkdir -p $CD_ROOT/usr/bootme/cacert/$PRIMARY_SERVER/
+    cp -f $CURRENT_CONFIG_DIR/$PRIMARY_SERVER_CERT \
+       $CD_ROOT/usr/bootme/cacert/$PRIMARY_SERVER/cacert.pem
 
     echo "forcing lvm to make lvm1 partitions (TEMPORARY)"
     cp -f $CONF_FILES_DIR/lvm.conf $CD_ROOT/etc/lvm/
@@ -177,6 +218,12 @@ function build_initrd()
     echo "" >> $CD_ROOT/etc/issue
     echo "" >> $CD_ROOT/etc/issue
 
+    if [[ ! -z "$NODE_CONFIGURATION_FILE" ]]; then
+       echo "Copying node configuration file to cd"
+       cp -f $CURRENT_CONFIG_DIR/$NODE_CONFIGURATION_FILE \
+           $CD_ROOT/usr/boot/plnode.txt
+    fi
+
     echo "making the isolinux initrd kernel command line match rd size"
     let INITRD_SIZE_KB=$(($RAMDISK_SIZE * 1024))
     sed -i "s#ramdisk_size=0#ramdisk_size=$INITRD_SIZE_KB#g" \
@@ -186,8 +233,8 @@ function build_initrd()
     pci_map_file=`find $CD_ROOT/lib/modules/ -name modules.pcimap | head -1`
     module_dep_file=`find $CD_ROOT/lib/modules/ -name modules.dep | head -1`
     pci_table=$CD_ROOT/usr/share/hwdata/pcitable
-    ./scripts/rewrite-pcitable.py $module_dep_file $pci_map_file $pci_table \
-       $CD_ROOT/etc/pl_pcitable
+    $BOOTMANAGER_DIR/source/merge_hw_tables.py \
+       $module_dep_file $pci_map_file $pci_table $CD_ROOT/etc/pl_pcitable
 
     dd if=/dev/zero of=$INITRD bs=1M count=$RAMDISK_SIZE
     mkfs.ext2 -F -m 0 -i $INITRD_BYTES_PER_INODE $INITRD
@@ -207,13 +254,39 @@ function build_initrd()
     gzip $INITRD
 }
 
-function build_iso()
+function build()
 {
-    echo "building iso"
+    # build base image via yum
+    build_cdroot
+
+    # always build/rebuild initrd
+    build_initrd
+
+    # build iso image
     rm -f $ISO
     mkisofs -o $ISO -R -allow-leading-dots -J -r -b isolinux/isolinux.bin \
        -c isolinux/boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table \
-       -V PlanetLab-3-0 $CD_ROOT/usr
+       $CD_ROOT/usr
+
+    # build usb image and make it bootable with syslinux (instead of isolinux)
+    USB_IMAGE=${ISO%*.iso}.usb
+    # leave 1 MB of free space on the filesystem
+    USB_KB=$(du -kc $ISO $CD_ROOT/usr/isolinux | awk '$2 == "total" { print $1 + 1024 }')
+    mkfs.vfat -C $USB_IMAGE $USB_KB
+
+    mkdir -p $INITRD_MOUNT
+    mount -o loop,rw $USB_IMAGE $INITRD_MOUNT
+
+    # populate the root of the image with the iso, pl_version, and the syslinux files
+    cp -a $ISO $INITRD_MOUNT
+    cp -a $CD_ROOT/usr/isolinux/{initrd.gz,kernel,message.txt,pl_version} $INITRD_MOUNT
+    cp -a $CD_ROOT/usr/isolinux/isolinux.cfg $INITRD_MOUNT/syslinux.cfg
+
+    umount $INITRD_MOUNT
+    rmdir $INITRD_MOUNT
+
+    # make it bootable
+    syslinux $USB_IMAGE
 }
 
 function burn()
@@ -223,32 +296,69 @@ function burn()
 
 function clean()
 {
-    echo "removing built files"
-    rm -rf cdroot
-    rm -rf syslinux
-    rm -rf $INITRD_MOUNT
+    rm -rf $CD_ROOT
+    rm -rf $BUILD_DIR/syslinux
+    rm -rf $BUILD_DIR/$INITRD_MOUNT
+    rm -rf $BUILD_DIR
     rm -f $ISO
+    rmdir --ignore-fail-on-non-empty build
 }
 
+if [[ "$1" == "clean" || "$1" == "burn" || "$1" == "build" ]]; then
+    action=$1
+    configuration=$2
 
-if [ "$1" == "clean" ]; then
-    clean
-    exit
-fi
+    if [[ -z "$configuration" ]]; then
+       configuration=default
+    fi
 
-if [ "$1" == "burn" ]; then
-    burn
-    exit
-fi
+    echo "Loading configuration $configuration"
+    CURRENT_CONFIG_DIR=$CONFIGURATIONS_DIR/$configuration
+    . $CURRENT_CONFIG_DIR/configuration
 
-if [ "$1" == "force" ]; then
-    clean
-fi
+    # setup vars for this configuration
+
+    # version string for this build
+    if [[ ! -z "$EXTRA_VERSION" ]]; then
+       FULL_VERSION_STRING="$FULL_VERSION_STRING $EXTRA_VERSION"
+    fi
+    FULL_VERSION_STRING="$FULL_VERSION_STRING $BOOTCD_VERSION"
+
+    # destination image
+    if [[ ! -z "$EXTRA_VERSION" ]]; then
+       OUTPUT_IMAGE_NAME="$OUTPUT_IMAGE_NAME-$EXTRA_VERSION"
+    fi
+    OUTPUT_IMAGE_NAME="$OUTPUT_IMAGE_NAME-$BOOTCD_VERSION"
+
+    # setup build directories
+    BUILD_DIR=build/$configuration
+    mkdir -p $BUILD_DIR
+    ISO=$BUILD_DIR/`echo $OUTPUT_IMAGE_NAME | sed -e "s/%version/$BOOTCD_VERSION/"`.iso
 
-# build base image via yum
-build_cdroot
+    CD_ROOT=`pwd`/$BUILD_DIR/cdroot
+    mkdir -p $CD_ROOT
 
-# always build/rebuild initrd
-build_initrd
+    # location of the uncompressed ramdisk image
+    INITRD=$CD_ROOT/usr/isolinux/initrd
+
+    # temporary mount point for rd
+    INITRD_MOUNT=`pwd`/$BUILD_DIR/rd
+
+
+    case $action in 
+       build )
+           echo "Proceeding with building $DESCRIPTION"
+           build;;
+
+       clean )
+           echo "Removing built files for $DESCRIPTION"
+           clean;;
+
+       burn )
+           echo "Burning $DESCRIPTION"
+           burn;;
+    esac    
+else
+    usage
+fi
 
-build_iso