Synnefo » snf-image

# Copyright (C) 2011 GRNET S.A. 

# Copyright (C) 2007, 2008, 2009 Google Inc.

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

# General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

# 02110-1301, USA.

SNF_IMAGE_VERSION="@VERSION@"

AWK="awk"

LOSETUP="losetup"

KPARTX="kpartx"

SFDISK="sfdisk"

QEMU_IMG="qemu-img"

INSTALL_MBR="install-mbr"

TIMEOUT="timeout"

CURL="curl"

TAR="tar"

DATE="date -u" # Time in UTC

# Temporary use stderr as monitoring file descriptor.

# `create' will overwrite this

MONITOR_FD="2"

MSG_TYPE_ERROR="image-error"

MSG_TYPE_INFO="image-info"

CLEANUP=( )

ERROR_MSGS=( )

add_cleanup() {

    local cmd=""

    for arg; do cmd+=$(printf "%q " "$arg"); done

    CLEANUP+=("$cmd")

}

log_error() {

    echo "[ERROR] $*" >&2

}

log_warning() {

    echo "[WARNING] $*" >&2

}

report_error() {

    ERROR_MSGS+=("$@")

}

report_info() {

    local report

    echo "[INFO] $*" >&2

    report="$(./host-monitor.py info <<< "$*")"

    eval "echo $(printf "%q" "$report") >&${MONITOR_FD}"

}

close_fd() {

    local fd="$1"

    exec {fd}>&-

}

send_errors() {

    local report=""

    if [ ${#ERROR_MSGS[@]} -gt 0 ]; then

        local msg=""

        for err in "${ERROR_MSGS[@]}"; do

            msg+="$(echo "$err")"

        done

        report="$(./host-monitor.py error <<< "$msg")"

    else

        report=$(./host-monitor.py error <<< "Internal Error: Image deployment failed.")

    fi

    eval "echo $(printf "%q" "$report") >&${MONITOR_FD}"

}

get_api5_arguments() {

    GETOPT_RESULT=$*

    # Note the quotes around `$TEMP': they are essential!

    eval set -- "$GETOPT_RESULT"

    while true; do

        case "$1" in

            -i|-n) instance=$2; shift 2;;

            -o) old_name=$2; shift 2;;

            -b) blockdev=$2; shift 2;;

            -s) swapdev=$2; shift 2;;

            --) shift; break;;

            *)  log_error "Internal error!" >&2; exit 1;;

        esac

    done

    if [ -z "$instance" -o -z "$blockdev" ]; then

        log_error "Missing OS API Argument (-i, -n, or -b)"

        exit 1

    fi

    if [ "$SCRIPT_NAME" != "export" -a -z "$swapdev"  ]; then

        log_error "Missing OS API Argument -s (swapdev)"

        exit 1

    fi

    if [ "$SCRIPT_NAME" = "rename" -a -z "$old_name"  ]; then

        log_error "Missing OS API Argument -o (old_name)"

        exit 1

    fi

}

get_api10_arguments() {

    if [ -z "$INSTANCE_NAME" -o -z "$HYPERVISOR" -o -z "$DISK_COUNT" ]; then

        log_error "Missing OS API Variable:"

        log_error "(INSTANCE_NAME HYPERVISOR or DISK_COUNT)"

        exit 1

    fi

    case $HYPERVISOR in

        xen-hvm|xen-pvm) . xen-common.sh ;;

        kvm) . kvm-common.sh ;;

        *) log_error "Unsupported hypervisor: \`$HYPERVISTOR'"; exit 1;;

    esac

    instance=$INSTANCE_NAME

    if [ $DISK_COUNT -lt 1 -o -z "$DISK_0_PATH" ]; then

        log_error "At least one disk is needed"

        exit 1

    fi

    if [ "$SCRIPT_NAME" = "export" ]; then

        if [ -z "$EXPORT_DEVICE" ]; then

            log_error "Missing OS API Variable EXPORT_DEVICE"

            exit 1

        fi

        blockdev=$EXPORT_DEVICE

    elif [ "$SCRIPT_NAME" = "import" ]; then

        if [ -z "$IMPORT_DEVICE" ]; then

            log_error "Missing OS API Variable IMPORT_DEVICE"

            exit 1

        fi

        blockdev=$IMPORT_DEVICE

    else

        blockdev=$DISK_0_PATH

    fi

    if [ "$SCRIPT_NAME" = "rename" -a -z "$OLD_INSTANCE_NAME" ]; then

        log_error "Missing OS API Variable OLD_INSTANCE_NAME"

        exit 1

    fi

    old_name=$OLD_INSTANCE_NAME

}

get_api20_arguments() {

    get_api10_arguments

    if [ "$SCRIPT_NAME" = "create" ]; then

        local required_osparams="IMG_ID IMG_FORMAT IMG_PASSWD"

        local osparams="$required_osparams IMG_PROPERTIES IMG_PERSONALITY CONFIG_URL"

        # Store OSP_VAR in VAR

        for param in $osparams; do

            eval $param=\"\$OSP_$param\"

        done

        if [ -n "$CONFIG_URL" ]; then

            local config config_params

            echo "Downloading configuration parameters from: \`$CONFIG_URL'" >&2

            config=$($CURL -f "$CONFIG_URL")

            config_params=$(./decode-config.py $osparams <<< "$config")

            eval "$config_params"

        fi

        for var in $required_osparams; do

            if [ -z "${!var}" ]; then

                 log_error "Missing OS API Parameter: ${var}"

                 exit 1

            fi

        done

    fi

}

map_disk0() {

    blockdev="$1"

    filesystem_dev_base=$($KPARTX -l -p- $blockdev | \

                            grep -m 1 -- "-1.*$blockdev" | \

                            $AWK '{print $1}')

    if [ -z "$filesystem_dev_base" ]; then

        log_error "Cannot interpret kpartx output and get partition mapping"

        exit 1

    fi

    $KPARTX -a -p- "$blockdev" > /dev/null

    filesystem_dev="/dev/mapper/${filesystem_dev_base/%-1/}"

    if [ ! -b "/dev/mapper/$filesystem_dev_base" ]; then

        log_error "Can't find kpartx mapped partition:" \

                                            "/dev/mapper/$filesystem_dev_base"

        exit 1

    fi

    echo "$filesystem_dev"

}

unmap_disk0() {

    $KPARTX -d -p- "$1"

}

format_disk0() {

    local device="$1"

    local image_type="$2"

    declare -A part_id=( ['extdump']="83" ["ntfsdump"]="7" )

    # The -f is needed, because we use an optimal alignment and sfdisk complains

    # about partitions not ending on clylinder boundary.

    local sfdisk_cmd="$SFDISK -uS -H 255 -S 63 -f --quiet --Linux --DOS $device"

    $sfdisk_cmd > /dev/null <<EOF

2048,,${part_id["$image_type"]},*

EOF

}

create_floppy() {

    local img target

    img=$1

    target=$(mktemp -d)

    add_cleanup rmdir "$target"

    dd bs=512 count=2880 if=/dev/zero of="$img"

    mkfs.ext2 -F "$img" > /dev/null

    mount "$img" "$target" -o loop

    set | egrep ^snf_export_\\w+= | sed -e 's/^snf_export_/export SNF_IMAGE_/' \

        > "$target/rules"

    if [ -n "$UNATTEND" ]; then

        if [ -f "$UNATTEND" ]; then

            cat "$UNATTEND" > "$target/unattend.xml"

        else

            log_error "Unattend file: \`"$UNATTEND"' does not exist"

            exit 1

        fi

    fi

    umount "$target"

}

get_backend_type() {

    local id=$1

    if [[ "$id" =~ ^pithos: ]]; then

        echo "pithos"

    elif [[ "$id" =~ ^pithosmap: ]]; then

        echo "pithos"

    elif [[ "$id" =~ ^(http|ftp)s?: ]]; then

        echo "network"

    elif [ "$id" = "null" ]; then

        echo "null"

    else

        echo "local"

    fi

}

canonicalize() {

    local name="$1"

    if [ -d "$name" ]; then

        name="$name/"

    fi

    local dname="${name%/*}"

    local fname="${name##*/}"

    if [ "x$dname" = "x" -a "${name:0:1}" = "/" ]; then

        dname="/"

    fi

    if [ -d "$dname" ]; then

        (cd -- "$dname" && echo "${PWD%/}/$fname")

    else

        echo

    fi

}

# this one is only to be called by create

ganeti_os_main() {

    if [ -z "$OS_API_VERSION" -o "$OS_API_VERSION" = "5" ]; then

        OS_API_VERSION=5

        GETOPT_RESULT=`getopt -o o:n:i:b:s: -n '$0' -- "$@"`

        if [ $? != 0 ] ; then log_error "Terminating..."; exit 1 ; fi

        get_api5_arguments $GETOPT_RESULT

    elif [ "$OS_API_VERSION" = "10" -o "$OS_API_VERSION" = "15" ]; then

        get_api10_arguments

    elif [ "$OS_API_VERSION" = "20" ]; then

        get_api20_arguments

        IMAGE_NAME="$IMG_ID"

        IMAGE_TYPE="$IMG_FORMAT"

        BACKEND_TYPE=$(get_backend_type $IMG_ID)

    else

        log_error "Unknown OS API VERSION $OS_API_VERSION"

        exit 1

    fi

    if [ -n "$OS_VARIANT" ]; then

        if [ ! -d "$VARIANTS_DIR" ]; then

            log_error "OS Variants directory $VARIANTS_DIR doesn't exist"

            exit 1

        fi

        VARIANT_CONFIG="$VARIANTS_DIR/$OS_VARIANT.conf"

        if [ -f "$VARIANT_CONFIG" ]; then

            . "$VARIANT_CONFIG"

        else

            if grep -qxF "$OS_VARIANT" variants.list; then

                log_error "ERROR: instance-image configuration error"

                log_error "  Published variant $OS_VARIANT is missing its" \

                    "config file"

                log_error "  Please create $VARIANT_CONFIG or unpublish the" \

                    "variant"

                log_error "  (by removing $OS_VARIANT from variants.list)"

            else

                log_error "Unofficial variant $OS_VARIANT is unsupported"

                log_error "Most probably this is a user error, forcing a" \

                    "wrong name"

                log_error "To support this variant please create file" \

                    "$VARIANT_CONFIG"

            fi

            exit 1

        fi

    fi

}

do_multistrap() {

   local target="$1"

   local cache="$2"

   local pkgs="$3"

    # Create preferences.d for apt

    mkdir -p "$target/etc/apt/preferences.d"

    if [ -d "$MULTISTRAP_APTPREFDIR" ]; then

        find "$MULTISTRAP_APTPREFDIR" -maxdepth 1 -type f -exec cp {} "$target/etc/apt/preferences.d" \;

    fi

    # Create a policy-rc.d file to deny init script execution

    mkdir -p "$target/usr/sbin"

    cat > "$target/usr/sbin/policy-rc.d" <<EOF

#!/bin/sh

exit 101

EOF

    chmod +x "$target/usr/sbin/policy-rc.d"

   multistrap -d "$target" -f "$MULTISTRAP_CONFIG" 2>&1 | sed -u -e 's/^/MULTISTRAP: /g'

   rm "$target/usr/sbin/policy-rc.d"

   rm -rf "$target/etc/apt/preferences.d"

}

report_and_cleanup() {

    send_errors

    cleanup

}

suppress_errors() {

    "$@" &> /dev/null || true

}

check_helper_rc() {

    local rc=$1

    if [ $rc -ne 0 ]; then

        if [ $rc -eq 124 ];  then

            log_error "Customization VM was terminated. Did not finish on time."

            report_error "Image customization failed. Did not finish on time."

        elif [ $rc -eq 137 ]; then # (128 + SIGKILL)

            log_error "Customization VM was killed. Did not finish on time."

            report_error "Image customization failed. Did not finish on time."

        elif [ $rc -eq 141 ]; then # (128 + SIGPIPE)

            log_error "Customization VM was terminated by a SIGPIPE."

            log_error "Maybe progress monitor has died unexpectedly."

        elif [ $rc -eq 125 ]; then

            log_error "Internal Error. Image customization could not start."

            log_error "timeout did not manage to run."

        else

            log_error "Customization VM died unexpectedly (return code $rc)."

        fi

        exit 1

    else

        report_info "Customization VM exited normally."

    fi

}

check_helper_result() {

   local result=$1

    if [ "x$result" != "xSUCCESS" ]; then

        log_error "Image customization failed."

        report_error "Image customization failed."

        exit 1

    fi

}

cleanup() {

    # if something fails here, it souldn't call cleanup again...

    trap - EXIT

    if [ ${#CLEANUP[*]} -gt 0 ]; then

        LAST_ELEMENT=$((${#CLEANUP[*]}-1))

        REVERSE_INDEXES=$(seq ${LAST_ELEMENT} -1 0)

        for i in $REVERSE_INDEXES; do

            # If something fails here, it's better to retry it for a few times

            # before we give up with an error. This is needed for kpartx when

            # dealing with ntfs partitions mounted through fuse. umount is not

            # synchronous and may return while the partition is still busy. A

            # premature attempt to delete partition mappings through kpartx on

            # a device that hosts previously mounted ntfs partition may fail

            # with errors like this one:

            # `device-mapper: remove ioctl failed: Device or resource busy'

            # A sensible workaround for this is to wait for a while and then

            # retry it.

            local cmd=${CLEANUP[$i]}

            $cmd || for interval in 0.25 0.5 1 2 4; do

            echo "Command $cmd failed!"

            echo "I'll wait for $interval secs and will retry..."

            sleep $interval

            $cmd && break

        done

        if [ "$?" != "0" ]; then

            echo "Giving Up..."

            exit 1;

        fi

    done

  fi

}

trap cleanup EXIT

DEFAULT_FILE="@sysconfdir@/default/snf-image"

if [ -f "$DEFAULT_FILE" ]; then

    . "$DEFAULT_FILE"

fi

: ${VARIANTS_DIR:="@sysconfdir@/ganeti/snf-image/variants"}

: ${IMAGE_DIR:="@localstatedir@/lib/snf-image"}

: ${IMAGE_DEBUG:="no"}

: ${VERSION_CHECK:="@VERSION_CHECK@"}

: ${HELPER_DIR:="@HELPER_DIR@"}

: ${HELPER_SIZE:="600"}

: ${HELPER_SOFT_TIMEOUT:=120}

: ${HELPER_HARD_TIMEOUT:=5}

: ${HELPER_USER:="nobody"}

: ${HELPER_MEMORY:="256"}

: ${PITHOS_DB:="sqlite:////@localstatedir@/lib/pithos/backend.db"}

: ${PITHOS_DATA:="@localstatedir@/lib/pithos/data/"}

: ${PROGRESS_MONITOR:="@PROGRESS_MONITOR@"}

: ${UNATTEND:="@UNATTEND@"}

: ${XEN_SCRIPTS_DIR="@sysconfdir@/xen/scripts"}

: ${MULTISTRAP_CONFIG:="@MULTISTRAP_CONFIG@"}

: ${MULTISTRAP_APTPREFDIR:="@MULTISTRAP_APTPREFDIR@"}

SCRIPT_NAME=$(basename $0)

# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :