Files
xen/tools/examples
Keir Fraser aac518b954 tools/docs: Fix example and default IP addresses.
In various places in documentation and code, IP addresses are provided
as examples, defaults, or dummy configuration.  In general the
specific IP addresses used in Xen are not always appropriate.  (For
example, 1.2.3.4 is used in a few places!)

The following addresses should be used:
 * For examples and documentation, 192.0.2.0/24.  (See RFC3330.)
 * For defaults for private networks, a random network from RFC1918.
   I have randomly selected 172.30.206.0/24 for this purpose and
   documented this in at the only registry I know of,
   www.ucam.org/cam-grin.  This network should henceforth be used for
   default configurations of local bridges, test networks, etc. in
   Xen tools.

The following addresses should NOT be used:
 * 10.0.*.*, 10.1.*.*, 192.168.0.*, 192.168.1.*, etc.  Using these
   addresses gives greatly increased likelihood of collision, as
   ignorant network administrators and reckless middlebox vendors
   often pick networks from the bottom of 10/8 and 192.168/16.
 * 169.254.*.*.  These are reserved for zeroconf (ad-hoc networking)
   and should not be used for Xen private networks, bridges, etc.,
   etc.  Use of these addresses by Xen scripts causes trouble on hosts
   (eg laptops) which find themselves in ad-hoc networking
   environments.  I think this is not hypothetical (!) since at least
   one Linux distribution have specific code to detect this case and
   cause Xen startup to fail iff the host already has an external
   zeroconf address.
 * 1.2.3.4.  WTF !?

I have also used 127.0.255.255 in one place where apparently a dummy
address is needed (some Linux kernels won't accept a lack of an NFS
server address).  If 127.0.255.255 is mistakenly used it is unlikely
to do any damage to real traffic even if it does escape into the
network at large.

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
2008-01-17 15:13:40 +00:00
..
2007-09-20 10:39:10 +01:00
2007-08-17 10:02:52 +01:00
2007-12-20 13:16:21 +00:00
2007-05-15 10:50:09 +01:00
2007-01-12 14:43:50 +00:00

Xen Control Tools - Examples
===================================

This directory contains example scripts and configurations for Xen.
For many operations you will either be able to use these scripts directly, or
incorporate code from them into your own scripts.

If you write a useful script and would like to share it, please do
send it (preferably with a little summary to go in this file) to
<xen-devel@lists.sourceforge.net> so we can add it to this directory.

block               - called by xen-backend.agent to bind/unbind dev  
block-common.sh     - sourced by block, block-*
block-enbd          - binds/unbinds network block devices
block-nbd           - binds/unbinds network block devices
external-device-migrate - called by xend for migrating external devices
locking.sh          - locking functions to prevent concurrent access to
                      critical sections inside script files
logging.sh          - logging function to log output using syslog
network-bridge      - xen network start/stop script when using bridging
network-nat         - xen network start/stop script when using NAT
network-route       - xen network start/stop script when using routing
vif-bridge          - virtual network start/stop script in bridged mode
vif-common.sh       - sourced by vif-bridge 
vif-nat             - xen virtual network start/stop script in NAT mode 
vif-route           - xen virtual network start/stop script in routed mode
vtpm                - called by xen-backend.agent to bind/unbind vTPM devices
vtpm-common.sh      - common code for vTPM handling
vtpm-delete         - remove an entry from the vTPM table given the
                      domain's name
vtpm-hotplug-common.sh - sourced by vtpm
vtpm-migration.sh   - sourced by external-device-migrate
xen-backend.agent   - calls block, vif-*, vtpm scripts to add, remove, hotplug
                      devices  
xen-backend.rules   - hotplug script rules
xend-config.sxp     - default xend configuration file
xen-hotplug-common.sh - sourced by vif-common.sh
xen-network-common.sh - sourced by vif-common.sh
xen-script-common.sh  - sourced by network-bridge, xen-hotplug-common.sh
xmexample1          - example configuration script for 'xm create'
xmexample2          - a more complex configuration script for 'xm create'
xmexample3          - an advanced configuration script for 'xm create' 
                      that utilizes the vmid
xmexample.nbd       - configuration script that uses NBD filesystems
xmexample.hvm       - a configuration script for creating a hvm domain with
                      'xm create'
xmexample.vti       - a configuration script for creating a domain on vti