chiark / gitweb /
finalise changelog
[autopkgtest.git] / xen / README
index 02b1cc431fa3b817c5dcf6c91da28258f40bcfd7..f59f162c92c34dbf4f0d8eedabf5d8eda8fa24ed 100644 (file)
@@ -57,12 +57,6 @@ where <config-var> is one of the configuration items listed below.
 either hyphens or underscores.)  Also, `--' may be used to indicate the
 end of the config vars.
 
-Note that there is NO LOCKING.  If you run more than one of either
-adt-xenlvm-with-testbed or adt-xenlvm-setup (or one of each)
-simultaneously, the behaviour is not defined, except that the host
-will definitely not be trashed, and just two or more copies of
-adt-xenlvm-with-testbed at once has no bad effects that
-adt-xenlvm-cleanup won't fix.
 
 
 ========== Configuration ==========
@@ -135,6 +129,7 @@ adt_ramdisk         initrd.img-* where <kernel> is vmlinuz-*
 
 adt_modules            /lib/modules/`uname -r`
        Directory with modules to be copied into the testbed.
+       If this directory does not exist, no modules will be copied.
 
 adt_lvm_vg             the system's LVM volume group if there is only one
        LVM volume group to create base filesystem image in.
@@ -142,15 +137,15 @@ adt_lvm_vg                the system's LVM volume group if there is only one
 adt_distro             host system's distribution
        Distribution name (eg, `edgy', `feisty', `sarge', `etch').
 
-adt_pbuilder_args      <none>
-       Extra arguments to pass to pbuilder.
-
 adt_lvm_erasebase      true
        Whether the base filesystem image needs to be filled with
        zeroes.  If you are going to be using the image only locally
        and so don't care whether the base image contains bits of
        previous data from the disk, you may set this to `no'.
 
+adt_debootstrap_opts   <none>
+       Extra options to pass to debootstrap.
+
 adt_debootstrap_includemore    <empty>
 adt_debootstrap_include                libc6-xen,openssh-server,ed
        Comma-separated lists of packages for --include option to
@@ -192,13 +187,13 @@ adt_freeze_ram            32 [Mby]
        to this before freezing it and grow it again when we resume
        it.
 
-adt_fs_size            1G
+adt_fs_size            6144M
        Size of base filesystem image.  Should be big enough to
        contain all of the software under test and all of its working
        space, as no running testbed can ever use more than this
        (despite copy-on-write).
 
-adt_fs_snapsize                500M
+adt_fs_snapsize                5120M
        Space to allocate for copy-on-write snapshot data.  This is
        the maximum amount of data that a running testbed can use.
        This value should be less than the adt_fs_size.
@@ -206,6 +201,14 @@ adt_fs_snapsize            500M
 adt_fs_cowchunk                8 [Mby]
        Copy-on-write chunk size.
 
+adt_swap_size          5120M
+       Swapspace to provide to guests.  This is done with
+       copy-on-write just as for the filesystems.  The snapshot area
+       is (necessarily) the same size as the swapspace itself.
+
+adt_swap_cowchunk      <fs_cowchunk>
+       Copy-on-write chunk size for swap area.
+
 adt_vm_reduce_retries  10 [seconds]
        Time to wait for VM to reduce its memory following
        xm mem-set.
@@ -239,6 +242,19 @@ adt_nominum                adt
        it will be separated by other parts by underscores `_', so
        they should be avoided.
 
+adt_lvm_swapvg         <lvm_vg>
+       VG to use for guest's swap.
+
+adt_lvm_eraseswap      <lvm_erasebase>
+       Whether the base swap image needs to be filled with zeroes.
+
+adt_lvm_pv_fsbase      <none>
+adt_lvm_pv_fssnap      <none>
+adt_lvm_pv_swapbase    <none>
+adt_lvm_pv_swapsnap    <none>
+       Specifies specific LVM PVs to use.  The default is to leave it
+       up to lvcreate.
+
 adt_guest_macaddr      00:16:3e:7c:aa:7f
 adt_net_vifscript      /etc/xen/scripts/vif-route-adt
 
@@ -264,27 +280,55 @@ adt_play          <playbase>/<nominum>_<distro>
        Playground area for this particular testbed construction and
        data.
 
+adt_lock               <playbase>.lock
+       Lockfile.  Used to prevent multiple simultaneous runs of
+       setup, purge, clean, with-testbed, etc.  The lock is held
+       according to the rules for with-lock-ex from chiark-utils-bin.
+       Set adt_lock to "none" to disable locking.  Note that the
+       lockfile ought not to be in <playbase> because the setup
+       process erases the whole of <playbase> but ought to hold the
+       lock continuously.
+
 adt_xmconfig           <play>/xmconfig
        Xen virtual machine creation configuration for xm create.
        This file will be (over)written during testbed setup.
 
 adt_lvm_baselv         <nominum>_<distro>_base
 adt_lvm_cowdatalv      <nominum>_<distro>_cowdata
+adt_lvm_snapbaselv     <nominum>_<distro>_swapbase
+adt_lvm_snapcowdatalv  <nominum>_<distro>_swapcowdata
        LVM volume for base filesystem image, and copy-on-write
        buffer.  Will be created during testbed setup, destroying any
        previous volume if necessary.  This is the logical volume name
        not including /dev/<lvm_vg>.
 
-adt_devmapper_cowdev   <nominum>_<distro>_snap
+adt_devmapper_cowdev           <nominum>_<distro>_snap
+adt_devmapper_swapcowdev       <nominum>_<distro>_swapsnap
        devmapper device for copy-on-write image used by testbed when
        running.  This is the device name in the devmapper namespace,
        ie not including /dev/mapper.
 
 adt_fslink_dir         adt-xenlvm
+adt_swaplink_dir       adt-xenlvm
 adt_fslink_name                <nominum>_<distro>_fs
+adt_swaplink_name      <nominum>_<distro>_swap
        Directory in /dev, and filename in that directory, where the
        scripts put the symlink used to trick Xen into using a
        different block device on resume than was used for creation.
 
 adt_xmname             <nominum>_<distro>
        Xen virtual machine name, as passed to xm create.
+
+adt_xmhook_disk                <empty>
+adt_xmhook_vif         <empty>
+adt_xmhook_extra       <empty>
+adt_xmhook_config      <empty>
+       The values of these variables are inserted into the Xen domU
+       configuration file.  _disk and _vif should contain zero or
+       more comma-prefixed double-quoted stanzas - they are
+       substituted inside the [ ] after the primary filesystem and
+       network devices set up by the adt-xenlvm tools.  _extra
+       contains additional space-separated kernel command-line
+       options and is substituted inside the double-quotes.  _config
+       should contain whole configuration lines.  See
+       xmdomain.cfg(5).