ia64/xen-unstable

changeset 1919:f10b0c614fad

bitkeeper revision 1.1108.1.28 (41054bc8T8MzSNX7N4JkfGe7gTpO9g)

More user manual stuff.
author mwilli2@equilibrium.research.intel-research.net
date Mon Jul 26 18:22:00 2004 +0000 (2004-07-26)
parents 0b5c6184451f
children 42f37b71f9b1
files docs/Makefile docs/user.tex
line diff
     1.1 --- a/docs/Makefile	Mon Jul 26 16:28:40 2004 +0000
     1.2 +++ b/docs/Makefile	Mon Jul 26 18:22:00 2004 +0000
     1.3 @@ -4,7 +4,7 @@
     1.4  # Xfig and tgif diagrams should be in the fig/ subdirectory.
     1.5  # DOCUMENTS should be a list of the target Postscript files.
     1.6  
     1.7 -DOCUMENTS = interface.ps interface.pdf
     1.8 +DOCUMENTS = interface.ps interface.pdf user.ps user.pdf
     1.9  
    1.10  GFX  = $(patsubst %.obj, %.eps, $(wildcard figs/*.obj))
    1.11  GFX += $(patsubst %.fig, %.eps, $(wildcard figs/*.fig))
     2.1 --- a/docs/user.tex	Mon Jul 26 16:28:40 2004 +0000
     2.2 +++ b/docs/user.tex	Mon Jul 26 18:22:00 2004 +0000
     2.3 @@ -49,6 +49,13 @@
     2.4  \part{Introduction and Tutorial}
     2.5  \chapter{Introduction}
     2.6  
     2.7 +{\bf
     2.8 +DISCLAIMER: This documentation is currently under active development
     2.9 +and as such there may be mistakes and omissions --- watch out for
    2.10 +these and please report any you find to the developer's mailing list.
    2.11 +Contributions of material, suggestions and corrections are welcome.
    2.12 +}
    2.13 +
    2.14  Xen is a { \em paravirtualising } virtual machine monitor (VMM) or
    2.15  ``Hypervisor'' for the x86 processor architecture.  Xen can securely
    2.16  multiplex heterogeneous virtual machines on a single physical with
    2.17 @@ -160,7 +167,18 @@ Prerequisites:
    2.18  \item A working installation of your favourite Linux distribution.
    2.19  \item A working installation of the GRUB bootloader.
    2.20  \item An installation of Twisted v1.3 or above (see {\tt
    2.21 -http://www.twistedmatrix.com}.
    2.22 +http://www.twistedmatrix.com}.  There may be a package available for
    2.23 +your distribution; alternatively it can be installed by running {\tt \#
    2.24 +make install-twisted} in the root of the Xen source tree.
    2.25 +\item The Linux bridge control tools (see {\tt
    2.26 +http://bridge.sourceforge.net }).  There may be a packages of these
    2.27 +tools available for your distribution.
    2.28 +\end{itemize}
    2.29 +
    2.30 +Optional:
    2.31 +\begin{itemize}
    2.32 +\item The Python logging package (see {\tt http://www.red-dove.com/})
    2.33 +for additional Xend logging functionality.
    2.34  \end{itemize}
    2.35  
    2.36  \section{Download the Xen source code}
    2.37 @@ -192,21 +210,17 @@ To update to the newest changes to the r
    2.38  The Xen source code repository is structured as follows:
    2.39  
    2.40  \begin{description}
    2.41 -\item[tools] Xen node controller daemon (Xend), command line tools, 
    2.42 +\item[\path{tools/}] Xen node controller daemon (Xend), command line tools, 
    2.43    control libraries
    2.44 -\item[xen] The Xen hypervisor itself.
    2.45 -\item[linux-2.4.26-xen] Linux 2.4 support for Xen
    2.46 -\item[linux-2.6.7-xen] Linux 2.6 support for Xen
    2.47 -\item[doc] various documentation files for users and developers
    2.48 -\item[extras] currently this contains the Mini OS, aimed at developers
    2.49 +\item[\path{xen/}] The Xen hypervisor itself.
    2.50 +\item[\path{linux-2.4.26-xen}] Linux 2.4 support for Xen
    2.51 +\item[\path{linux-2.6.7-xen}] Linux 2.6 support for Xen
    2.52 +\item[\path{doc}] various documentation files for users and developers
    2.53 +\item[\path{extras}] currently this contains the Mini OS, aimed at developers
    2.54  \end{description}
    2.55  
    2.56  \section{Build and install}
    2.57  
    2.58 -\begin{verbatim}
    2.59 -# make world
    2.60 -\end{verbatim}
    2.61 -
    2.62  The Xen makefile includes a target ``world'' that will do the
    2.63  following:
    2.64  
    2.65 @@ -221,8 +235,18 @@ following:
    2.66        unprivileged virtual machines.
    2.67  \end{itemize}
    2.68  
    2.69 -The files produced are stored under the \path{install/} directory.  To
    2.70 -install them in their default locations, do:
    2.71 +\begin{verbatim}
    2.72 +# make world
    2.73 +\end{verbatim}
    2.74 +
    2.75 +To build the unprivileged port of Linux 2.6, do:
    2.76 +\begin{verbatim}
    2.77 +# make linux26
    2.78 +\end{verbatim}
    2.79 +
    2.80 +The files produced by the build process are stored under the
    2.81 +\path{install/} directory.  To install them in their default
    2.82 +locations, do:
    2.83  
    2.84  \begin{verbatim}
    2.85  # make install
    2.86 @@ -288,7 +312,46 @@ require a more complex setup, you will w
    2.87  configuration file --- details of the configuration file formats are
    2.88  included in Chapter~\ref{cha:config}.
    2.89  
    2.90 -XXX More explanation needed here...
    2.91 +The \path{xmdefaults} file is a template description that is intended
    2.92 +to be reused for multiple virtual machines.  Setting the value of the
    2.93 +{\tt vmid} variable fills in parts of this template.
    2.94 +
    2.95 +\subsection{Editing \path{xmdefaults}}
    2.96 +
    2.97 +At minimum, you should edit the following variables in \path{xmdefaults}:
    2.98 +
    2.99 +\begin{description}
   2.100 +\item[kernel] Set this to the path of the kernel you compiled for use
   2.101 +              with Xen. [e.g. {\tt kernel =
   2.102 +              '/root/xeno-unstable.bk/install/boot/vmlinuz-2.4.26-xenU'}]
   2.103 +\item[memory] Set this to the size of the domain's memory in
   2.104 +megabytes. [e.g. {\tt memory = 64 } ]
   2.105 +\item[disk] Set the first entry in this list to calculate the offset
   2.106 +of the domain's root partition, based on the domain ID.  Set the
   2.107 +second to the location of \path{/usr} (if you are sharing it between
   2.108 +domains). [i.e. {\tt disk = ['phy:your\_hard\_drive\%d,sda1,w' \%
   2.109 +(base\_partition\_number + vmid), 'phy:your\_usr\_partition,sda6,r' ]}
   2.110 +\item[dhcp] Uncomment the dhcp variable, so that the domain will
   2.111 +receive its IP address from a DHCP server. [i.e. {\tt dhcp=''dhcp''}]
   2.112 +\end{description}
   2.113 +
   2.114 +\subsection{Starting the domain}
   2.115 +
   2.116 +The {\tt xm} tool provides a variety of commands for managing domains.
   2.117 +Use the {\tt create} command to start new domains.  To start the
   2.118 +virtual machine with virtual machine ID 1.
   2.119 +
   2.120 +\begin{verbatim}
   2.121 +# xm create -c vmid=1
   2.122 +\end{verbatim}
   2.123 +
   2.124 +The {\tt -c} switch causes {\tt xm} to turn into the domain's console
   2.125 +after creation.  The {\tt vmid=1} sets the {\tt vmid} variable used in
   2.126 +the {\tt xmdefaults} file.  The tool uses the
   2.127 +\path{/etc/xen/xmdefaults} file, since no custom configuration file
   2.128 +was specified on the command line.
   2.129 +
   2.130 + XXX More explanation needed here...
   2.131  
   2.132  \part{Quick Reference}
   2.133