1
0
mirror of synced 2026-01-21 01:48:09 +00:00
xen-tools.xen-tools/bin/xen-create-image
steve 7bbf7be9df 2007-09-01 19:22:37 by steve
Make explicit notice of the invalid *-cmd flags.
2007-09-01 19:22:37 +00:00

3455 lines
82 KiB
Perl
Executable File

#!/usr/bin/perl -w
=head1 NAME
xen-create-image - Easily create new Xen instances with networking and OpenSSH.
=cut
=head1 SYNOPSIS
Help Options:
--help Show the help information for this script.
--manual Read the manual, and examples, for this script.
--verbose Show useful debugging information.
--version Show the version number and exit.
Size / General options:
--accounts Copy all non-system accounts to the guest image
--admins Specify that some administrators should be created for
this image, using xen-shell.
--boot Boot the new instance after creating it.
--cache Cache .deb files on the host when installing the new guest
with the debootstrap tool.
--config Read the specified file in addition to the global
configuration file.
--copy-cmd NOP: Ignored.
--debootstrap-cmd NOP: Ignored.
--force Force overwriting existing images.
This will remove existing images or LVM volumes which match
those which are liable to be used by the new invocation.
--fs Specify the filesystem type to use for the new guest.
Valid choices are 'ext2', 'ext3', 'reiserfs', or 'xfs'.
--image Specify whether to create "sparse" or "full" disk images.
Full images are mandatory when using LVM, so this setting
is ignored in that case.
--image-dev Specify a physical/logical volume for the disk image.
--initrd Specify the initial ramdisk
If an image is specified it must exist.
--keep Don't delete our images if installation fails.
--kernel Set the path to the kernel to use for domU.
If a kernel is specified it must exist.
--memory Setup the amount of memory allocated to the new instance.
--modules Set the path to the kernel modules to use for domU.
If modules are specified they must exist.
--install Specify whether to install the guest system or not.
--hooks Specify whether to run hooks after the image is created.
--partitions Use a specific partition layout configuration file.
Not supported with the image-dev and swap-dev options.
Parameters fs, size, swap and noswap are ignored when
using this option.
--passwd Ask for a root password during setup.
NOTE: This is done interactively.
--role Run a specific role command post-install.
These role scripts are discussed later in this manpage.
--role-args Pass the named string literally to any role script.
This is useful for site-specific roles.
--roledir Specify the directory which contains the role scripts.
This defaults to /etc/xen-tools/role.d/
--size Set the size of the primary disk image.
--tar-cmd NOP: Ignored.
--swap Set the size of the swap partition.
--swap-dev Specify a physical/logical volume for swap usage.
--noswap Do not create a swap partition.
When this option is used the system will not have a swap
entry added to its /etc/fstab file either.
--ide Use IDE names for virtual devices (i.e. hda not sda)
Installation options:
--arch Pass the given architecture to debootstrap, rinse,
or rpmstrap when installing the system. This argument
is ignored for other install methods.
--dist Specify the distribution you wish to install.
--install-method Specify the installation method to use.
--install-source Specify the source path to use when installing via
a copy or tarball installation.
--mirror Setup the mirror to use when installing via debootstrap.
--template Specify which template file to use when creating the
Xen configuration file.
Networking options:
--dhcp The guest will be configured to fetch its networking
details via DHCP.
--gateway Setup the network gateway for the new instance.
--ip Setup the IP address of the machine, multiple IPs
are allowed. When specifying more than one IP the
first one is setup as the "system" IP, and the additional
ones are added as aliases.
Note that Xen 3.x supports a maximum of three vif statements
per guest.
This option conflicts with --dhcp.
--mac Specify the MAC address to use for a given interface.
This is only valid for the first IP address specified, or
for DHCP usage. (ie. you can add multiple --ip flags,
but the specific MAC address will only be used for the
first interface.)
--netmask Setup the netmask for the new instance.
--broadcast Setup the broadcast address for the new instance.
Mandatory options:
--dir Specify where the output images should go.
Subdirectories will be created for each guest
If you do not wish to use loopback images specify --lvm
or --evms. (These three options are mutually exclusive.)
--lvm Specify the volume group to save images within.
If you do not wish to use LVM specify --dir or --evms.
(These three options are mutually exclusive.)
--evms Specify the container to save images within, i.e. '--evms
lvm2/mycontainer'. If you do not wish to use EVMS specify
--dir or --lvm. (These three options are mutually exclusive.)
--hostname Set the hostname of the new guest system.
Ideally this will be fully-qualified since several
of the hook scripts will expect to be able to parse
a domain name out of it for various purposes.
=cut
=head1 NOTES
This script is a wrapper around three distinct external tools which
complete various aspects of the new system installation.
=over 8
=item B<xt-install-image>
Install a new distribution.
=item B<xt-customize-image>
Run a collection of hook scripts to customise the freshly installed system.
=item B<xt-create-xen-config>
Create a configuration file in /etc/xen so that xm can create the new image.
=back
The result of invoking these three scripts, and some minor glue between
them, is a simple means of creating new Xen guest domains.
=cut
=head1 DESCRIPTION
xen-create-image is a simple script which allows you to create new
Xen instances easily. The new image will be given two volumes. These
volumes will be stored upon the host as either loopback files, or
LVM logical volumes:
1. An image for the systems root disk.
2. An image for the systems swap device.
The new virtual installations will be configured with networking,
have OpenSSH installed upon it, and have most of its basic files
setup correctly.
If you wish you can configure arbitary partitioning schemes, rather
than being restricted to just the two standard volumes. For more
details on this please see the later section in this manual "PARTITIONING".
=cut
=head1 CONFIGURATION
To reduce the length of the command line each of the supported options
may be specified inside a configuration file.
The global configuration file read for options is:
/etc/xen-tools/xen-tools.conf
The configuration file may contain comments which begin with the
hash '#' character. Otherwise the format is 'key = value'.
A sample configuration file would look like this:
=for example begin
#
# Output directory. Images are stored beneath this directory, one
# subdirectory per hostname.
#
dir = /home/xen
#
# LVM users should disable the 'dir' setting above, and instead
# specify the name of the volume group to use.
#
# lvm = myvolume
#
# EVMS users should disable the dir setting above and instead specify
# a container. For example, if you have an lvm2 container named box,
# put lvm2/box. This is how it is named in the evms interface.
#
# Warning... this has not been tested with anything but lvm2 but should
# be generalizable.
#
# evms= lvm2/myvolume
#
# Disk and Sizing options.
#
size = 2Gb # Disk image size.
image = full # Allocate the full disk size immediately.
memory = 128Mb # Memory size
swap = 128Mb # Swap size
fs = ext3 # use EXT3 filesystems
dist = sarge # Default distribution to install.
#
# Kernel options.
#
kernel = /boot/vmlinuz-`uname -r`
initrd = /boot/initrd.img-`uname -r`
#
# Networking options.
#
gateway = 192.168.1.1
broadcast = 192.168.1.255
netmask = 255.255.255.0
#
# Installation method:
# One of "copy", "debootstrap", "rinse", "rpmstrap", or "tar".
#
install-method = debootstrap
=for example end
Using this configuration file a new image may be created with the
following command:
xen-create-image --hostname=vm03.my.flat --ip=192.168.1.201
This makes use of loopback images stored beneath /home/xen and
will be installed via the debootstrap command.
=cut
=head1 NETWORKING AUTO-SETUP
We've already seen how the "gateway" and "netmask" options can
be used to specify the networking options of the freshly created
Xen guests.
One other shortcut is the use of an auto-incrementing IP addresses.
If you specify the IP address of the guest as only the initial
three octets (ie. 1.2.3, rather than 1.2.3.4) then the last
octet will be automatically incremented - and stored for future
use.
The last octet in use will be created in the text file
/etc/xen-tools/ips.txt.
For example if you wanted to create new Xen instances occupying
the IP address range 192.168.1.200+ then you would run:
=for example start
echo "200" > /etc/xen-tools/ips.txt
=for example end
Future creations would then simply use:
=for example start
xen-create-image --ip=192.168.1 --hostname=blah [--dist=...]
=for example end
The first time this ran the machine would recieve the IP address
192.168.1.200. The next time it ran the new image would receive
192.168.1.201, etc. (You could specify "ip = 192.168.1" in the
configuration file; meaning the only mandatory argument would be
the hostname of the new instance.)
Note: There is no facility to "wrap around".
=cut
=head1 PARTITIONING
By default all new guests are created with two "volumes", one
for the root filesystem and one for the new system's swap.
If you wish you may specify an alternative partitioning scheme.
Simply create a file inside the directory /etc/xen-tools/partitions.d/
specifying your partition layout. (Use the existing file "sample-server"
as a template).
Now when you create a new image specify the name of this file with as
an argument to the --partition option.
=cut
=head1 XEN CONFIGURATION FILE
Once a new image has been created an appropriate configuration file
for Xen will be saved in the directory /etc/xen.
The configuration file is built up using the template file
/etc/xen-tools/xm.tmpl - which is a file processed via
the Text::Template perl module.
If you wish to modify the files which are generated please make your
changes to that input file.
Alternatively you can create multiple configuration files and
specify the one to use with the --template option.
=cut
=head1 LOOPBACK EXAMPLES
The following will create a 2Gb disk image, along with a 128Mb
swap file with Debian Sarge setup and running via DHCP.
xen-create-image --size=2Gb --swap=128Mb --dhcp \
--dir=/home/xen --hostname=vm01.my.flat
This next example sets up a host which has the name 'vm02.my.flat' and
IP address 192.168.1.200, with the gateway address of 192.168.1.1
xen-create-image --size=2Gb --swap=128Mb \
--ip=192.168.1.200 \
--netmask=255.255.255.0
--gateway=192.168.1.1 \
--dir=/home/xen --hostname=vm02.my.flat
The directory specified for the output will be used to store the volumes
which are produced. To avoid clutter each host will have its images
stored beneath the specified directory, named after the hostname.
For example the images created above will be stored as:
$dir/domains/vm01.my.flat/
$dir/domains/vm01.my.flat/disk.img
$dir/domains/vm01.my.flat/swap.img
$dir/domains/vm02.my.flat/
$dir/domains/vm02.my.flat/disk.img
$dir/domains/vm02.my.flat/swap.img
The '/domains/' subdirectory will be created if necessary.
=cut
=head1 LVM EXAMPLE
If you wish to use an LVM volume group instead of a pair of loopback
images as shown above you can instead use the --lvm argument to
specify one.
xen-create-image --size=2Gb --swap=128Mb --dhcp \
--lvm=myvolumegroup --hostname=vm01.my.flat
The given volume group will have two new logical volumes created within it:
${hostname}-swap
${hostname}-disk
The disk image may be mounted, as you would expect, with the following
command:
mkdir -p /mnt/foo
mount /dev/myvolumegroup/vm01.my.flat-disk /mnt/foo
=cut
=head1 EVMS EXAMPLE
If you wish to use an EVMS storage container instead of a pair of loopback
images as shown above you can instead use the --evms argument to
specify one. The below example assumes an lvm2 container.
xen-create-image --size=2Gb --swap=128Mb --dhcp \
--evms=lvm2/myvolumegroup --hostname=vm01.my.flat
The given storage container will have two new EVMS volumes created within it:
${hostname}-swap
${hostname}-disk
The disk image may be mounted, as you would expect, with the following
command:
mkdir -p /mnt/foo
mount /dev/evms/vm01.my.flat-disk /mnt/foo
=cut
=head1 INSTALLATION METHODS
The new guest images may be installed in several different ways:
1. Using the debootstrap command, which must be installed and present.
2. Using the rpmstrap command, which must be installed and present.
3. using the rinse command, which must be installed and present.
4. By copying an existing installation.
5. By untarring a file containing a previous installation.
These different methods can be selected by either the command line
arguments, or settings in the configuration file. Only one installation
method may be specified at a time; they are mutually-exclusive.
=cut
=head1 INSTALLATION SPEEDUPS
After performing your first installation you can customize it, or
use it untouched, as a new installation source. By doing this you'll
achieve a significant speedup, even above using the debootstrap caching
support.
There are two different ways you can use the initial image as source
for a new image:
1. By tarring it up and using the tar-file as an installation source.
2. By mounting the disk image of the first system and doing a literal copy.
Tarring up a pristine, or customised, image will allow you to install
with a command such as:
xen-create-image --size=2Gb --swap=128Mb --dhcp \
--lvm=myvolumegroup --hostname=vm01.my.flat \
--install-method=tar --install-source=/path/to/tar.file.tar
The advantage of the tarfile approach is that you'll not need to
keep a disk image mounted if you were to use the --copy argument
to create a new image using the old one as source:
xen-create-image --size=2Gb --swap=128Mb --dhcp \
--lvm=myvolumegroup --hostname=vm01.my.flat \
--install-method=copy --install-source=/path/to/copy/from
=cut
=head1 DEBOOTSTRAP CACHING
When installing new systems with the debootstrap tool there is
a fair amount of network overhead.
To minimize this the .deb files which are downloaded into the
new instance are cached by default upon the host, in the directory
/var/cache/apt/archives.
When a new image is created these packages are copied into the new
image - before the debootstrap process runs - this should help avoid
expensive network reading.
If you wish to clean the cache upon the host you may do so with
apt-get, as you'd expect:
apt-get clean
(This feature can be disabled with the command line flag --cache=no,
or by the matching setting in the configuration file.)
=cut
=head1 ROLES
Currently there are some roles scripts included which work for
the Debian Sarge and Etch distrubtions only. They are included
primarily as examples of the kind of things you could accomplish.
The supplied scripts are:
=over 8
=item builder
Setup the new virtual images with commonly used packages for rebuilding
Debian packages from their source.
=item gdm
Install an X11 server, using VNC and GDM
=item minimal
Customise the generated images to remove some packages.
=item xdm
Install an X11 server, using VNC and XDM
=back
If you'd like to include your own role scripts you'll need to
create a file in /etc/xen-tools/role.d, and then specify the
name of that file with "--role=filename". Additionally you
may pass options to your role-script with the --role-args
flag.
For example the script /etc/xen-tools/role.d/gdm would be used
by executing with "--role=gdm".
Role scripts are invoked with the directory containing the
installed system as their first argument, and anything passed
as a role-arg will be passed allong as additional arguments.
=cut
=head1 THE SKELETON DIRECTORY
Any files present in the directory /etc/xen-tools/skel will be copied
across to each new guest image. The role of this directory is analogous
to the /etc/skel directory.
A typical use for this would be to copy a public key across to each
new system. You could do this by running:
=for example start
mkdir -p /etc/xen-tools/skel/root/.ssh
chmod -R 700 /etc/xen-tools/skel/root
cp /root/.ssh/id_rsa.pub /etc/xen-tools/skel/root/.ssh/authorized_keys2
chmod 644 /etc/xen-tools/skel/root/.ssh/authorized_keys2
=for example cut
=head1 AUTHOR
Steve
--
http://www.steve.org.uk/
$Id: xen-create-image,v 1.179 2007-09-01 19:22:37 steve Exp $
=cut
=head1 LICENSE
Copyright (c) 2005-2007 by Steve Kemp. All rights reserved.
This module is free software;
you can redistribute it and/or modify it under
the same terms as Perl itself.
The LICENSE file contains the full text of the license.
=cut
use strict;
use English;
use Digest::MD5 qw/ md5_hex /;
use Env;
use File::Path qw/ mkpath /;
use File::Temp qw/ tempdir /;
use Getopt::Long;
use Pod::Usage;
#
# Configuration values read initially from the global configuration
# file, then optionally overridden by the command line.
#
my %CONFIG;
#
# Partition layout information values read from the partitions file,
# or constructed automatically if no partitions file is specified.
#
my @PARTITIONS = undef;
#
# Global variable containing the temporary file where our image
# is mounted for installation purposes.
#
# Why is this here?
#
# Well it makes sure that the magic "END" section can unmount it
# if there are errors.
#
#
my $MOUNT_POINT = undef;
#
# This flag is set upon failure, after images have been created.
#
# It is used so that we can automatically "rollback" upon failure.
#
my $FAIL = 0;
#
# Release number.
#
my $RELEASE = '3.7';
#
# Setup default options.
#
setupDefaultOptions();
#
# Read the global configuration file.
#
readConfigurationFile( "/etc/xen-tools/xen-tools.conf" );
#
# Parse the command line arguments.
#
parseCommandLineArguments();
#
# If we received an additional configuration file then read it.
#
if ( $CONFIG{'config'} )
{
my $path = $CONFIG{'config'};
# If not fully-qualified then read from /etc/xen-tools.
if ( $path !~ /^[\/]/ )
{
$path = "/etc/xen-tools/" . $path;
}
# Read the file, if it exists.
if ( -e $path )
{
readConfigurationFile( $path );
}
else
{
logprint( "The specified configuration file does not exist: '$path'\n" );
logprint( "Aborting\n\n" );
exit;
}
}
#
# Check the environment - after parsing arguments.
#
# This is required so that the "--help" flag will work even if our support
# scripts are not installed, etc.
#
checkSystem();
#
# Ensure we're started by root at this point. This is required
# to make sure we can create new LVM volumes, mount loopback images, or
# carry out other privileged actions.
#
testRootUser();
#
# Check our arguments were sane and complete.
#
checkArguments();
#
# Make sure we have a log directory
#
setupLogFile();
#
# Check we have binaries installed which we expect to use.
#
checkBinariesPresent();
#
# Setup default partitioning scheme if we don't have one.
#
# NOTE: This must be done before we call "showSummary".
#
if ( !$#PARTITIONS )
{
populatePartitionsData() if ( ( $CONFIG{'dir'} ) ||
( $CONFIG{'evms'} ) ||
( $CONFIG{'lvm'} ) );
}
#
# Show a summary of what we're going to do.
#
showSummary();
#
# Create and format the images if we're using loopback filesystems.
#
if ( $CONFIG{'dir'} )
{
#
# Test to see if "loop" module is loaded. This is probably
# not required, except for paranoia.
#
testLoopbackModule();
#
# Create disk + swap images.
#
createLoopbackImages();
}
elsif ( $CONFIG{'lvm'} )
{
#
# Create our LVM partitions.
#
createLVMBits();
}
elsif ( $CONFIG{'evms'} )
{
#
# Create our EVMS partitions.
#
createEVMSBits();
}
elsif ( $CONFIG{'image-dev'} )
{
#
# Use physical disc
#
usePhysicalDevice();
}
else
{
# Can't happen we didn't get an installation type.
logprint( "Error: No recognised installation type.\n" );
logprint( "Please specify a directory, lvm, or evms volume to use.\n");
$FAIL = 1;
exit;
}
#
# Mount the image.
#
mountImage();
#
# Export our environment for the hooks/role script we might be
# running later.
#
# Do this unconditionally now, so that we're all setup to run
# a hook even if we're not installing a system.
#
exportEnvironment();
#
# If we're installing then do so, and test that it worked with
# a binary name that is reasonably likely to exist under any
# distribution of GNU/Linux.
#
if ( $CONFIG{'install'} )
{
#
# Install the system.
#
installSystem();
#
# Did that work?
#
if ( ! -x $MOUNT_POINT . "/bin/ls" )
{
logprint( "System installation failed. Aborting\n");
$FAIL = 1;
exit;
}
#
# Now customize the installation - setting up networking, etc.
#
if( $CONFIG{'hooks'} )
{
runCustomisationHooks();
}
}
#
# Run the user specified role script, if any.
#
runRoleScript();
#
# Create the Xen configuration file.
#
runXenConfigCreation();
#
# Setup the password if the user wanted that.
#
setupRootPassword() if ( $CONFIG{'passwd'} );
#
# Report success.
#
logprint( "All done\n");
#
# If we're supposed to start the new instance do so - note here we
# have to unmount the image first.
#
if ( $CONFIG{'boot'} )
{
#
# Unmount the image and any subsequent mounts.
#
unMountImage( $MOUNT_POINT );
#
# Mark us as unmounted.
#
$MOUNT_POINT = undef;
#
# If there is an /etc/xen/auto directory then link
# in the domain so that it will automatically restart, if it isn't
# already present.
#
# (Will be present if this is overwriting a previous image, for example.)
#
if ( ( -d "/etc/xen/auto" ) &&
( ! -e "/etc/xen/auto/$CONFIG{'hostname'}.cfg" ) )
{
logprint( "Creating auto-start symlink\n" );
my $link = "ln -s /etc/xen/$CONFIG{'hostname'}.cfg /etc/xen/auto/";
runCommand( $link );
}
#
#
# Start the image
#
$CONFIG{'pid'} = fork();
if ( $CONFIG{'pid'} )
{
# Parent.
exit;
}
else
{
# Child.
system( "$CONFIG{'xm'} create $CONFIG{'hostname'}.cfg >/dev/null 2>/dev/null" );
logprint( "Started new Xen guest: $CONFIG{'hostname'}\n" );
}
}
#
# Finished.
#
exit;
=begin doc
Test that this system is fully setup for the new xen-create-image
script.
This means that the the companion scripts xt-* are present on the
host and executable.
=end doc
=cut
sub checkSystem
{
my @required = qw ( / xt-customize-image xt-install-image xt-create-xen-config / );
foreach my $bin ( @required )
{
if ( ! defined( findBinary( $bin ) ) )
{
logprint("The script '$bin' was not found.\n");
logprint( "Aborting\n\n" );
exit;
}
}
#
# Make sure that we have Text::Template installed - this
# will be used by `xt-create-xen-config` and if that fails then
# running is pointless.
#
my $test = "use Text::Template";
eval( $test );
if ( ( $@ ) && ( ! $CONFIG{'force'} ) )
{
print <<E_O_ERROR;
Aborting: The Text::Template perl module isn't installed or available.
Specify '--force' to skip this check and continue regardless.
E_O_ERROR
exit;
}
#
# Make sure that xen-shell is installed if we've got an --admin
# flag specified
#
if ( $CONFIG{'admins'} )
{
my $shell = undef;
$shell = "/usr/bin/xen-login-shell" if ( -x "/usr/bin/xen-login-shell" );
$shell = "/usr/local/bin/xen-login-shell" if ( -x "/usr/bin/local/xen-login-shell" );
if ( !defined( $shell ) )
{
print <<EOF;
You've specified administrator accounts for use with the xen-shell,
however the xen-shell doesn't appear to be installed.
Aborting.
EOF
exit;
}
}
#
# Test the system has a valid (network-script) + (vif-script) setup.
#
testXenConfig();
}
=begin doc
Test that the current Xen host has a valid network configuration,
this is designed to help newcomers to Xen.
=end doc
=cut
sub testXenConfig
{
# wierdness.
return if ( ! -d "/etc/xen" );
#
# Temporary hash.
#
my %cfg;
#
# Read the configuration file.
#
open( CONFIG, "<", "/etc/xen/xend-config.sxp" )
or die "Failed to read /etc/xen/xend-config.sxp: $!";
while( <CONFIG> )
{
next if ( ! $_ || !length( $_ ) );
# vif
if ( $_ =~ /^\(vif-script ([^)]+)/ )
{
$cfg{'vif-script'} = $1;
}
# network
if ( $_ =~ /^\(network-script ([^)]+)/ )
{
$cfg{'network-script'} = $1;
}
}
close( CONFIG );
if ( !defined( $cfg{'network-script'} ) ||
!defined( $cfg{'vif-script'} ) )
{
print <<EOF;
WARNING
-------
You appear to have a missing vif-script, or network-script, in the
Xen configuration file /etc/xen/xend-config.sxp.
Please fix this and restart Xend, or your guests will not be able
to use any networking!
EOF
}
else
{
if ( ( $cfg{'network-script'} =~ /dummy/i ) ||
( $cfg{'vif-script'} =~ /dummy/i ) )
{
print <<EOF;
WARNING
-------
You appear to have a "dummy" vif-script, or network-script, setting
in the Xen configuration file /etc/xen/xend-config.sxp.
Please fix this and restart Xend, or your guests will not be able to
use any networking!
EOF
}
}
}
=begin doc
Setup the default options we'd expect into our global configuration hash.
=end doc
=cut
sub setupDefaultOptions
{
#
# Paths and files.
#
$CONFIG{'dir'} = '';
$CONFIG{'xm'} = findBinary( "xm" );
$CONFIG{'kernel'} = '';
$CONFIG{'modules'} = '';
$CONFIG{'initrd'} = '';
#
# Sizing options.
#
$CONFIG{'memory'} = '96Mb';
$CONFIG{'size'} = '2000Mb';
$CONFIG{'swap'} = '128M';
$CONFIG{'cache'} = 'yes';
$CONFIG{'image'} = 'sparse';
#
# Misc. options.
#
$CONFIG{'mirror'} = 'http://ftp.us.debian.org/debian';
$CONFIG{'arch'} = '';
$CONFIG{'dist'} = 'sarge';
$CONFIG{'fs'} = 'ext3';
$CONFIG{'force'} = 0;
$CONFIG{'install'} = 1;
$CONFIG{'hooks'} = 1;
$CONFIG{'partitions'} = '';
$CONFIG{'pid'} = 0;
$CONFIG{'template'} = '';
$CONFIG{'roledir'} = '/etc/xen-tools/role.d';
$CONFIG{'partitionsdir'} = '/etc/xen-tools/partitions.d';
$CONFIG{'ipfile'} = '/etc/xen-tools/ips.txt';
#
# Installation method defaults to "debootstrap".
#
$CONFIG{'install-method'} = 'debootstrap';
#
# The program to run to create a filesystem.
#
# NOTE: These commands end in a trailing slash. The last parameter is
# added as the loopback file/LVM volume to create the fs on....
#
# NOTE 2: Each of these scripts will "force" the creation of a new
# filesystem, even if it exists. This script must detect
# prior existance itself.
#
$CONFIG{'make_fs_ext2'} = 'mkfs.ext2 -F ';
$CONFIG{'make_fs_ext3'} = 'mkfs.ext3 -F ';
$CONFIG{'make_fs_xfs'} = 'mkfs.xfs -f -d name=';
$CONFIG{'make_fs_reiserfs'} = 'mkfs.reiserfs -f -q ';
#
# Flags to pass to "mount" to mount our image.
#
# NOTE: Kinda redundent and may go away since '-t auto' should do
# the right thing.
#
$CONFIG{'mount_fs_ext2'} = '-t ext2';
$CONFIG{'mount_fs_ext3'} = '-t ext3';
$CONFIG{'mount_fs_xfs'} = '-t xfs';
$CONFIG{'mount_fs_reiserfs'} = '-t reiserfs';
}
=begin doc
Read the specified configuration file, and update our global configuration
hash with the values found in it.
=end doc
=cut
sub readConfigurationFile
{
my ($file) = ( @_ );
# Don't read the file if it doesn't exist.
return if ( ! -e $file );
my $line = "";
open( FILE, "<", $file ) or die "Cannot read file '$file' - $!";
while (defined($line = <FILE>) )
{
chomp $line;
if ($line =~ s/\\$//)
{
$line .= <FILE>;
redo unless eof(FILE);
}
# Skip lines beginning with comments
next if ( $line =~ /^([ \t]*)\#/ );
# Skip blank lines
next if ( length( $line ) < 1 );
# Strip trailing comments.
if ( $line =~ /(.*)\#(.*)/ )
{
$line = $1;
}
# Find variable settings
if ( $line =~ /([^=]+)=([^\n]+)/ )
{
my $key = $1;
my $val = $2;
# Strip leading and trailing whitespace.
$key =~ s/^\s+//;
$key =~ s/\s+$//;
$val =~ s/^\s+//;
$val =~ s/\s+$//;
# command expansion?
if ( $val =~ /(.*)`([^`]+)`(.*)/ )
{
# store
my $pre = $1;
my $cmd = $2;
my $post = $3;
# get output
my $output = `$cmd`;
chomp( $output );
# build up replacement.
$val = $pre . $output . $post;
}
# Store value.
$CONFIG{ $key } = $val;
}
}
close( FILE );
}
=begin doc
Parse the command line arguments this script was given.
=end doc
=cut
sub parseCommandLineArguments
{
my $HELP = 0;
my $MANUAL = 0;
my $VERSION = 0;
#
# We record the installation method here because we want
# to ensure that we allow the method supplied upon the command line
# to overwrite the one we might have ready read from the configuration
# file.
#
my %install;
$install{'evms'} = undef;
$install{'dir'} = undef;
$install{'lvm'} = undef;
$install{'image-dev'} = undef;
#
# Parse options.
#
GetOptions(
# Mandatory
"dist=s", \$CONFIG{'dist'},
# Size options.
"size=s", \$CONFIG{'size'},
"swap=s", \$CONFIG{'swap'},
"noswap", \$CONFIG{'noswap'},
"image=s", \$CONFIG{'image'},
"memory=s", \$CONFIG{'memory'},
# Locations
"dir=s", \$install{'dir'},
"evms=s", \$install{'evms'},
"kernel=s", \$CONFIG{'kernel'},
"initrd=s", \$CONFIG{'initrd'},
"mirror=s", \$CONFIG{'mirror'},
"modules=s", \$CONFIG{'modules'},
"lvm=s", \$install{'lvm'},
"image-dev=s", \$install{'image-dev'},
"swap-dev=s", \$install{'swap-dev'},
# Networking options
"dhcp", \$CONFIG{'dhcp'},
"gateway=s", \$CONFIG{'gateway'},
"hostname=s", \$CONFIG{'hostname'},
"ip=s@", \$CONFIG{'ip'},
"mac=s", \$CONFIG{'mac'},
"netmask=s", \$CONFIG{'netmask'},
"broadcast=s", \$CONFIG{'broadcast'},
"p2p=s", \$CONFIG{'p2p'},
# Exclusive
#
# NOTE: We set the local variable here, not the global.
#
"install-method=s", \$CONFIG{'install-method'},
"install-source=s", \$CONFIG{'install-source'},
# Misc. options
"accounts", \$CONFIG{'accounts'},
"admins=s", \$CONFIG{'admins'},
"arch=s", \$CONFIG{'arch'},
"fs=s", \$CONFIG{'fs'},
"boot", \$CONFIG{'boot'},
"cache=s", \$CONFIG{'cache'},
"config=s", \$CONFIG{'config'},
"ide", \$CONFIG{'ide'},
"install=i", \$CONFIG{'install'},
"hooks=i", \$CONFIG{'hooks'},
"passwd", \$CONFIG{'passwd'},
"partitions=s", \$CONFIG{'partitions'},
"role=s", \$CONFIG{'role'},
"role-args=s", \$CONFIG{'role-args'},
"roledir=s", \$CONFIG{'roledir'},
"force", \$CONFIG{'force'},
"keep", \$CONFIG{'keep'},
"template=s", \$CONFIG{'template'},
# Help options
"debug", \$CONFIG{'verbose'},
"help", \$HELP,
"manual", \$MANUAL,
"verbose", \$CONFIG{'verbose'},
"version", \$VERSION
);
pod2usage(1) if $HELP;
pod2usage(-verbose => 2 ) if $MANUAL;
if ( $VERSION )
{
my $REVISION = '$Revision: 1.179 $';
if ( $REVISION =~ /1.([0-9.]+) / )
{
$REVISION = $1;
}
logprint( "xen-create-image release $RELEASE - CVS: $REVISION\n" );
exit;
}
#
# Now make ensure that the command line setting of '--lvm', '--evms'
# and '--dir=x' override anything specified in the configuration file.
#
if ( $install{'dir'} )
{
$CONFIG{'dir'} = $install{'dir'};
$CONFIG{'evms'} = undef;
$CONFIG{'lvm'} = undef;
$CONFIG{'image-dev'} = undef;
}
if ( $install{'evms'} )
{
$CONFIG{'dir'} = undef;
$CONFIG{'evms'} = $install{'evms'};
$CONFIG{'lvm'} = undef;
$CONFIG{'image-dev'} = undef;
}
if ( $install{'lvm'} )
{
$CONFIG{'dir'} = undef;
$CONFIG{'evms'} = undef;
$CONFIG{'lvm'} = $install{'lvm'};
$CONFIG{'image-dev'} = undef;
}
if ( $install{'image-dev'} )
{
$CONFIG{'dir'} = undef;
$CONFIG{'evms'} = undef;
$CONFIG{'lvm'} = undef;
$CONFIG{'image-dev'} = $install{'image-dev'};
$CONFIG{'size'} = undef;
$CONFIG{'swap'} = undef;
$CONFIG{'swap-dev'} = $install{'swap-dev'} if ( defined( $install{'swap-dev'} ) );
}
}
=begin doc
Make sure this script is being run by a user with UID 0.
=end doc
=cut
sub testRootUser
{
if ( $EFFECTIVE_USER_ID != 0 )
{
my $err =<<E_O_ROOT;
In order to use this script you must be running with root privileges.
(This is necessary to mount the disk images which are created.)
E_O_ROOT
logprint( $err );
exit;
}
}
=begin doc
Test that the command line arguments we were given make sense.
Here we make sure that mutually exclusive options are not selected
for the installation method, etc.
We also warn when some variables are not set.
=end doc
=cut
sub checkArguments
{
#
# We require a distribution name.
#
if ( ! defined( $CONFIG{'dist'} ) )
{
logprint( "The '--dist' argument is mandatory\n" );
exit 1;
}
#
# We require a hostname.
#
if ( ! defined( $CONFIG{'hostname'} ) )
{
logprint( "The '--hostname' argument is mandatory.\n" );
exit 1;
}
#
# NOTE: FAKE!
#
if ( $CONFIG{'dist'} eq 'fedora-core4' )
{
$CONFIG{'dist'} = 'stentz';
}
#
#
# Test that the distribution name we've been given
# to configure has a collection of hook scripts.
#
# If there are no scripts then we clearly cannot
# customise it!
#
my $dir = "/usr/lib/xen-tools/" . $CONFIG{'dist'} . ".d";
if ( ! -d $dir )
{
my $err =<<E_OR;
We're trying to configure an installation of $CONFIG{'dist'} in
$CONFIG{'dir'} - but there is no hook directory for us to use.
This means we don't know how to configure this installation.
We'd expect the hook directory to be : $dir
Aborting.
E_OR
logprint( $err );
exit 1;
}
#
# Image must be 'sparse' or 'full'.
#
if ( defined( $CONFIG{'image'} ) )
{
if ( ( $CONFIG{'image'} ne "sparse" ) &&
( $CONFIG{'image'} ne "full" ) )
{
logprint( "Image type must be 'sparse' or 'full'\n" );
exit;
}
}
#
# If using LVM or EVMS then the images may not be sparse
#
$CONFIG{'image'} = "full" if ( $CONFIG{'lvm'} ||
$CONFIG{'evms'} ||
$CONFIG{'image-dev'} );
#
# Make sure that our installation method is specified.
#
my $valid = 0;
if ( defined( $CONFIG{'install-method'} ) )
{
foreach my $recognised ( qw/ copy debootstrap image-server rinse rpmstrap tar / )
{
$valid = 1 if ( lc($CONFIG{'install-method'}) eq lc($recognised) );
}
#
# If we have "copy", "image-server", or "tar" method
# then make sure we have a source.
#
if ( ( lc($CONFIG{'install-method'}) eq "copy" ) ||
( lc($CONFIG{'install-method'}) eq "image-server" ) ||
( lc($CONFIG{'install-method'}) eq "tar" ) )
{
# not defined.
$valid = 0 if (!defined( $CONFIG{'install-source'} ) );
}
}
else
{
$valid = 1;
}
if ( !$valid )
{
print <<EOF;
Please specify the installation method to use, along with a source
if that is required.
For example:
--install-method=copy --install-source=/some/path
--install-method=debootstrap
--install-method=rinse
--install-method=rpmstrap
--install-method=tar --install-source=/some/file.tar
EOF
exit;
}
#
# Make sure that any specified template file exists.
#
if ( defined( $CONFIG{'template'} ) &&
length( $CONFIG{'template'} ) )
{
if ( -e $CONFIG{'template'} )
{
# nop
}
elsif ( -e "/etc/xen-tools/$CONFIG{'template'}" )
{
$CONFIG{'template'} = "/etc/xen-tools/$CONFIG{'template'}";
}
else
{
# failed to find either by fully qualified path,
# or inside /etc/xen-tools.
logprint( "The specified template file, $CONFIG{'template'}, does not exist.\n" );
exit 1;
}
}
#
# If we've got a role directory specified then it must exist.
#
if ( defined( $CONFIG{'roledir'} ) && length( $CONFIG{'roledir'} ) )
{
if ( ! -d $CONFIG{'roledir'} )
{
logprint( "The specified role directory '$CONFIG{'roledir'}' does not exist\n" );
exit 1;
}
}
#
# If we've got a partitions directory specified then it must exist.
#
if ( defined( $CONFIG{'partitionsdir'} ) && length( $CONFIG{'partitionsdir'} ) )
{
if ( ! -d $CONFIG{'partitionsdir'} )
{
logprint( "The specified partitions directory '$CONFIG{'partitionsdir'}' does not exist\n" );
exit 1;
}
}
#
# Make sure that any specified partitions file exists.
#
if ( ( defined( $CONFIG{'partitions'} ) ) &&
( length( $CONFIG{'partitions'} ) ) )
{
if ( ! ( $CONFIG{'partitions'} =~ /\// ) )
{
$CONFIG{'partitions'} = $CONFIG{'partitionsdir'} . '/' . $CONFIG{'partitions'};
}
if ( ! -e $CONFIG{'partitions'} )
{
logprint( "The specified partitions file, $CONFIG{'partitions'}, does not exist.\n" );
exit 1;
}
loadAndCheckPartitionsFile();
}
if ( $CONFIG{'swap-dev'} && $CONFIG{'noswap'} )
{
logprint( "Please choose either swap-dev or noswap, not both!\n" );
exit 1;
}
if ( $CONFIG{'swap-dev'} && $CONFIG{'partitions'} )
{
logprint( "Please choose either swap-dev or partitions, not both!\n" );
exit 1;
}
if ( $CONFIG{'image-dev'} && $CONFIG{'partitions'} )
{
logprint( "Please choose either image-dev or partitions, not both!\n" );
exit 1;
}
#
# The user must choose either DHCP *or* Static IP. not both
#
if ( $CONFIG{'dhcp'} && $CONFIG{'ip'} )
{
#
# However we will allow the DHCP setting to override a *partially*
# specified IP address.
#
if ( $CONFIG{'ip'} =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.*$/ )
{
delete $CONFIG{'ip'};
}
else
{
logprint( "Please choose either DHCP or static usage, not both!\n" );
exit 1;
}
}
#
# The user must specify one or the other.
#
if ( ( !$CONFIG{'dhcp'} ) && ( !$CONFIG{'ip'} ) )
{
logprint( "Please choose one of:\n" );
logprint( " --dhcp\n" );
logprint( " --ip xx.xx.xx.xx\n" );
exit 1;
}
#
# If we're using static addresses warn if there are variables
# missing
#
if ( $CONFIG{'ip'} )
{
logprint( "WARNING: No gateway address specified!\n" )
unless( defined( $CONFIG{'gateway'} ) );
logprint( "WARNING: No netmaks address specified!\n" )
unless( defined( $CONFIG{'netmask'} ) );
}
#
# If we don't have a MAC address specified then generate one.
#
if ( !$CONFIG{'mac'} )
{
$CONFIG{'mac'} = generateMACAddress();
}
}
=begin doc
Generate a 'random' MAC address.
The MAC address is constructed based upon :
1. The standard Xen prefix.
2. The hostname + IP address of the new guest.
3. The distribution which is to be installed.
=end doc
=cut
sub generateMACAddress
{
#
# Start with the xen prefix
#
my $mac = '00:16:3E';
#
# Build up ( hostname + ip + dhcp + dist );
#
my $hash = '';
foreach my $key ( qw/ hostname ip dhcp dist / )
{
$hash .= $CONFIG{$key} if ( $CONFIG{$key} );
}
#
# Generate an MD5 hash of this data.
#
$hash = md5_hex( $hash );
#
# Now build up a MAC address
#
while( length( $mac ) < 17 )
{
$mac .= ":" . substr( $hash, 0, 2 );
$hash = substr( $hash, 2 );
}
return( uc( $mac ) );
}
=begin doc
Make sure we have a log directory, and create an empty logfile
for this run.
=end doc
=cut
sub setupLogFile
{
mkdir( "/var/log/xen-tools", 0750 ) if ( ! -d "/var/log/xen-tools" );
#
# Trash any existing for this run logfile.
#
open( TRASH, ">", "/var/log/xen-tools/$CONFIG{'hostname'}.log" );
print TRASH "";
close(TRASH);
#
# Make sure the logfile is 0640 - avoid leaking root passwords.
#
chmod( oct( "0640" ), "/var/log/xen-tools/$CONFIG{'hostname'}.log" );
}
=begin doc
Check that we have some required binaries present.
=end doc
=cut
sub checkBinariesPresent
{
#
# Files we demand are present in all cases.
#
my @required = qw ( mount mkswap );
foreach my $file ( @required )
{
if ( ! defined( findBinary( $file ) ) )
{
logprint( "The following binary is required to run this tool\n" );
logprint( "\t$file\n");
exit 1;
}
}
#
# Image type specific binaries
#
if ( defined( $CONFIG{'dir'} ) )
{
# loopback image
if ( ! defined( findBinary( "dd" ) ) )
{
logprint( "The following binary is required to run this tool\n" );
logprint( "\tdd\n");
logprint( "(This only required for loopback images, which you've selected)\n" );
exit 1;
}
}
elsif ( defined( $CONFIG{'evms'} ) )
{
#
# EVMS-specific binaries.
#
my @evms = qw ( evms echo );
foreach my $file ( @evms )
{
if ( ! defined( findBinary( $file ) ) )
{
logprint( "The following binary is required to run this tool\n");
logprint( "\t$file\n" );
logprint( "(This is only required for EVMS volumes, which you've selected)\n" );
exit;
}
}
}
else
{
# LVM-specific binaries.
my @lvm = qw ( lvcreate lvremove );
foreach my $file ( @lvm )
{
if ( !defined( findBinary( $file ) ) )
{
logprint( "The following binary is required to run this tool\n");
logprint( "\t$file\n" );
logprint( "(This is only required for LVM volumes, which you've selected)\n" );
exit;
}
}
}
}
=begin doc
Loads a partitions file, checks the syntax and updates the configuration
variables with it
=end doc
=cut
sub loadAndCheckPartitionsFile
{
my %partitions;
#
# Here we'll test for the required Perl module.
#
# This allows us to:
#
# a) Degrade usefully if the module isn't available.
#
# b) Not require the module unless the user specifies a custom
# partitioning scheme.
#
my $test = "use Config::IniFiles";
eval( $test );
if ( $@ )
{
print <<EOF;
Aborting - To use the custom partitioning code you need to have the
following Perl module installed:
Config::IniFiles
On a Debian system you can get this with:
apt-get install libconfig-inifiles-perl
Otherwise fetch it from CPAN.
EOF
exit;
}
tie %partitions, 'Config::IniFiles', ( -file => $CONFIG{'partitions'} );
@PARTITIONS = ();
my $name;
my $details;
my $foundroot = 0;
while ( ( $name, $details ) = each %partitions )
{
if ( ! ( $name =~ /^[a-zA-Z0-9-]+$/ ) )
{
logprint( "The partition name $name contains invalid characters.\n" );
logprint( "Only alphanumeric characters and the hyphen are allowed\n" );
exit 1;
}
if ( ! ( $details->{'size'} =~ /^[0-9.]+[GgMmKk]b?$/ ) )
{
logprint( "The size $details->{'size'} of partition $name contains is not recognized.\n" );
exit 1;
}
if ( $details->{'type'} eq 'swap' )
{
push( @PARTITIONS, { 'name' => $name,
'size' => $details->{'size'},
'type' => 'swap',
'mountpoint' => '',
'options' => '' } );
}
else
{
if ( ! $CONFIG{ 'make_fs_' . $details->{'type'} } )
{
logprint( "The type $details->{'type'} of partition $name is not recognized.\n" );
exit 1;
}
if ( ! ( $details->{'mountpoint'} =~ /^\/[^: \t\r\n]*$/ ) )
{
logprint( "The mount point $details->{'mountpoint'} of partition $name is invalid.\n" );
exit 1;
}
if ( ! ( $details->{'options'} =~ /^[^: \t\r\n]*$/ ) )
{
logprint( "The mount options $details->{'options'} of partition $name are invalid.\n" );
exit 1;
}
if ( ! $details->{'options'} )
{
$details->{'options'} = 'defaults';
}
if ( $details->{'mountpoint'} eq '/' )
{
$foundroot = 1;
}
push( @PARTITIONS,
{
'name' => $name,
'size' => $details->{'size'},
'type' => $details->{'type'},
'mountpoint' => $details->{'mountpoint'},
'options' => $details->{'options'}
}
);
}
}
if ( ! $foundroot )
{
logprint( "The root partition was not specified.\n" );
exit 1;
}
#
# Sort by length of the mountpoint.
#
# This makes it easy to mount parent folders first
# (e.g. /var before /var/tmp)
#
@PARTITIONS = sort { length $a->{'mountpoint'} cmp length $b->{'mountpoint'} } @PARTITIONS;
}
=begin doc
Populates the partition information using the supplied configuration
arguments when not using the partitions file
=end doc
=cut
sub populatePartitionsData
{
@PARTITIONS = ();
#
# [swap]
#
push( @PARTITIONS, { 'name' => 'swap',
'size' => $CONFIG{'swap'},
'type' => 'swap',
'mountpoint' => '',
'options' => '' } )
unless( $CONFIG{'noswap'} );
#
# read the default filesystem options from the configuration file.
#
my $options = $CONFIG{$CONFIG{'fs'} . "_options" } ||undef;
#
# If there weren't any options in the configuration file then
# revert to our defaults.
#
if (!defined($options))
{
#
# XFS has different default options.
#
$options = "errors=remount-ro";
$options = "defaults" if ( $CONFIG{'fs'} eq "xfs" );
}
#
# [root]
#
push( @PARTITIONS, { 'name' => 'disk',
'size' => $CONFIG{'size'},
'type' => $CONFIG{'fs'},
'mountpoint' => '/',
'options' => $options } );
}
=begin doc
Converts the internal partitions array into a text representation
suitable for passing to other scripts.
=end doc
=cut
sub exportPartitionsToConfig
{
$CONFIG{'NUMPARTITIONS'} = $#PARTITIONS + 1;
my $i;
for ( $i = 0; $i < $CONFIG{'NUMPARTITIONS'}; $i++ )
{
$CONFIG{'PARTITION' . ( $i + 1 )} = $PARTITIONS[$i]{'name'} . ':' .
$PARTITIONS[$i]{'size'} . ':' .
$PARTITIONS[$i]{'type'} . ':' .
$PARTITIONS[$i]{'mountpoint'} . ':' .
$PARTITIONS[$i]{'options'} . ':' .
$PARTITIONS[$i]{'imagetype'} . ':' .
$PARTITIONS[$i]{'image'};
}
}
=begin doc
Show the user a summary of what is going to be created for them
=end doc
=cut
sub showSummary
{
#
# Show the user what to expect.
#
logprint( "\nGeneral Information\n" );
logprint( "--------------------\n" );
logprint( "Hostname : $CONFIG{'hostname'}\n" );
logprint( "Distribution : $CONFIG{'dist'}\n" );
if ( defined $CONFIG{'image-dev'} )
{
logprint( "Root Device : $CONFIG{'image-dev'}\n" );
}
if ( defined $CONFIG{'swap-dev'} )
{
logprint( "Swap Device : $CONFIG{'swap-dev'}\n" );
}
my $info;
my $partcount = 0;
logprint( "Partitions : " );
foreach my $partition ( @PARTITIONS )
{
$info = sprintf('%-15s %-5s (%s)', ($partition->{'type'} ne 'swap') ? $partition->{'mountpoint'} : 'swap', $partition->{'size'}, $partition->{'type'});
if ($partcount++)
{
logprint( " $info\n" );
}
else
{
logprint( "$info\n" );
}
}
logprint( "Image type : $CONFIG{'image'}\n" );
logprint( "Memory size : $CONFIG{'memory'}\n" );
if ( defined( $CONFIG{'kernel'} ) && length( $CONFIG{'kernel'} ) )
{
logprint( "Kernel path : $CONFIG{'kernel'}\n" );
}
if ( defined( $CONFIG{'modules'} ) && length( $CONFIG{'modules'} ) )
{
logprint( "Module path : $CONFIG{'modules'}\n" );
}
if ( defined( $CONFIG{'initrd'} ) && length( $CONFIG{'initrd'} ) )
{
logprint( "Initrd path : $CONFIG{'initrd'}\n" );
}
logprint( "\nNetworking Information\n" );
logprint( "----------------------\n" );
#
# Show each IP address added.
#
# Note we only allow the first IP address to have a MAC address specified.
#
my $ips = $CONFIG{'ip'};
my $mac = $CONFIG{'mac'};
my $count = 1;
if ( defined $ips )
{
#
# Scary magic.
#
if ( !UNIVERSAL::isa( $ips, "ARRAY" ) )
{
#
# If we're reading the value of "ip = xxx" from the configuration
# file we'll have a single (scalar) value in $CONFIG{'ip'}.
#
# BUT we actually assume this hash element contains a reference
# to an array - since that is what the command-line parsing code
# sets up for us.
#
# So here we fake it - that was what the test above as for,
# if we didn't have an array already, then fake one up.
#
# We reset the $ips reference to undef, then coerce it to be an
# (empty) array and push on our single IP.
#
# It works. Even if it's nasty, (or if it is a clever hack!)
#
$ips = undef;
push( @$ips, $CONFIG{'ip'} );
$CONFIG{'ip'} = $ips;
}
}
if ( defined $ips )
{
#
# Print out each network address, and if there is a mac address
# associated with it then use it too.
#
foreach my $i ( @$ips )
{
my $m = undef;
if ( ( $count == 1 ) && ( defined( $mac ) ) )
{
$m = $mac;
}
#
# Here we have special handling for the case where
# IP addresses are xx.yy.zz - we automatically add
# in the next octet using /etc/xen-tools/ips.txt
#
#
if ( $i =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/ )
{
# NOP
$CONFIG{'verbose'} && logprint( "IP address is complete: $i\n" );
}
elsif ( $i =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.$/ )
{
$CONFIG{'verbose'} &&
logprint( "Automatically determining the last octet for: $i\n" );
$i = findNextIP( $i );
$CONFIG{'verbose'} && logprint( "Found $i\n" );
}
#
# Show the IP address.
#
logprint( "IP Address $count : $i" );
# Option MAC address.
if ( defined( $m ) )
{
logprint( " [MAC: $m]" );
}
logprint( "\n" );
$count += 1;
}
}
#
# mac address setting still works even for DHCP, but in that
# case only the first one works.
#
if ( $CONFIG{'dhcp'} )
{
if ( defined( $CONFIG{'mac'} ) )
{
logprint( "IP Address : DHCP [MAC: $CONFIG{'mac'}]\n" );
}
else
{
logprint( "IP Address : DHCP\n" );
}
}
$CONFIG{'netmask'} && logprint( "Netmask : $CONFIG{'netmask'}\n" );
$CONFIG{'broadcast'} && logprint( "Broadcast : $CONFIG{'broadcast'}\n" );
$CONFIG{'gateway'} && logprint( "Gateway : $CONFIG{'gateway'}\n" );
$CONFIG{'p2p'} && logprint( "Point to Point : $CONFIG{'p2p'}\n" );
print "\n";
}
=begin doc
Test that the user has the "loop" module loaded and present,
this is just a warning useful to newcomers.
=end doc
=cut
sub testLoopbackModule
{
if ( -e "/proc/modules" )
{
my $modules = `cat /proc/modules`;
if ( $modules !~ m/loop/ )
{
logprint( "WARNING\n" );
logprint( "-------\n" );
logprint( "Loopback module not loaded and you're using loopback images\n" );
logprint( "Run the following to load the module:\n\n" );
logprint( "modprobe loop loop_max=255\n\n" );
}
}
}
=begin doc
Create the two images "swap.img" and "disk.img" in the directory
we've been given.
We also will call the filesystem creation routine to make sure we
have a valid filesystem.
=end doc
=cut
sub createLoopbackImages
{
#
# Make sure we have the relevant output directory.
#
my $output = $CONFIG{'dir'} . "/domains/" . $CONFIG{'hostname'};
if ( ! -d $output )
{
#
# Catch errors with eval.
#
eval
{
mkpath( $output, 0, 0755 );
};
if ( $@ )
{
die "Cannot create directory tree $output - $@";
}
}
#
# Only proceed overwritting if we have --force specified.
#
if ( ! $CONFIG{'force'} )
{
foreach my $partition ( @PARTITIONS )
{
my $disk = $CONFIG{'dir'} . '/domains/' . $CONFIG{'hostname'} . '/' . $partition->{'name'} . '.img';
if ( -e $disk )
{
logprint( "The partition image already exists. Aborting.\n" );
logprint( "Specify '--force' to overwrite, or remove the following file\n" );
logprint( $disk . "\n" );
exit;
}
}
}
foreach my $partition ( @PARTITIONS )
{
my $disk = $CONFIG{'dir'} . '/domains/' . $CONFIG{'hostname'} . '/' . $partition->{'name'} . '.img';
#
# Save the image path to the partitions array
#
$partition->{'imagetype'} = 'file:';
$partition->{'image'} = $disk;
#
# Modify the size to something reasonable
#
my $size = $partition->{'size'};
#
# Convert Gb -> Mb for the partition image size.
#
if ( $size =~ /^([0-9.]+)Gb*$/i )
{
$size = $1 * 1024 . "M";
}
#
# Final adjustments to sizing.
#
$size =~ s/Mb*$/k/i;
#
# Use dd to create the partition image.
#
logprint( "\nCreating partition image: $disk\n" );
my $image_cmd;
if ( $CONFIG{'image'} eq "sparse" )
{
$CONFIG{'verbose'} && logprint( "Creating sparse image\n" );
$image_cmd = "dd if=/dev/zero of=$disk bs=$size count=0 seek=1024";
}
else
{
$CONFIG{'verbose'} && logprint( "Creating full-sized image\n" );
$image_cmd = "dd if=/dev/zero of=$disk bs=$size count=1024";
}
runCommand( $image_cmd );
logprint( "Done\n" );
if ( ! -e $disk )
{
logprint( "The partition image creation failed to create $disk.\n" );
logprint( "aborting\n" );
exit;
}
#
# Finally create the filesystem / swap
#
if ( $partition->{'type'} eq 'swap' )
{
createSwap( $disk );
}
else
{
createFilesystem( $disk, $partition->{'type'} );
}
}
}
=begin doc
This function is used if you want your new system be installed to a
physical drive (e.g. partition /dev/hda4) or to an already existing
logical volume (e.g. /dev/root_vg/xen_root_lv).
Walter Reiner
=end doc
=cut
sub usePhysicalDevice
{
my $phys_img;
my $swap_img;
@PARTITIONS = ();
if ( defined $CONFIG{'swap-dev'} )
{
$swap_img = $CONFIG{'swap-dev'};
if (! -e $swap_img )
{
logprint( "The physical device or logical volume for swap-dev $swap_img doesn't exist. Aborting.\n" );
logprint( "NOTE: Please provide full path to your physical device or logical volume.\n" );
exit;
}
push( @PARTITIONS, { 'name' => 'swap', 'size' => '', 'type' => 'swap', 'mountpoint' => '', 'options' => '', 'imagetype' => 'phy:', 'image' => $swap_img } )
unless( $CONFIG{'noswap'} );
}
my $options = 'errors=remount-ro';
if ( $CONFIG{'fs'} eq 'xfs' )
{
$options = 'defaults';
}
if ( defined $CONFIG{'image-dev'} )
{
$phys_img = $CONFIG{'image-dev'};
push( @PARTITIONS, { 'name' => 'disk', 'size' => '', 'type' => $CONFIG{'fs'}, 'mountpoint' => '/', 'options' => $options, 'imagetype' => 'phy:', 'image' => $phys_img } );
}
else
{
logprint( "No image-dev parameter given. Aborting.\n" );
exit;
}
createFilesystem( $phys_img, $CONFIG{'fs'} );
createSwap( $swap_img ) unless ( $CONFIG{'noswap'} );
}
=begin doc
This function is responsible for creating two new logical volumes within
a given LVM volume group.
=end doc
=cut
sub createLVMBits
{
#
# Check whether the disk volume exists already, and if so abort
# unless '--force' is specified.
#
foreach my $partition ( @PARTITIONS )
{
my $disk = $CONFIG{'hostname'} . '-' . $partition->{'name'};
my $lvm_disk = "/dev/$CONFIG{'lvm'}/$disk";
if ( -e $lvm_disk )
{
# Delete if forcing
if ( $CONFIG{'force'} )
{
logprint( "Removing $lvm_disk - since we're forcing the install\n" );
runCommand( "lvremove --force $lvm_disk" );
}
else
{
logprint( "The LVM disk image already exists. Aborting.\n" );
logprint( "Specify '--force' to delete and recreate\n" );
exit;
}
}
}
foreach my $partition ( @PARTITIONS )
{
my $disk = $CONFIG{'hostname'} . '-' . $partition->{'name'};
my $lvm_disk = "/dev/$CONFIG{'lvm'}/$disk";
#
# Save the image path to the partitions array
#
$partition->{'imagetype'} = 'phy:';
$partition->{'image'} = $lvm_disk;
#
# The commands to create the volume.
#
my $disk_cmd = "lvcreate $CONFIG{'lvm'} -L $partition->{'size'} -n $disk";
#
# Create the volume
#
runCommand( $disk_cmd );
#
# Make sure that worked.
#
if ( ! -e $lvm_disk )
{
logprint( "The LVM partition image creation failed to create $lvm_disk.\n" );
logprint( "aborting\n" );
exit;
}
#
# Finally create the filesystem / swap
#
if ( $partition->{'type'} eq 'swap' )
{
createSwap( $lvm_disk );
}
else
{
createFilesystem( $lvm_disk, $partition->{'type'} );
}
}
}
=begin doc
This function is responsible for creating two new logical volumes within
a given EVMS container group (which at the moment is either LVM or LVM2), but
should be compatible with any further extentions of evms.
=end doc
=cut
sub createEVMSBits
{
#
# Check whether the disk volume exists already, and if so abort
# unless '--force' is specified. This is two steps with evms,
# because two things need to be checked, the volume and the object.
#
foreach my $partition ( @PARTITIONS )
{
# Check whether the EVMS volume already exists, abort unless '--force' is specified.
my $evms_volume_disk = "/dev/evms/$CONFIG{'hostname'}-$partition->{'name'}";
if ( -e $evms_volume_disk )
{
# Delete if forcing
if ( $CONFIG{'force'} )
{
logprint( "Removing $evms_volume_disk - since we're forcing the install\n" );
runCommand( "echo Delete : $evms_volume_disk | evms" );
}
else
{
logprint( "The EVMS volume $evms_volume_disk already exists. Aborting.\n" );
logprint( "Specify '--force' to delete and recreate\n" );
exit;
}
}
#
# Check whether the EVMS object exists, abort unless '--force'
# is specified.
#
# Note: $evms_object_disk is not specified directly as a device
#
my $evms_object_disk = "$CONFIG{'evms'}/$CONFIG{'hostname'}-$partition->{'name'}";
if ( -e $evms_object_disk )
{
# Delete if forcing
if ( $CONFIG{'force'} )
{
logprint( "Removing $evms_object_disk - since we're forcing the install\n" );
runCommand( "echo Delete : $evms_object_disk | evms" );
}
else
{
logprint( "The EVMS object $evms_object_disk already exists. Aborting.\n" );
logprint( "Specify '--force' to delete and recreate\n" );
exit;
}
}
}
foreach my $partition ( @PARTITIONS )
{
my $disk = $CONFIG{'hostname'} . '-' . $partition->{'name'};
my $evms_disk = "/dev/evms/$disk";
#
# Save the image path to the partitions array
#
$partition->{'imagetype'} = 'phy:';
$partition->{'image'} = $evms_disk;
#
# Modify the size to something reasonable
#
my $size = $partition->{'size'};
#
# Convert Gb -> Mb for the partition image size.
#
if ( $size =~ /^([0-9.]+)Gb*$/i )
{
$size = $1 * 1024 . "M";
}
#
# Final adjustments to sizing.
#
$size =~ s/Mb*$/k/i;
#
# The commands to create the objects and volumes.
#
# create the object
#
my $disk_cmd_object = "echo allocate : $CONFIG{'evms'}/Freespace, size=$CONFIG{'size'}, name=$disk | evms";
#
# these will be piped to evms, but gotta check it first
#
my $disk_cmd_volume = "echo create : Volume, $CONFIG{'evms'}/$disk, name=$disk | evms";
#
# Create the volumes
#
runCommand( $disk_cmd_object );
runCommand( $disk_cmd_volume );
#
# Initialise the partition with the relevant filesystem.
#
if ( $partition->{'type'} eq 'swap' )
{
createSwap( $disk_cmd_volume );
}
else
{
createFilesystem( $disk_cmd_volume, $partition->{'type'} );
}
}
}
=begin doc
Format the given image in the users choice of filesystem.
=end doc
=cut
sub createFilesystem
{
my( $image, $fs ) = ( @_ );
#
# We have the filesystem the user wanted, make sure that the
# binary exists.
#
my $command = $CONFIG{ "make_fs_" . $fs };
#
# Split the command into "binary" + "args". Make sure that
# the binary exists and is executable.
#
if ( $command =~ /([^ ]+) (.*)$/ )
{
my $binary = $1;
my $args = $2;
if ( ! defined( findBinary( $binary ) ) )
{
logprint( "The binary '$binary' required to create the filesystem $fs is missing\n" );
exit;
}
}
else
{
logprint( "The filesystem creation hash is bogus for filesystem : $fs\n" );
exit;
}
#
# OK we have the command and the filesystem. Create it.
#
logprint( "\nCreating $fs filesystem on $image\n" );
$command .= $image;
runCommand( $command );
logprint( "Done\n" );
}
=begin doc
Create the swap filesystem on the given device.
=end doc
=cut
sub createSwap
{
my ( $path ) = ( @_ );
logprint( "\nCreating swap on $path\n" );
runCommand( "mkswap $path" );
logprint( "Done\n" );
}
=begin doc
Mount the loopback disk image into a temporary directory.
Alternatively mount the relevant LVM volume instead.
=end doc
=cut
sub mountImage
{
#
# Create a temporary mount-point to use for the image/volume.
#
$MOUNT_POINT = tempdir( CLEANUP => 1 );
foreach my $partition ( @PARTITIONS )
{
if ( $partition->{'type'} ne 'swap' )
{
my $image = $partition->{'image'};
my $mountpoint = $MOUNT_POINT . $partition->{'mountpoint'};
mkpath( $mountpoint, 0, 0755 );
#
# Lookup the correct arguments to pass to mount.
#
my $mount_cmd;
my $mount_type = $CONFIG{'mount_fs_' . $partition->{'type'} };
#
# LVM partition
#
if ( $CONFIG{'lvm'} )
{
$mount_cmd = "mount $mount_type $image $mountpoint";
}
elsif ( $CONFIG{'evms'} )
{
$mount_cmd = "mount $mount_type $image $mountpoint";
}
elsif ( $CONFIG{'image-dev'} )
{
$mount_cmd = "mount $mount_type $image $mountpoint";
}
else
{
$mount_cmd = "mount $mount_type -o loop $image $mountpoint";
}
runCommand( $mount_cmd );
}
}
}
=begin doc
Install the system, by invoking the xt-install-image script.
The script will be given the appropriate arguments from our environment.
=end doc
=cut
sub installSystem
{
#
# We might have a per-distro mirror.
my $distMirror = "mirror_" . $CONFIG{'dist'};
if ( $CONFIG{$distMirror} && length( $CONFIG{$distMirror} ) )
{
$CONFIG{'mirror'} = $CONFIG{$distMirror};
}
#
#
# Basic command
#
my $cmd = "xt-install-image --hostname=$CONFIG{'hostname'} --location=$MOUNT_POINT --dist=$CONFIG{'dist'} --install-method=$CONFIG{'install-method'}";
#
# Add on the install source if required.
#
$cmd .= " --install-source=$CONFIG{'install-source'}" if ( defined( $CONFIG{'install-source'} ) );
#
# Do we have a per-image configuration file?
#
$cmd .= " --config=$CONFIG{'config'}" if ( defined( $CONFIG{'config'} ) );
#
# Add on the mirror, if defined
#
$cmd .= " --mirror=$CONFIG{'mirror'}" if ( defined( $CONFIG{'mirror'} ) );
#
# Add on the current cache setting
#
$cmd .= " --cache=$CONFIG{'cache'}" if length( $CONFIG{'cache'} );
#
# Propogate --verbose
#
if ( $CONFIG{'verbose'} )
{
$cmd .= " --verbose";
}
#
# Propogate --arche
#
if ( $CONFIG{'arch'} )
{
$cmd .= " --arch=$CONFIG{'arch'}";
}
#
# Show the user what they are installing
#
logprint( "Installation method: $CONFIG{'install-method'}\n" );
logprint( "(Source: $CONFIG{'install-source'})\n" ) if defined( $CONFIG{'install-source'} );
#
# Run the command.
#
runCommand( $cmd );
logprint( "Done\n" );
}
=begin doc
Export our configuratione variables as a series of environmental
variables.
This is required so that our hook and role scripts can easily
read the settings without access to the command line / configuration
file we were invoked with.
=end doc
=cut
sub exportEnvironment
{
#
# Per-distribution mirror?
#
my $distMirror = "mirror_" . $CONFIG{'dist'};
if ( $CONFIG{$distMirror} && length( $CONFIG{$distMirror} ) )
{
$CONFIG{'mirror'} = $CONFIG{$distMirror};
}
#
# Export partitions array to configuration
#
exportPartitionsToConfig();
foreach my $key ( keys %CONFIG )
{
if ( defined( $CONFIG{$key} ) )
{
$ENV{$key} = $CONFIG{$key};
}
}
}
=begin doc
Run the xt-customise-system script to customize our fresh installation.
Before we do this we must pass all the relevant options into our
environment and mount /proc.
=end doc
=cut
sub runCustomisationHooks
{
#
# Before running any scripts we'll mount /proc in the guest.
#
# 1. Make sure there is a directory.
mkdir( $MOUNT_POINT . "/proc", 0755 ) if ( ! -d $MOUNT_POINT . "/proc" );
# 2. Mount
runCommand( "mount -o bind /proc $MOUNT_POINT/proc" );
#
# Now update the environment for each defined IP address.
# these are handled specially since we use arrays.
#
# Remove the value we set above.
delete $ENV{'ip'};
#
# Setup a seperate ip$count value for each IP address.
#
my $ips = $CONFIG{'ip'};
my $count = 1;
foreach my $i ( @$ips )
{
$ENV{'ip' . $count } = $i;
$count += 1;
}
$ENV{'ip_count'} = ($count - 1);
#
# Now show the environment the children get
#
if ( $CONFIG{'verbose'} )
{
logprint( "Customization Script Environment:\n" );
logprint( "---------------------------------\n" );
foreach my $key ( sort keys %ENV )
{
logprint( "\t'" . $key . "' = '" . $ENV{$key} . "'\n" );
}
}
#
# Actually run the appropriate hooks
#
my $customize = "xt-customize-image --dist=$CONFIG{'dist'} --location=$MOUNT_POINT";
if ( $CONFIG{'verbose'} )
{
$customize .= " --verbose";
}
logprint( "\nRunning hooks\n" );
runCommand( $customize );
logprint( "Done\n" );
#
# Unmount /proc in the guest install.
#
runCommand( "umount $MOUNT_POINT/proc" );
}
=begin doc
Find the next usable IP address for the given host.
This works by reading the last octet from a global file, incrementing
it and writing it back to the file. So we have a running total of the
last IP.
=end doc
=cut
sub findNextIP
{
my( $ip ) = (@_);
# Abort if we don't have the IP file.
return $ip if ( ! -e $CONFIG{'ipfile'} );
# Read the number.
open( OCTET, "<", $CONFIG{'ipfile'} ) or return $ip;
my $line = <OCTET>;
$line = 1 if ( ( ! defined( $line ) ) || ( $line !~ /^([0-9]+)$/ ) );
close( OCTET );
chomp( $line );
# Add it
$ip .= ".$line";
# Increment + write
$line += 1 ;
open( OCTET, ">", $CONFIG{'ipfile'} );
print OCTET $line . "\n";
close( OCTET );
return( $ip );
}
=begin doc
If the user specified a role for the new instance then execute it.
=end doc
=cut
sub runRoleScript
{
my $roleDir = $CONFIG{'roledir'};
my $role = $CONFIG{'role'};
#
# Role-script arguments are optional. If present prepare to
# append.
#
my $args = '';
$args = " " . $CONFIG{'role-args'} if ( $CONFIG{'role-args'} );
if ( !defined( $role ) )
{
logprint( "\nNo role script specified. Skipping\n" );
return;
}
#
# The complete path to the role script
#
my $file = $roleDir . "/" . $role;
if ( -x $file )
{
logprint( "\nRole: $role\n" );
logprint( "\tFile: $file\n" );
logprint( "\tArgs: $args\n" ) if ( length( $args ) );
}
else
{
logprint( "\nRole script not executable : $file for role '$role'\n" );
logprint( "Ignoring\n" );
return;
}
#
# Our environment is already setup because of the call to
# runCustomisationHooks.
#
# We just need to run the script with two arguments:
#
# - The mountpoint to the new system.
# - Any, optional, supplied arguments.
#
# NOTE: Space added to $args as prefix ..
#
runCommand( $file . " " . $MOUNT_POINT . $args );
logprint( "Role script completed.\n" );
}
=begin doc
Create the Xen configuration file.
Note that we don't need to do any setup for the environment since
we did this already before running the hook scripts.
=end doc
=cut
sub runXenConfigCreation
{
#
# Configuration file we'll create
#
my $file = '/etc/xen/' . $ENV{'hostname'} . '.cfg';
#
# Abort if it exists.
#
if ( -e $file )
{
unless( $CONFIG{'force'} )
{
logprint( "The Xen configuration file $file exists\n" );
logprint( "Specify --force to force overwriting it.\n" );
logprint( "Aborting\n" );
$FAIL = 1;
exit;
}
}
my $command = 'xt-create-xen-config --output=/etc/xen';
#
# Add the template if specified
#
if ( ( defined( $CONFIG{'template'} ) ) &&
( -e $CONFIG{'template'} ) )
{
$command .= " --template=" . $CONFIG{'template'};
}
#
# Add the admins, if any.
#
if ( defined( $CONFIG{'admins'} ) )
{
$command .= " --admins=$CONFIG{'admins'}";
}
logprint( "\nCreating Xen configuration file\n" );
runCommand( $command );
logprint( "Done\n" );
}
=begin doc
chroot() into the new system and setup the password.
=end doc
=cut
sub setupRootPassword
{
logprint( "Setting up root password\n" );
if ( -x $MOUNT_POINT . "/usr/bin/passwd" )
{
system( "chroot $MOUNT_POINT /usr/bin/passwd" );
}
else
{
logprint( "'passwd' command not found in the new install.\n" );
}
}
=begin doc
Print the given string both to our screen, and to the logfile.
=end doc
=cut
sub logprint
{
my ( $text ) = (@_);
print $text;
#
# Log.
#
if ( $CONFIG{'hostname'} )
{
open( LOGFILE, ">>", "/var/log/xen-tools/$CONFIG{'hostname'}.log" )
or return;
print LOGFILE $text;
close( LOGFILE );
}
}
=begin doc
Find the location of the specified binary on the curent user's PATH.
Return undef if the named binary isn't found.
=end doc
=cut
sub findBinary
{
my( $bin ) = (@_);
# strip any path which might be present.
$bin = $2 if ( $bin =~ /(.*)[\/\\](.*)/ );
foreach my $entry ( split( /:/, $ENV{'PATH'} ) )
{
# guess of location.
my $guess = $entry . "/" . $bin;
# return it if it exists and is executable
return $guess if ( -e $guess && -x $guess );
}
return undef;
}
=begin doc
A utility method to run a system command. We will capture the return
value and exit if the command files.
When running verbosely we will also display any command output once
it has finished.
=end doc
=cut
sub runCommand
{
my ( $cmd ) = (@_ );
#
# Set a local if we don't have one.
#
$ENV{'LC_ALL'} = "C" unless( $ENV{'LC_ALL'} );
#
# Header.
#
$CONFIG{'verbose'} && print "Executing : $cmd\n";
#
# Copy stderr to stdout, so we can see it, and make sure we log it.
#
$cmd .= " 2>&1 | tee --append /var/log/xen-tools/$CONFIG{'hostname'}.log";
#
# Run it.
#
my $output = `$cmd`;
$CONFIG{'verbose'} && print "Finished : $cmd\n";
if ( $? != 0 )
{
logprint( "Running command '$cmd' failed.\n" );
logprint( "Aborting\n" );
$FAIL = 1;
exit;
}
}
=begin doc
Unmount any mount-points which are below the given path.
The mountpoints are chosen by looking at /proc/mounts which
might not be portable, but works for me. (tm).
=end doc
=cut
sub unMountImage
{
my ( $point ) = ( @_ );
#
# Open /proc/mount and get a list of currently mounted paths
# which begin with our mount point.
#
my @points;
open( MOUNTED, "<", "/proc/mounts" )
or die "Failed to open mount list";
foreach my $line (<MOUNTED> )
{
#
# Split into the device and mountpoint.
#
my ( $device, $path ) = split( / /, $line );
if ( $path =~ /\Q$point\E/ )
{
push @points, $path;
}
}
close( MOUNTED );
#
# Now we have a list of mounts. We need to move the
# longest first, we can do this by sorting and reversing.
#
# (ie. We unmount the children, then the parent.)
#
@points = sort @points;
@points = reverse @points;
foreach my $path ( @points )
{
$CONFIG{'verbose'} && print "Unmounting : $path\n";
runCommand( "umount $path" );
}
$MOUNT_POINT = undef;
}
=begin doc
If we still have the temporary image mounted then make sure
it is unmounted before we terminate.
=end doc
=cut
sub END
{
#
# Unmount the image if it is still mounted.
#
if ( defined( $MOUNT_POINT ) )
{
unMountImage( $MOUNT_POINT );
}
#
# Here we print out the status message when finishing.
#
# NOTE: We use the $CONFIG{'pid'} here to control whether the
# message is displayed - since this avoids it from being displayed
# twice when --boot is used.
#
if ( ( defined( $CONFIG{'hostname'} ) ) &&
( -e "/var/log/xen-tools/$CONFIG{'hostname'}.log" ) &&
( ! $CONFIG{'pid'} ) )
{
print "\n\nLogfile produced at:\n";
print "\t /var/log/xen-tools/$CONFIG{'hostname'}.log\n";
}
#
# Did we fail? If so then we should remove the broken installation,
# unless "--keep" was specified.
#
if ( $FAIL && ( ! $CONFIG{'keep'} ) )
{
#
# Run the command
#
$CONFIG{'verbose'} && logprint( "Removing failed install: $CONFIG{'hostname'}\n" );
system( "xen-delete-image --hostname=$CONFIG{'hostname'}" );
}
}