clone_image.in 12.5 KB
Newer Older
1 2
#!/usr/bin/perl -w
#
3
# Copyright (c) 2000-2014 University of Utah and the Flux Group.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file 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 Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
23 24 25 26 27 28 29
#
use English;
use strict;
use Getopt::Std;
use Data::Dumper;
use File::Temp qw(tempfile);
use CGI;
30
use File::Basename;
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

#
# Clone an image (descriptor) from a node and then snapshot
# that node into the descriptor. Creates the descriptor if
# if it does not exist. The idea is to use all of the info
# from the current image descriptor that is loaded on the node
# to quickly create a new descriptor by inheriting all of the
# attributes of the original.
#
# We also want to support taking a snapshot of a previously
# created clone. To make everything work properly, require
# that the imagename exist in the experiment project, which
# ensures that we are operating on a clone, not an image in
# some other project or a system image.
#
sub usage()
{
    print("Usage: clone_image [-d] [-e] [-n | -s] <imagename> <node_id>\n".
	  "Options:\n".
	  "       -d     Turn on debug mode\n".
	  "       -e     Create a whole disk image\n".
52
	  "       -g 0,1 Override base image global setting\n".
53 54 55 56
	  "       -s     Create descriptor but do not snapshot\n".
	  "       -n     Impotent mode\n");
    exit(-1);
}
57
my $optlist     = "densg:";
58 59 60 61
my $debug       = 0;
my $wholedisk   = 0;
my $impotent    = 0;
my $nosnapshot  = 0;
62
my $isvirtnode  = 0;
63
my $global;
64 65 66 67 68 69

#
# Configure variables
#
my $TB           = "@prefix@";
my $PROJROOT     = "@PROJROOT_DIR@";
70
my $GROUPROOT    = "@GROUPSROOT_DIR@";
71 72
my $CREATEIMAGE  = "$TB/bin/create_image";
my $NEWIMAGEEZ   = "$TB/bin/newimageid_ez";
73
my $DOPROVENANCE = @IMAGEPROVENANCE@;
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120

#
# Untaint the path
#
$ENV{'PATH'} = "$TB/bin:$TB/sbin:/bin:/usr/bin:/usr/bin:/usr/sbin";
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Turn off line buffering on output
#
$| = 1;

#
# Load the Testbed support stuff.
#
use lib "@prefix@/lib";
use EmulabConstants;
use emutil;
use User;
use Project;
use Image;
use OSinfo;
use Node;

# Protos
sub fatal($);

#
# Parse command arguments. Once we return from getopts, all that should be
# left are the required arguments.
#
my %options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
if (defined($options{"d"})) {
    $debug = 1;
}
if (defined($options{"e"})) {
    $wholedisk = 1;
}
if (defined($options{"n"})) {
    $impotent = 1;
}
if (defined($options{"s"})) {
    $nosnapshot = 1;
}
121 122 123
if (defined($options{"g"})) {
    $global = $options{"g"};
}
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
usage()
    if (@ARGV != 2);

my $imagename = shift(@ARGV);
my $node_id   = shift(@ARGV);

#
# Map invoking user to object. 
#
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    fatal("You ($UID) do not exist!");
}

#
# The node must of course be allocated and the user must have
# permission to clone it. 
#
my $node = Node->Lookup($node_id);
if (!defined($node)) {
    fatal("No such node");
}
146 147
$isvirtnode = $node->isvirtnode();

148 149 150 151 152 153 154 155 156
if (!$node->AccessCheck($this_user, TB_NODEACCESS_LOADIMAGE())) {
    fatal("Not enough permission");
}
my $experiment = $node->Reservation();
if (!defined($experiment)) {
    fatal("Node is not reserved");
}
my $pid     = $experiment->pid();
my $group   = $experiment->GetGroup();
157
my $gid     = $group->gid();
158 159 160 161 162 163
my $project = $experiment->GetProject();
if (! (defined($project) && defined($group))) {
    fatal("Could not get project/group for $experiment");
}
my $image = Image->Lookup($project->pid(), $imagename);

164 165 166 167 168 169 170 171 172 173 174 175
#
# Need to look up the base image; the image that is currently running
# on the node and being cloned.
#
my ($base_osinfo, $base_image) = $node->RunningOsImage();
# No support for cloning MFSs, so there will always be a base image.
if (! (defined($base_osinfo) && defined($base_image))) {
    fatal("Could not determine osid/imageid for $node_id");
}
print "$node_id is running $base_osinfo,$base_image\n"
    if ($debug);

176 177 178 179 180
#
# The simple case is that the descriptor already exists. So it is just
# a simple snapshot to the image file. 
#
if (defined($image)) {
181 182
    my $needdelete = 0;
    
183 184 185 186 187 188
    #
    # Only EZ images via this interface.
    #
    if (!$image->ezid()) {
	fatal("Cannot clone a non-ez image");
    }
189 190 191 192 193 194 195 196 197

    #
    # But we do not allow emulab-ops images to be overwritten.
    # Might remove this later. Just being careful since this is going
    # to be used from the ProtoGENI RPC interface.
    #
    if ($image->pid eq TBOPSPID() && !$this_user->IsAdmin()) {
	fatal("Not allowed to snapshot a system image");
    }
198 199 200 201 202 203 204 205 206 207 208
    
    #
    # The access check above determines if the caller has permission
    # to overwrite the image file. 
    # Not that this matters, cause create_image is going to make the
    # same checks.
    #
    if ($impotent) {
	print "Not doing anything in impotent mode\n";
	exit(0);
    }
209 210 211 212 213 214 215 216 217 218 219 220 221

    #
    # We create a new version of the image descriptor for the new
    # snapshot. We mark it as not ready so that others know it is
    # in transition. When we later call createimage, it will make
    # sure the ready bit is clear before trying to lock it. 
    #
    # Before we do anything destructive, we lock the image.
    #
    if ($image->Lock()) {
	fatal("Image is locked, please try again later!\n");
    }
    if ($DOPROVENANCE) {
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
	#
	# Is the ready bit set? If not, it means something went wrong with
	# a previous image creation. Lets reset the provenance.
	#
	if (!$image->ready()) {
	    my $osinfo = OSinfo->Lookup($image->imageid());
	    if (!defined($osinfo)) {
		$image->Unlock();
		fatal("Cannot lookup osinfo for $image");
	    }
	    $image->SetProvenance($base_image);
	    $osinfo->SetProvenance($base_osinfo);
	}
	else {
	    my $clone_error;
	    my $clone = $image->NewVersion($this_user,
					   $base_image, undef, \$clone_error);
	    if (!defined($clone)) {
		$image->Unlock();
		fatal("Could not clone image descriptor" .
		      (defined($clone_error) ? ": $clone_error" : "") . "\n");
	    }
	    $image = $clone;
	    $needdelete = 1;

	    #
	    # Watch for a system image that is saved elsewhere; see equiv code
	    # in create_image. We change the path to point over to the /proj
	    # directory so that we do not burn up space on boss until it is
	    # officially "released". We can also use this version of the image
	    # by explicitly using its version number, before it is released. 
	    #
	    if ($image->path() =~ /^\/usr\/testbed/) {
		my $path = $PROJROOT . "/" . $image->pid() . "/images/" .
		    basename($image->path()) . ":" . $image->version();

		if ($image->Update({"path" => $path, "released" => 0})) {
		    $image->DeleteVersion();
		    fatal("Could not update path and ready bit");
		}
	    }
263 264 265 266
	}
    }
    $image->Unlock();
    
267
    if ($nosnapshot) {
268 269
	print "Not taking a snapshot, as directed\n"
	    if ($debug);
270 271 272 273 274
	exit(0);
    }

    my $output = emutil::ExecQuiet("$CREATEIMAGE -p $pid $imagename $node_id");
    if ($?) {
275
	if ($DOPROVENANCE) {
276 277
	    $image->DeleteVersion()
		if ($needdelete);
278
	}
279 280 281 282 283 284
	print STDERR $output;
	fatal("Failed to create image");
    }
    print "Image is being created. This can take 15-30 minutes.\n";
    exit(0);
}
285
DoNew:
286 287

#
288
# Only EZ images via this interface.
289
#
290 291 292 293 294 295 296 297 298 299
if (!$base_image->ezid()) {
    fatal("Cannot clone a non-ez image");
}

#
# To avoid confusion, we do not allow users to shadow system images
# in their own project. 
#
if (Image->LookupByName($imagename) && !$this_user->IsAdmin()) {
    fatal("Not allowed to shadow snapshot a system image");
300 301
}

302 303 304 305 306
# Subgroups change the path
my $path = ($experiment->pid() eq $experiment->gid() ?
	    "$PROJROOT/$pid/images/${imagename}.ndz" :
	    "$GROUPROOT/$pid/$gid/images/${imagename}.ndz");

307 308 309 310 311 312 313 314 315 316 317 318
#
# Create the image descriptor. We use the backend script to do the
# heavy lifting, but we have to cons up an XML file based on the image
# descriptor that is being cloned.
#
# These are the fields we have to come up with, plus a number
# of mtype_* entries.
#
my %xmlfields =
    ("imagename"	=> $imagename,
     "pid"		=> $project->pid(),
     "gid"		=> $experiment->gid(),
319
     "description"	=> $base_osinfo->description(),
320 321
     "OS"		=> $base_osinfo->OS(),
     "version"		=> $base_osinfo->version(),
322
     "path"		=> $path,
323
     "op_mode",		=> $base_osinfo->op_mode(),
324 325
     "global"           => (defined($global) ?
			    ($global ? 1 : 0) : $base_osinfo->shared()),
326
     "wholedisk",	=> $wholedisk,
327
);
Leigh B Stoller's avatar
Leigh B Stoller committed
328 329
$xmlfields{"reboot_waittime"} = $base_osinfo->reboot_waittime()
    if (defined($base_osinfo->reboot_waittime()));
330 331 332
$xmlfields{"osfeatures"} = $base_osinfo->osfeatures()
    if (defined($base_osinfo->osfeatures()) &&
	$base_osinfo->osfeatures() ne "");
Leigh B Stoller's avatar
Leigh B Stoller committed
333
    
334 335
if (defined($base_image)) {
    $xmlfields{"mbr_version"}     = $base_image->mbr_version();
336
    $xmlfields{"loadpart"}        = $base_image->loadpart();
337
    $xmlfields{"noexport"}        = $base_image->noexport();
338 339
    $xmlfields{"global"}          = (defined($global) ?
				     ($global ? 1 : 0) : $base_image->global());
340 341 342 343 344 345 346 347 348

    # Short form uses wholedisk instead. Should fix this. 
    if ($base_image->loadpart() == 0 && $base_image->loadlength() == 4) {
	$xmlfields{"loadpart"}    = 1;
	$xmlfields{"wholedisk"}   = 1;
    }
    elsif ($wholedisk) {
	$xmlfields{"loadpart"}    = 1;
    }
349 350 351 352 353 354 355 356 357 358 359
}
elsif ($isvirtnode) {
    $xmlfields{"reboot_waittime"} = 240;
    $xmlfields{"loadpart"}        = 1;
    $xmlfields{"mtype_pcvm"}      = 1;
    $xmlfields{"wholedisk"}       = 1;
}
else {
    fatal("No base image for $node_id");
}
# This needs more thought.
360
if (($isvirtnode || $base_osinfo) && $base_osinfo->def_parentosid()) {
361 362 363 364
    my $parentosinfo = OSinfo->Lookup($base_osinfo->def_parentosid());
    if (!defined($parentosinfo)) {
	fatal("Could not lookup object for parent osid of $base_osinfo");
    }
365
    $xmlfields{"def_parentosid"} =
366
	$parentosinfo->pid() . "," . $parentosinfo->osname();
367 368

    # And this is just plain bogus. 
369
    #$xmlfields{"mbr_version"} = 99;
370
}
371 372 373 374

#
# Grab the existing type list and generate new mtype_* variables.
#
375 376 377 378 379 380 381
if (defined($base_image)) {
    my @typelist = $base_image->TypeList($base_osinfo);
    if (! @typelist) {
	fatal("$base_image does not run on any types");
    }
    foreach my $type (@typelist) {
	my $type_id = $type->type();
382
    
383 384
	$xmlfields{"mtype_${type_id}"} = 1;
    }
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
}

#
# Create the XML file to pass to newimageid_ez.
#
my ($fh, $filename) = tempfile(UNLINK => 1);
fatal("Could not create temporary file")
    if (!defined($fh));

print $fh "<image>\n";
foreach my $key (keys(%xmlfields)) {
    my $value = $xmlfields{$key};

    print $fh "<attribute name=\"$key\">";
    print $fh "<value>" . CGI::escapeHTML($value) . "</value>";
    print $fh "</attribute>\n";
}
print $fh "</image>\n";
close($fh);

405 406 407 408 409
if ($debug) {
    system("/bin/cat $filename");
}

my $output = emutil::ExecQuiet("$NEWIMAGEEZ -s -v $filename");
410 411
if ($?) {
    print STDERR $output;
412 413
    my $foo = `cat $filename`;
    print STDERR $foo;
414 415 416 417 418 419 420
    fatal("Failed to verify image descriptor from $filename");
}
if ($impotent) {
    print "Not doing anything in impotent mode\n";
    system("cat $filename");
    exit(0);
}
421
$output = emutil::ExecQuiet("$NEWIMAGEEZ -s $filename");
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
if ($?) {
    print STDERR $output;
    my $foo = `cat $filename`;
    print STDERR $foo;
    fatal("Failed to create image descriptor");
}

$image = Image->Lookup($project->pid(), $imagename);
if (!defined($image)) {
    fatal("Cannot lookup newly created image for $imagename");
}
my $osinfo = OSinfo->Lookup($image->imageid());
if (!defined($osinfo)) {
    fatal("Cannot lookup newly created osinfo for $image");
}
437 438 439 440
if ($DOPROVENANCE) {
    $image->SetProvenance($base_image);
    $osinfo->SetProvenance($base_osinfo);
}
441 442 443 444 445
if ($debug) {
    print "Created $osinfo\n";
    print "Created $image\n";
}
if ($nosnapshot) {
446 447
    print "Not taking a snapshot, as directed\n"
	if ($debug);
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
    exit(0);
}
$output = emutil::ExecQuiet("$CREATEIMAGE -p $pid $imagename $node_id");
if ($?) {
    print STDERR $output;
    fatal("Failed to create image");
}
print "Image is being created. This can take 15-30 minutes.\n";
exit(0);

sub fatal($)
{
    my ($mesg) = @_;

    die("*** $0:\n".
	"    $mesg\n");
}