~ubuntu-branches/ubuntu/precise/xen/precise-updates

1.2.1 by Bastian Blank
Import upstream version 4.0.0
1
#################################
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
2
 __  __            _  _    _ 
3
 \ \/ /___ _ __   | || |  / |
4
  \  // _ \ '_ \  | || |_ | |
5
  /  \  __/ | | | |__   _|| |
6
 /_/\_\___|_| |_|    |_|(_)_|
7
                             
1.2.1 by Bastian Blank
Import upstream version 4.0.0
8
#################################
9
10
http://www.xen.org/
1.1.1 by Adam Heath
Import upstream version 2.0.6
11
12
What is Xen?
13
============
14
15
Xen is a Virtual Machine Monitor (VMM) originally developed by the
1 by Adam Heath
Import upstream version 1.2
16
Systems Research Group of the University of Cambridge Computer
1.2.1 by Bastian Blank
Import upstream version 4.0.0
17
Laboratory, as part of the UK-EPSRC funded XenoServers project.  Xen
18
is freely-distributable Open Source software, released under the GNU
19
GPL. Since its initial public release, Xen has grown a large
20
development community, spearheaded by xen.org (http://www.xen.org).
1.1.1 by Adam Heath
Import upstream version 2.0.6
21
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
22
The 4.1 release offers excellent performance, hardware support and
1.2.1 by Bastian Blank
Import upstream version 4.0.0
23
enterprise-grade features such as x86_32-PAE, x86_64, SMP guests and
24
live relocation of VMs. Ports to Linux, NetBSD, FreeBSD and Solaris
25
are available from the community.
1.1.1 by Adam Heath
Import upstream version 2.0.6
26
27
This file contains some quick-start instructions to install Xen on
28
your system. For full documentation, see the Xen User Manual. If this
29
is a pre-built release then you can find the manual at:
30
 dist/install/usr/share/doc/xen/pdf/user.pdf
31
If you have a source release, then 'make -C docs' will build the
32
manual at docs/pdf/user.pdf.
33
1.2.1 by Bastian Blank
Import upstream version 4.0.0
34
Quick-Start Guide
35
=================
1.1.1 by Adam Heath
Import upstream version 2.0.6
36
37
First, there are a number of prerequisites for building a Xen source
38
release. Make sure you have all the following installed, either by
39
visiting the project webpage or installing a pre-built package
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
40
provided by your OS distributor:
1.2.1 by Bastian Blank
Import upstream version 4.0.0
41
    * GCC v3.4 or later
1.1.1 by Adam Heath
Import upstream version 2.0.6
42
    * GNU Make
43
    * GNU Binutils
44
    * Development install of zlib (e.g., zlib-dev)
1.2.1 by Bastian Blank
Import upstream version 4.0.0
45
    * Development install of Python v2.3 or later (e.g., python-dev)
46
    * Development install of curses (e.g., libncurses-dev)
47
    * Development install of openssl (e.g., openssl-dev)
48
    * Development install of x11 (e.g. xorg-x11-dev)
1.2.7 by Bastian Blank
Import upstream version 4.1.0
49
    * Development install of uuid (e.g. uuid-dev)
1.2.1 by Bastian Blank
Import upstream version 4.0.0
50
    * bridge-utils package (/sbin/brctl)
51
    * iproute package (/sbin/ip)
52
    * hotplug or udev
53
    * GNU bison and GNU flex
1.2.7 by Bastian Blank
Import upstream version 4.1.0
54
    * GNU gettext
55
    * 16-bit x86 assembler, loader and compiler (dev86 rpm or bin86 & bcc debs)
56
    * ACPI ASL compiler (iasl)
1.1.1 by Adam Heath
Import upstream version 2.0.6
57
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
58
Second, you need to acquire a suitable kernel for use in domain 0. If
59
possible you should use a kernel provided by your OS distributor. If
60
no suitable kernel is available from your OS distributor then refer to
61
http://wiki.xen.org/xenwiki/XenDom0Kernels for suggestions for
62
suitable kernels to use.
1.2.7 by Bastian Blank
Import upstream version 4.1.0
63
If you are looking to compile a Dom0 kernel from source, please refer to
64
http://wiki.xensource.com/xenwiki/XenParavirtOps.
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
65
1.1.1 by Adam Heath
Import upstream version 2.0.6
66
[NB. Unless noted otherwise, all the following steps should be
67
performed with root privileges.]
1.2.1 by Bastian Blank
Import upstream version 4.0.0
68
69
1. Download and untar the source tarball file. This will be a
70
   file named xen-unstable-src.tgz, or xen-$version-src.tgz.
71
   You can also pull the current version from the mercurial
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
72
   repository at http://xenbits.xen.org/
1.2.1 by Bastian Blank
Import upstream version 4.0.0
73
74
    # tar xzf xen-unstable-src.tgz
75
76
   Assuming you are using the unstable tree, this will
77
   untar into xen-unstable. The rest of the instructions
78
   use the unstable tree as an example, substitute the
79
   version for unstable.
80
81
2. cd to xen-unstable (or whatever you sensibly rename it to).
82
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
83
3. For the very first build, or if you want to destroy build trees,
84
   perform the following steps:
1.2.1 by Bastian Blank
Import upstream version 4.0.0
85
86
    # make world
87
    # make install
88
89
   This will create and install onto the local machine. It will build
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
90
   the xen binary (xen.gz), the tools and the documentation.
1.2.1 by Bastian Blank
Import upstream version 4.0.0
91
92
   You can override the destination for make install by setting DESTDIR
93
   to some value.
94
95
4. To rebuild an existing tree without modifying the config:
96
    # make dist
97
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
98
   This will build and install xen, tools, and docs into the local dist/
99
   directory.
1.2.1 by Bastian Blank
Import upstream version 4.0.0
100
101
   You can override the destination for make install by setting DISTDIR
102
   to some value.
103
104
   make install and make dist differ in that make install does the
105
   right things for your local machine (installing the appropriate
106
   version of hotplug or udev scripts, for example), but make dist
107
   includes all versions of those scripts, so that you can copy the dist
108
   directory to another machine and install from that distribution.
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
109
   
1.2.1 by Bastian Blank
Import upstream version 4.0.0
110
Python Runtime Libraries
111
========================
112
113
Xend (the Xen daemon) has the following runtime dependencies:
114
115
    * Python 2.3 or later.
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
116
      In some distros, the XML-aspects to the standard library
1.2.1 by Bastian Blank
Import upstream version 4.0.0
117
      (xml.dom.minidom etc) are broken out into a separate python-xml package.
118
      This is also required.
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
119
      In more recent versions of Debian and Ubuntu the XML-aspects are included
120
      in the base python package however (python-xml has been removed
121
      from Debian in squeeze and from Ubuntu in intrepid).
1.2.1 by Bastian Blank
Import upstream version 4.0.0
122
123
          URL:    http://www.python.org/
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
124
          Debian: python
1.2.1 by Bastian Blank
Import upstream version 4.0.0
125
126
    * For optional SSL support, pyOpenSSL:
127
          URL:    http://pyopenssl.sourceforge.net/
128
          Debian: python-pyopenssl
129
130
    * For optional PAM support, PyPAM:
131
          URL:    http://www.pangalactic.org/PyPAM/
132
          Debian: python-pam
133
134
    * For optional XenAPI support in XM, PyXML:
1.2.6 by Bastian Blank
Import upstream version 4.1.0~rc6
135
          URL:    http://codespeak.net/lxml/
136
	  Debian: python-lxml
137
          YUM:    python-lxml
1.2.1 by Bastian Blank
Import upstream version 4.0.0
138
139
140
Intel(R) Trusted Execution Technology Support
141
=============================================
142
143
Intel's technology for safer computing, Intel(R) Trusted Execution Technology
144
(Intel(R) TXT), defines platform-level enhancements that provide the building
145
blocks for creating trusted platforms.  For more information, see
146
http://www.intel.com/technology/security/.
147
148
Intel(R) TXT support is provided by the Trusted Boot (tboot) module in
149
conjunction with minimal logic in the Xen hypervisor.
150
151
Tboot is an open source, pre- kernel/VMM module that uses Intel(R) TXT to
152
perform a measured and verified launch of an OS kernel/VMM.
153
154
The Trusted Boot module is available from
155
http://sourceforge.net/projects/tboot.  This project hosts the code in a
156
mercurial repo at http://tboot.sourceforge.net/hg/tboot.hg and contains
157
tarballs of the source.  Instructions in the tboot README describe how
158
to modify grub.conf to use tboot to launch Xen.
159
160
There are optional targets as part of Xen's top-level makefile that will
161
download and build tboot: install-tboot, build-tboot, dist-tboot, clean-tboot.
162
These will download the latest tar file from the SourceForge site using wget,
163
then build/install/dist according to Xen's settings.