xen/README

   1 ---------- Introduction ----------
   2
   3 The configuration is read as follows:
   4  1. set all variables whose defaults are fixed strings to
   5      those built-in default values
   6  2. process the command line arguments
   7  3. read the user configuration file (sourced by bash)
   8  4. process the command line arguments again, so they
   9      can easily be made to override the user configuration file
  10  5. calculate the values for variables which haven't been set
  11      and whose default values depend on circumstances (including
  12      on other variables)
  13
  14 ---------- Items which definitely need attention ----------
  15
  16 adt_guests_domain       .<domain-of-host_hostname>
  17 adt_guest_hostname      <distro>.[<nominum>.]<domain>
  18 adt_guest_ipaddr        from looking hostname up in the DNS
  19         Hostname and IP address for the testbed.
  20         If the configuration specifies one of the address and hostname
  21         but not the other, the missing information will be found with
  22         a DNS lookup.  If neither is specified, adt_guests_domain is
  23         used; if it starts with `.' then <distro>.<nominum> is
  24         prepended; otherwise just <distro>. is prepended.  NOTE: some
  25         effort by the local network administrator to allocate an IP
  26         address (and ideally create DNS entries) is essential.  It is
  27         not possible to use DHCP for IP address allocation for the
  28         testbed.
  29
  30 ---------- Firewall policy items ----------
  31
  32 adt_fw_localmirrors     <none>
  33         List of IP addresses of local mirrors, to which the
  34         testbed should allowed to make HTTP requests.
  35
  36 adt_fw_testbedclients   <host_ipaddr>
  37         List of IP addresses of hosts which will be allowed to make
  38         connections into the testbed system.
  39
  40 adt_fw_prohibnets       192.168.0.0/24 172.16.0.0/12 10.0.0.0/8
  41         List of network ranges with which the testbed will be
  42         prohibited from communicating, notwithstanding
  43         allowglobalports.
  44
  45 adt_fw_allowglobalports 80
  46         List of ports to which the testbed will be allowed to make
  47         outgoing connections.
  48
  49 ---------- Items that are likely to need attention ----------
  50
  51 adt_kernel              the booted kernel file /boot/xen*`uname -r`
  52         Kernel to boot in the testbed image
  53
  54 adt_ramdisk             <kernel>.initrd.img
  55         Initial ramdisk to provide to the testbid image.
  56         "none" means do not provide an initial ramdisk.
  57
  58 adt_modules             /lib/modules/`uname -r`
  59         Directory with modules to be copied into the testbed.
  60
  61 adt_lvm_vg              the system's LVM volume group if there is only one
  62         LVM volume group to create base filesystem image in.
  63
  64 adt_pbuilder_args       <none>
  65         Extra arguments to pass to pbuilder.
  66
  67 ---------- Tuning parameters ----------
  68
  69 adt_fs_type             ext3
  70 adt_fs_mkfs_args        <none>
  71         Filesystem type and any additional arguments to mkfs.  If
  72         _args contains whitespace, it results in multiple arguments;
  73         it is not possible to pass whitespace-containing arguments to
  74         mkfs.
  75
  76 adt_testbed_ram         256 [Mby]
  77         Physical RAM allocated for each testbed instance while
  78         creating and running.
  79
  80 adt_freeze_ram          32 [Mby]
  81         Physical RAM size for frozen image; we reduce the testbed
  82         to this before freezing it and grow it again when we resume
  83         it.
  84
  85 adt_fs_size             1G
  86         Size of base filesystem image.  Should be big enough to
  87         contain all of the software under test and all of its working
  88         space, as no running testbed can ever use more than this
  89         (despite copy-on-write).
  90
  91 adt_fs_snapsize         500M
  92         Space to allocate for copy-on-write snapshot data.  This is
  93         the maximum amount of data that a running testbed can use.
  94         This value should be less than the adt_fs_size.
  95
  96 adt_fs_cowchunk         8 [Mby]
  97         Copy-on-write chunk size.
  98
  99 adt_vm_reduce_retries   10 [seconds]
 100         Time to wait for VM to reduce its memory following
 101         xm mem-set.
 102
 103 ---------- Configuration for advanced uses ----------
 104
 105 adt_config              /etc/autopkgtest/xenlvm_<nominum>_conf
 106
 107 adt_ssh_keytype         dsa
 108 adt_ssh_privkey         /root/.ssh/id_<ssh_keytype>_<nominum>
 109 adt_ssh_pubkey          <ssh_privkey>.pub
 110 adt_ssh_keyident_args   -i <ssh_privkey>
 111 adt_ssh_keygen_args     -t <ssh_keytype>
 112         SSH keypair to use for authentication to the testbed.
 113         If the pubkey file and privkey file do not exist and
 114         correspond to each other, a new key will be generated.
 115         The best combinations of these variables to set are:
 116           keytype [& keygen_args] - just change the key type
 117           privkey [& keygen_args] - generate/use a different keypair
 118           pubkey, keyident_args - use an existing key via agent etc.,
 119                 privkey is ignored if pubkey and keyident_args
 120                 are set and pubkey file exists
 121
 122 adt_nominum             adt
 123         Namespace prefix for Xen domains, LVM volumes, devmapper
 124         devices, entries in /dev, files in /var, and so on.  You may
 125         run several instances of the adt virtualisation system with
 126         different nominums and they won't interact.  It is best for
 127         this to be a legal DNS label (using alphanumerics and hyphens
 128         only); normally it when it is used to construct an identifier
 129         it will be separated by other parts by underscores `_', so
 130         they should be avoided.
 131
 132 adt_guest_macaddr       00:16:3e:7c:aa:7f
 133 adt_net_vifscript       /etc/xen/scripts/vif-route-adt
 134
 135 ---------- Items which should not usually need to be changed ----------
 136
 137 adt_host_hostname       `hostname -f`
 138 adt_host_ipaddr         from looking hostname up in the DNS
 139         Hostname and IP address for the host, ie the Xen dom0 system.
 140         If the configuration specifies one of the address and hostname
 141         but not the other, the missing information will be found with
 142         a DNS lookup.  Note that if the host system uses a dynamically
 143         allocated DHCP address, things will go wrong when the address
 144         changes.
 145
 146 adt_playbase            /var/lib/autopkgtest/xenlvm
 147         Base of filesystem playground areas.
 148
 149 adt_play                <playbase>/<nominum>_<distro>
 150         Playground area for this particular testbed construction and
 151         data.
 152
 153 adt_xmconfig            <play>/xmconfig
 154         Xen virtual machine creation configuration for xm create.
 155         This file will be (over)written during testbed setup.
 156
 157 adt_lvm_baselv          <nominum>_<distro>_base
 158 adt_lvm_cowdatalv       <nominum>_<distro>_cowdata
 159         LVM volume for base filesystem image, and copy-on-write
 160         buffer.  Will be created during testbed setup, destroying any
 161         previous volume if necessary.  This is the logical volume name
 162         not including /dev/<lvm_vg>.
 163
 164 adt_devmapper_cowdev    <nominum>_<distro>_snap
 165         devmapper device for copy-on-write image used by testbed when
 166         running.  This is the device name in the devmapper namespace,
 167         ie not including /dev/mapper.
 168
 169 adt_fslink_dir          adt-xenlvm
 170 adt_fslink_name         <nominum>_<distro>_fs
 171         Directory in /dev, and filename in that directory, where the
 172         scripts put the symlink used to trick Xen into using a
 173         different block device on resume than was used for creation.
 174
 175 adt_xmname              <nominum>_<distro>
 176         Xen virtual machine name, as passed to xm create.