ia64/xen-unstable

changeset 8273:1f6ff996a9fe

Updated info on Xend.

Signed-off-by: Nivedita Singhvi <niv@us.ibm.com>
Signed-off-by: Robb Romans <FMJ@us.ibm.com>
Signed-off-by: Steven Hand <steven@xensource.com>
author smh22@firebug.cl.cam.ac.uk
date Wed Dec 07 18:59:33 2005 +0100 (2005-12-07)
parents b215584242c4
children 7d7973a21a3d
files docs/src/user.tex
line diff
     1.1 --- a/docs/src/user.tex	Wed Dec 07 16:26:07 2005 +0000
     1.2 +++ b/docs/src/user.tex	Wed Dec 07 18:59:33 2005 +0100
     1.3 @@ -905,14 +905,21 @@ This chapter summarizes the management s
     1.4  \section{\Xend\ }
     1.5  \label{s:xend}
     1.6  
     1.7 -The Xen Daemon (\Xend) performs system management functions related to
     1.8 -virtual machines. It forms a central point of control for a machine
     1.9 -and can be controlled using an HTTP-based protocol. \Xend\ must be
    1.10 -running in order to start and manage virtual machines.
    1.11  
    1.12 -\Xend\ must be run as root because it needs access to privileged system
    1.13 -management functions. A small set of commands may be issued on the
    1.14 -\xend\ command line:
    1.15 +The \Xend\ node control daemon performs system management functions
    1.16 +related to virtual machines. It forms a central point of control of
    1.17 +virtualized resources, and must be running in order to start and manage
    1.18 +virtual machines. \Xend\ must be run as root because it needs access to
    1.19 +privileged system management functions.
    1.20 +
    1.21 +An initialization script named \texttt{/etc/init.d/xend} is provided to
    1.22 +start \Xend\ at boot time. Use the tool appropriate (i.e. chkconfig) for
    1.23 +your Linux distribution to specify the runlevels at which this script
    1.24 +should be executed, or manually create symbolic links in the correct
    1.25 +runlevel directories.
    1.26 +
    1.27 +\Xend\ can be started on the command line as well, and supports the
    1.28 +following set of parameters:
    1.29  
    1.30  \begin{tabular}{ll}
    1.31    \verb!# xend start! & start \xend, if not already running \\
    1.32 @@ -929,9 +936,62 @@ the appropriate runlevel directories or 
    1.33  where available.  Once \xend\ is running, administration can be done
    1.34  using the \texttt{xm} tool.
    1.35  
    1.36 -As \xend\ runs, events will be logged to \path{/var/log/xend.log}
    1.37 -and \path{/var/log/xend-debug.log}. These, along with the standard 
    1.38 -syslog files, are useful when troubleshooting problems.
    1.39 +\subsection{Logging}
    1.40 +
    1.41 +As \xend\ runs, events will be logged to \path{/var/log/xend.log} and
    1.42 +(less frequently) to \path{/var/log/xend-debug.log}. These, along with
    1.43 +the standard syslog files, are useful when troubleshooting problems.
    1.44 +
    1.45 +\subsection{Configuring \Xend\ }
    1.46 +
    1.47 +\Xend\ is written in Python. At startup, it reads its configuration
    1.48 +information from the file \path{/etc/xen/xend-config.sxp}. The Xen
    1.49 +installation places an example \texttt{xend-config.sxp} file in the
    1.50 +\texttt{/etc/xen} subdirectory which should work for most installations.
    1.51 +
    1.52 +See the example configuration file \texttt{xend-debug.sxp} and the
    1.53 +section 5 man page \texttt{xend-config.sxp} for a full list of
    1.54 +parameters and more detailed information. Some of the most important
    1.55 +parameters are discussed below.
    1.56 +
    1.57 +An HTTP interface and a Unix domain socket API are available to
    1.58 +communicate with \Xend. This allows remote users to pass commands to the
    1.59 +daemon. By default, \Xend does not start an HTTP server. It does start a
    1.60 +Unix domain socket management server, as the low level utility
    1.61 +\texttt{xm} requires it. For support of cross-machine migration, \Xend\
    1.62 +can start a relocation server. This support is not enabled by default
    1.63 +for security reasons.
    1.64 +
    1.65 +Note: the example \texttt{xend} configuration file modifies the defaults and
    1.66 +starts up \Xend\ as an HTTP server as well as a relocation server.
    1.67 +
    1.68 +From the file:
    1.69 +
    1.70 +\begin{verbatim}
    1.71 +#(xend-http-server no)
    1.72 +(xend-http-server yes)
    1.73 +#(xend-unix-server yes)
    1.74 +#(xend-relocation-server no)
    1.75 +(xend-relocation-server yes)
    1.76 +\end{verbatim}
    1.77 +
    1.78 +Comment or uncomment lines in that file to disable or enable features
    1.79 +that you require.
    1.80 +
    1.81 +Connections from remote hosts are disabled by default:
    1.82 +
    1.83 +\begin{verbatim}
    1.84 +# Address xend should listen on for HTTP connections, if xend-http-server is
    1.85 +# set.
    1.86 +# Specifying 'localhost' prevents remote connections.
    1.87 +# Specifying the empty string '' (the default) allows all connections.
    1.88 +#(xend-address '')
    1.89 +(xend-address localhost)
    1.90 +\end{verbatim}
    1.91 +
    1.92 +It is recommended that if migration support is not needed, the
    1.93 +\texttt{xend-relocation-server} parameter value be changed to
    1.94 +``\texttt{no}'' or commented out.
    1.95  
    1.96  \section{Xm}
    1.97  \label{s:xm}
    1.98 @@ -992,7 +1052,7 @@ The meaning of each field is as follows:
    1.99  \end{quote}
   1.100  
   1.101  The \path{xm list} command also supports a long output format when the
   1.102 -\path{-l} switch is used.  This outputs the fulls details of the
   1.103 +\path{-l} switch is used.  This outputs the full details of the
   1.104  running domains in \xend's SXP configuration format.
   1.105  
   1.106