path: root/docs/src/user.tex

\batchmode
\documentclass[11pt,twoside,final,openright]{report}
\usepackage{a4,graphicx,html,parskip,setspace,times,xspace}
\setstretch{1.15}


\def\Xend{{Xend}\xspace}
\def\xend{{xend}\xspace}

\latexhtml{\newcommand{\path}[1]{{\small {\tt #1}}}}{\newcommand{\path}[1]{{\tt #1}}}


\begin{document}

% TITLE PAGE
\pagestyle{empty}
\begin{center}
\vspace*{\fill}
\includegraphics{figs/xenlogo.eps}
\vfill
\vfill
\vfill
\begin{tabular}{l}
{\Huge \bf Users' Manual} \\[4mm]
{\huge Xen v3.0} \\[80mm]

{\Large Xen is Copyright (c) 2002-2005, The Xen Team} \\[3mm]
{\Large University of Cambridge, UK} \\[20mm]
\end{tabular}
\end{center}

{\bf DISCLAIMER: This documentation is currently under active
  development and as such there may be mistakes and omissions --- watch
  out for these and please report any you find to the developers'
  mailing list. Contributions of material, suggestions and corrections
  are welcome.}

\vfill
\cleardoublepage


% TABLE OF CONTENTS
\pagestyle{plain}
\pagenumbering{roman}
{ \parskip 0pt plus 1pt
  \tableofcontents }
\cleardoublepage


% PREPARE FOR MAIN TEXT
\pagenumbering{arabic}
\raggedbottom
\widowpenalty=10000
\clubpenalty=10000
\parindent=0pt
\parskip=5pt
\renewcommand{\topfraction}{.8}
\renewcommand{\bottomfraction}{.8}
\renewcommand{\textfraction}{.2}
\renewcommand{\floatpagefraction}{.8}
\setstretch{1.1}


%% Chapter Introduction moved to introduction.tex
\include{src/user/introduction}


\part{Installation}

%% Chapter Basic Installation
\include{src/user/installation}

%% Chapter Installing Xen on Debian
\include{src/user/debian}

%% Chapter Installing Xen on Fedora Core
\include{src/user/fedora}

%% Chapter Installing Xen on Gentoo Linux
\include{src/user/gentoo}

%% Chapter Installing Xen on SuSE or SuSE SLES
\include{src/user/suse}

%% Chapter Installing Xen on Red Hat Enterprise Linux (RHEL)
\include{src/user/rhel}

% Chapter dom0 Installation
\include{src/user/dom0_installation}

% Chapter domU Installation
\include{src/user/domU_installation}

% Building Xen
\include{src/user/building_xen}

% Booting Xen
\include{src/user/booting_xen}


\part{Configuration and Management}

%% Chapter Domain Management Tools and Daemons
\include{src/user/domain_mgmt}

%% Chapter Starting Additional Domains
\include{src/user/start_addl_dom}

%% Chapter Domain Configuration
\include{src/user/domain_configuration}

% Chapter Console Management
\include{src/user/console_management}

% Chapter Network Management
\include{src/user/network_management}

% Chapter Storage and FileSytem Management
\include{src/user/domain_filesystem}

% Chapter Memory Management
\include{src/user/memory_management}

% Chapter CPU Management
\include{src/user/cpu_management}

% Chapter Scheduler Management
\include{src/user/scheduler_management}

% Chapter Migrating Domains
\include{src/user/migrating_domains}

%% Chapter Securing Xen
\include{src/user/securing_xen}


\part{Monitoring and Troubleshooting}

%% Chapter Monitoring Xen
\include{src/user/monitoring_xen}

% Chapter xenstat
\include{src/user/xenstat}

% Chapter Log Files
\include{src/user/logfiles}

%% Chapter Debugging
\include{src/user/debugging}

% Chapter xentrace
\include{src/user/xentrace}

%% Chapter Known Problems
\include{src/user/known_problems}

%% Chapter Testing Xen
\include{src/user/testing}


\part{Reference Documentation}

%% Chapter Control Software
\include{src/user/control_software}

%% Chapter Build and Boot Options
\include{src/user/options}

%% Chapter Further Support
\include{src/user/further_support}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\appendix

%% Chapter Glossary of Terms moved to glossary.tex
\include{src/user/glossary}

\end{document}


%% Other stuff without a home

%% Instructions Re Python API

%% Other Control Tasks using Python
%% ================================

%% A Python module 'Xc' is installed as part of the tools-install
%% process. This can be imported, and an 'xc object' instantiated, to
%% provide access to privileged command operations:

%% # import Xc
%% # xc = Xc.new()
%% # dir(xc)
%% # help(xc.domain_create)

%% In this way you can see that the class 'xc' contains useful
%% documentation for you to consult.

%% A further package of useful routines (xenctl) is also installed:

%% # import xenctl.utils
%% # help(xenctl.utils)

%% You can use these modules to write your own custom scripts or you
%% can customise the scripts supplied in the Xen distribution.



% Explain about AGP GART


%% If you're not intending to configure the new domain with an IP
%% address on your LAN, then you'll probably want to use NAT. The
%% 'xen_nat_enable' installs a few useful iptables rules into domain0
%% to enable NAT. [NB: We plan to support RSIP in future]



%% Installing the file systems from the CD
%% =======================================

%% If you haven't got an existing Linux installation onto which you
%% can just drop down the Xen and Xenlinux images, then the file
%% systems on the CD provide a quick way of doing an install. However,
%% you would be better off in the long run doing a proper install of
%% your preferred distro and installing Xen onto that, rather than
%% just doing the hack described below:

%% Choose one or two partitions, depending on whether you want a
%% separate /usr or not. Make file systems on it/them e.g.:
%% mkfs -t ext3 /dev/hda3
%% [or mkfs -t ext2 /dev/hda3 && tune2fs -j /dev/hda3 if using an old
%% version of mkfs]

%% Next, mount the file system(s) e.g.:
%%   mkdir /mnt/root && mount /dev/hda3 /mnt/root
%%   [mkdir /mnt/usr && mount /dev/hda4 /mnt/usr]
  
%% To install the root file system, simply untar /usr/XenDemoCD/root.tar.gz:
%%   cd /mnt/root && tar -zxpf /usr/XenDemoCD/root.tar.gz

%% You'll need to edit /mnt/root/etc/fstab to reflect your file system
%% configuration. Changing the password file (etc/shadow) is probably a
%% good idea too.

%% To install the usr file system, copy the file system from CD on
%% /usr, though leaving out the "XenDemoCD" and "boot" directories:
%%   cd /usr && cp -a X11R6 etc java libexec root src bin dict kerberos
%%    local sbin tmp doc include lib man share /mnt/usr

%% If you intend to boot off these file systems (i.e. use them for
%% domain 0), then you probably want to copy the /usr/boot
%% directory on the cd over the top of the current symlink to /boot
%% on your root filesystem (after deleting the current symlink)
%% i.e.:
%%   cd /mnt/root ; rm boot ; cp -a /usr/boot .