code.grnet.gr Git - snf-image/blob - snf-image-host/common.sh.in

   1 # Copyright (C) 2011 GRNET S.A.
   2 # Copyright (C) 2007, 2008, 2009 Google Inc.
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 2 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17 # 02110-1301, USA.
  18
  19 AWK="awk"
  20 KPARTX="kpartx"
  21 LOSETUP="losetup"
  22 SFDISK="sfdisk"
  23 QEMU_IMG="qemu-img"
  24 INSTALL_MBR="install-mbr"
  25 TIMEOUT="timeout"
  26 CURL="curl"
  27
  28 # Temporary use stderr as monitoring file descriptor.
  29 # `create' will overwrite this
  30 MONITOR_FD="2"
  31
  32 network_backend_support="@network_backend_support@"
  33
  34 MSG_TYPE_ERROR="image-error"
  35 MSG_TYPE_INFO="image-info"
  36
  37 CLEANUP=( )
  38 ERROR_MSGS=( )
  39
  40
  41 add_cleanup() {
  42     local cmd=""
  43     for arg; do cmd+=$(printf "%q " "$arg"); done
  44     CLEANUP+=("$cmd")
  45 }
  46
  47 log_error() {
  48     ERROR_MSGS+=("$@")
  49     echo "$*" >&2
  50 }
  51
  52
  53 log_info() {
  54     echo "$*" >&2
  55
  56     local report="$(./host-monitor.py info <<< "$*")"
  57
  58     eval "echo $(printf "%q" "$report") >&${MONITOR_FD}"
  59 }
  60
  61
  62 close_fd() {
  63     local fd="$1"
  64     exec {fd}>&-
  65 }
  66
  67 report_error() {
  68     local error_file=$1
  69     local report=""
  70     if [ ${#ERROR_MSGS[@]} -gt 0 ]; then
  71         local msg=""
  72         for err in "${ERROR_MSGS[@]}"; do
  73             msg+="$(echo "$err")"
  74         done
  75         report="$(./host-monitor.py error <<< "$msg")"
  76     else
  77         report=$(tail -10 "$error_file" | ./host-monitor.py stderr)
  78     fi
  79
  80     eval "echo $(printf "%q" "$report") >&${MONITOR_FD}"
  81 }
  82
  83 get_api5_arguments() {
  84     GETOPT_RESULT=$*
  85     # Note the quotes around `$TEMP': they are essential!
  86     eval set -- "$GETOPT_RESULT"
  87     while true; do
  88         case "$1" in
  89             -i|-n) instance=$2; shift 2;;
  90
  91             -o) old_name=$2; shift 2;;
  92
  93             -b) blockdev=$2; shift 2;;
  94
  95             -s) swapdev=$2; shift 2;;
  96
  97             --) shift; break;;
  98
  99             *)  log_error "Internal error!" >&2; exit 1;;
 100         esac
 101     done
 102     if [ -z "$instance" -o -z "$blockdev" ]; then
 103         log_error "Missing OS API Argument (-i, -n, or -b)"
 104         exit 1
 105     fi
 106     if [ "$SCRIPT_NAME" != "export" -a -z "$swapdev"  ]; then
 107         log_error "Missing OS API Argument -s (swapdev)"
 108         exit 1
 109     fi
 110     if [ "$SCRIPT_NAME" = "rename" -a -z "$old_name"  ]; then
 111         log_error "Missing OS API Argument -o (old_name)"
 112         exit 1
 113     fi
 114 }
 115
 116 get_api10_arguments() {
 117     if [ -z "$INSTANCE_NAME" -o -z "$HYPERVISOR" -o -z "$DISK_COUNT" ]; then
 118         log_error "Missing OS API Variable:"
 119         log_error "(INSTANCE_NAME HYPERVISOR or DISK_COUNT)"
 120         exit 1
 121     fi
 122     instance=$INSTANCE_NAME
 123     if [ $DISK_COUNT -lt 1 -o -z "$DISK_0_PATH" ]; then
 124         log_error "At least one disk is needed"
 125         exit 1
 126     fi
 127     if [ "$SCRIPT_NAME" = "export" ]; then
 128         if [ -z "$EXPORT_DEVICE" ]; then
 129             log_error "Missing OS API Variable EXPORT_DEVICE"
 130         fi
 131         blockdev=$EXPORT_DEVICE
 132     elif [ "$SCRIPT_NAME" = "import" ]; then
 133         if [ -z "$IMPORT_DEVICE" ]; then
 134         log_error "Missing OS API Variable IMPORT_DEVICE"
 135         fi
 136         blockdev=$IMPORT_DEVICE
 137     else
 138         blockdev=$DISK_0_PATH
 139     fi
 140     if [ "$SCRIPT_NAME" = "rename" -a -z "$OLD_INSTANCE_NAME" ]; then
 141         log_error "Missing OS API Variable OLD_INSTANCE_NAME"
 142     fi
 143     old_name=$OLD_INSTANCE_NAME
 144 }
 145
 146 get_api20_arguments() {
 147     get_api10_arguments
 148     if [ -z "$OSP_IMG_ID" ]; then
 149         log_error "Missing OS API Parameter: OSP_IMG_ID"
 150         exit 1
 151     fi
 152     if [ -z "$OSP_IMG_FORMAT" ]; then
 153         log_error "Missing OS API Parameter: OSP_IMG_FORMAT"
 154         exit 1
 155     fi
 156     if [ -z "$OSP_IMG_PASSWD" ]; then
 157         log_error "Missing OS API Parameter: OSP_IMG_PASSWD"
 158         exit 1
 159     fi
 160
 161     IMG_ID=$OSP_IMG_ID
 162     IMG_FORMAT=$OSP_IMG_FORMAT
 163     IMG_PASSWD=$OSP_IMG_PASSWD
 164     if [ -n "$OSP_IMG_PROPERTIES" ]; then
 165         IMG_PROPERTIES="$OSP_IMG_PROPERTIES"
 166     fi
 167     if [ -n "$OSP_IMG_PERSONALITY" ]; then
 168         IMG_PERSONALITY="$OSP_IMG_PERSONALITY"
 169     fi
 170 }
 171
 172 map_disk0() {
 173     blockdev="$1"
 174     filesystem_dev_base=$($KPARTX -l -p- $blockdev | \
 175                             grep -m 1 -- "-1.*$blockdev" | \
 176                             $AWK '{print $1}')
 177     if [ -z "$filesystem_dev_base" ]; then
 178         log_error "Cannot interpret kpartx output and get partition mapping"
 179         exit 1
 180     fi
 181     $KPARTX -a -p- "$blockdev" > /dev/null
 182     filesystem_dev="/dev/mapper/${filesystem_dev_base/%-1/}"
 183     if [ ! -b "/dev/mapper/$filesystem_dev_base" ]; then
 184         log_error "Can't find kpartx mapped partition:" \
 185                                             "/dev/mapper/$filesystem_dev_base"
 186         exit 1
 187     fi
 188     echo "$filesystem_dev"
 189 }
 190
 191 unmap_disk0() {
 192     $KPARTX -d -p- "$1"
 193 }
 194
 195 format_disk0() {
 196     local device="$1"
 197     local image_type="$2"
 198
 199     declare -A part_id=( ['extdump']="83" ["ntfsdump"]="7" )
 200
 201     # The -f is needed, because we use an optimal alignment and sfdisk complains
 202     # about partitions not ending on clylinder boundary.
 203     local sfdisk_cmd="$SFDISK -uS -H 255 -S 63 -f --quiet --Linux --DOS $device"
 204
 205     $sfdisk_cmd > /dev/null <<EOF
 206 2048,,${part_id["$image_type"]},*
 207 EOF
 208 }
 209
 210 create_floppy() {
 211     local img=$1
 212
 213     local target=$(mktemp -d)
 214     add_cleanup rmdir "$target"
 215
 216     dd bs=512 count=2880 if=/dev/zero of="$img"
 217     mkfs.ext2 -F "$img" > /dev/null
 218     mount "$img" "$target" -o loop
 219     set | egrep ^snf_export_\\w+= | sed -e 's/^snf_export_/export SNF_IMAGE_/' \
 220         > "$target/rules"
 221     if [ -n "$UNATTEND" ]; then
 222         if [ -f "$UNATTEND" ]; then
 223             cat "$UNATTEND" > "$target/unattend.xml"
 224         else
 225             log_error "Unattend file: \`"$UNATTEND"' does not exist"
 226         fi
 227     fi
 228     umount "$target"
 229 }
 230
 231 get_backend_type() {
 232     local id=$1
 233
 234     if [[ "$id" =~ ^pithos: ]]; then
 235         echo "pithos"
 236     elif [[ "$id" =~ ^(http|ftp)s?: ]]; then
 237         if [ "$network_backend_support" = "yes" ]; then
 238             echo "network";
 239         else
 240             log_error "Retrieving images from the network is not supported."
 241             exit 1
 242         fi
 243     elif [ "$id" = "null" ]; then
 244         echo "null"
 245     else
 246         echo "local"
 247     fi
 248 }
 249
 250 # this one is only to be called by create
 251 ganeti_os_main() {
 252     if [ -z "$OS_API_VERSION" -o "$OS_API_VERSION" = "5" ]; then
 253         OS_API_VERSION=5
 254         GETOPT_RESULT=`getopt -o o:n:i:b:s: -n '$0' -- "$@"`
 255         if [ $? != 0 ] ; then log_error "Terminating..."; exit 1 ; fi
 256         get_api5_arguments $GETOPT_RESULT
 257     elif [ "$OS_API_VERSION" = "10" -o "$OS_API_VERSION" = "15" ]; then
 258         get_api10_arguments
 259     elif [ "$OS_API_VERSION" = "20" ]; then
 260         get_api20_arguments
 261         IMAGE_NAME="$IMG_ID"
 262         IMAGE_TYPE="$IMG_FORMAT"
 263         BACKEND_TYPE=$(get_backend_type $IMG_ID)
 264     else
 265         log_error "Unknown OS API VERSION $OS_API_VERSION"
 266         exit 1
 267     fi
 268
 269     if [ -n "$OS_VARIANT" ]; then
 270         if [ ! -d "$VARIANTS_DIR" ]; then
 271             log_error "OS Variants directory $VARIANTS_DIR doesn't exist"
 272             exit 1
 273         fi
 274         VARIANT_CONFIG="$VARIANTS_DIR/$OS_VARIANT.conf"
 275         if [ -f "$VARIANT_CONFIG" ]; then
 276             . "$VARIANT_CONFIG"
 277         else
 278             if grep -qxF "$OS_VARIANT" variants.list; then
 279                 log_error "ERROR: instance-image configuration error"
 280                 log_error "  Published variant $OS_VARIANT is missing its" \
 281                     "config file"
 282                 log_error "  Please create $VARIANT_CONFIG or unpublish the" \
 283                     "variant"
 284                 log_error "  (by removing $OS_VARIANT from variants.list)"
 285             else
 286                 log_error "Unofficial variant $OS_VARIANT is unsupported"
 287                 log_error "Most probably this is a user error, forcing a" \
 288                     "wrong name"
 289                 log_error "To support this variant please create file" \
 290                     "$VARIANT_CONFIG"
 291             fi
 292             exit 1
 293         fi
 294     fi
 295
 296 }
 297
 298 do_debootstrap() {
 299     local target="$1"
 300
 301     echo "Debootstraping to create a new root filesystem:"
 302
 303     # Create a policy-rc.d file to deny init script execution
 304     mkdir -p "$target/usr/sbin"
 305     cat > "$target/usr/sbin/policy-rc.d" <<EOF
 306 #!/bin/sh
 307 exit 101
 308 EOF
 309     chmod +x "$target/usr/sbin/policy-rc.d"
 310
 311     debootstrap --arch $(dpkg --print-architecture) \
 312         --include "$HELPER_EXTRA_PKGS" --variant=minbase stable "$target" \
 313         "$HELPER_MIRROR" 2>&1 | sed -e 's/^/DEBOOTSTRAP: /g'
 314
 315     # Save the package list
 316     chroot "$target" dpkg-query -W -f "\${Package}\n" > "$HELPER_CACHE_PKGS"
 317
 318     rm "$target/usr/sbin/policy-rc.d"
 319
 320     # remove the downloaded debs, as they are no longer needed
 321     find "$target/var/cache/apt/archives" -type f -name '*.deb' -print0 | \
 322         xargs -r0 rm -f
 323
 324     local tmp_cache=$(mktemp "$CACHE_FILE.XXXXXX")
 325     tar cf "$tmp_cache" --one-file-system -C "$target" . || \
 326         { rm "$tmp_cache"; false; }
 327     # Overwrite the default cache file. Not the user specified if present.
 328     mv -f "$tmp_cache" "$HELPER_CACHE_FILE"
 329 }
 330
 331 report_and_cleanup(){
 332
 333     local err_file="$1"
 334
 335     report_error "$err_file"
 336     cleanup
 337 }
 338
 339 cleanup() {
 340     # if something fails here, it souldn't call cleanup again...
 341     trap - EXIT
 342
 343     if [ ${#CLEANUP[*]} -gt 0 ]; then
 344         LAST_ELEMENT=$((${#CLEANUP[*]}-1))
 345         REVERSE_INDEXES=$(seq ${LAST_ELEMENT} -1 0)
 346         for i in $REVERSE_INDEXES; do
 347             # If something fails here, it's better to retry it for a few times
 348             # before we give up with an error. This is needed for kpartx when
 349             # dealing with ntfs partitions mounted through fuse. umount is not
 350             # synchronous and may return while the partition is still busy. A
 351             # premature attempt to delete partition mappings through kpartx on
 352             # a device that hosts previously mounted ntfs partition may fail
 353             # with errors like this one:
 354             # `device-mapper: remove ioctl failed: Device or resource busy'
 355             # A sensible workaround for this is to wait for a while and then
 356             # retry it.
 357             local cmd=${CLEANUP[$i]}
 358             $cmd || for interval in 0.25 0.5 1 2 4; do
 359             echo "Command $cmd failed!"
 360             echo "I'll wait for $interval secs and will retry..."
 361             sleep $interval
 362             $cmd && break
 363         done
 364         if [ "$?" != "0" ]; then
 365             echo "Giving Up..."
 366             exit 1;
 367         fi
 368     done
 369   fi
 370 }
 371
 372 trap cleanup EXIT
 373
 374 DEFAULT_FILE="@sysconfdir@/default/snf-image"
 375 if [ -f "$DEFAULT_FILE" ]; then
 376     . "$DEFAULT_FILE"
 377 fi
 378
 379 : ${VARIANTS_DIR:="@sysconfdir@/ganeti/snf-image/variants"}
 380 : ${IMAGE_DIR:="@localstatedir@/lib/snf-image"}
 381 : ${HELPER_DIR:="@HELPER_DIR@"}
 382 : ${HELPER_IMG:="@HELPER_IMG@"}
 383 : ${HELPER_KERNEL:="@HELPER_KERNEL@"}
 384 : ${HELPER_INITRD:="@HELPER_INITRD@"}
 385 : ${HELPER_PKG:="@HELPER_DIR@/snf-image-helper.deb"}
 386 : ${HELPER_SOFT_TIMEOUT:=20}
 387 : ${HELPER_HARD_TIMEOUT:=5}
 388 : ${HELPER_USER:="nobody"}
 389 : ${HELPER_CACHE_FILE:="@HELPER_DIR@/cache.tar"}
 390 : ${HELPER_CACHE_PKGS:="@HELPER_DIR@/packages"}
 391 : ${HELPER_EXTRA_PKGS:="iproute,socat,xenstore-utils,e2fsprogs,ntfs-3g,ntfsprogs,xmlstarlet,python,parted,reglookup,chntpw,util-linux"}
 392 : ${HELPER_LINUX_IMAGE_PKG:="linux-image-amd64"}
 393 : ${HELPER_LINUX_IMAGE_XEN_PKG:="linux-image-xen-amd64"}
 394 : ${HELPER_MIRROR:=""}
 395 : ${PITHOS_DB:="sqlite:////@localstatedir@/lib/pithos/backend.db"}
 396 : ${PITHOS_DATA:="@localstatedir@/lib/pithos/data/"}
 397 : ${PROGRESS_MONITOR:="@PROGRESS_MONITOR@"}
 398 : ${UNATTEND:="@UNATTEND@"}
 399
 400 case $HYPERVISOR in
 401     xen-hvm|xen-pvm) . xen-common.sh ;;
 402     kvm) . kvm-common.sh ;;
 403 esac
 404
 405 SCRIPT_NAME=$(basename $0)
 406
 407 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :