[Xen-devel] [PATCH] (docs) Update Xend information

[Robb Romans <FMJ@xxxxxxxxxx>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


Hi. Attached is a patch containing updated information on Xend.

Please apply.

Signed-off-by: Nivedita Singhvi <niv@xxxxxxxxxx>
Signed-off-by: Robb Romans <FMJ@xxxxxxxxxx>

# HG changeset patch
# User Robb Romans <FMJ@xxxxxxxxxx>
# Node ID f4e8534c40a5744a3d1efe32b0637f7907bafcc4
# Parent  0255f48b757fc4a69846356e8f42e9a4ed410c8c
Updated information from Nivedita Singhvi on Xend.

Signed-off-by: Nivedita Singhvi <niv@xxxxxxxxxx>
Signed-off-by: Robb Romans <FMJ@xxxxxxxxxx>

ssh-rsa 
AAAAB3NzaC1yc2EAAAABIwAAAIEAwcrsYh5jpu5IgS9BPBz2kTnGSESTryZP32Iy7pZ5y9cdOLchdJuADcbN29asxHmis3l0ljNoyrh0++K3sm0FQ0fQE1hnRMksF+3uzCMNyhsF6cHwVzgXv+irWzTq60J6SMG2TQdwni7buGZfYCyF7r85uZAyK7S/ox8qzIJA510=

diff -r 0255f48b757f -r f4e8534c40a5 docs/src/user/domain_mgmt.tex
--- a/docs/src/user/domain_mgmt.tex     Sun Dec  4 19:12:00 2005
+++ b/docs/src/user/domain_mgmt.tex     Mon Dec  5 20:08:19 2005
@@ -1,20 +1,23 @@
 \chapter{Domain Management Tools}
-
-This chapter summarises the tools available to manage running domains.
 
 
 \section{\Xend\ }
 \label{s:xend}
 
-The Xen Daemon (\Xend) (node control daemon) performs system management
-functions related to virtual machines. It forms a central point of
-control for a machine and can be controlled using an HTTP-based
-protocol. \Xend\ must be running in order to start and manage virtual
-machines.
-
-\Xend\ must be run as root because it needs access to privileged system
-management functions. A small set of commands may be issued on the
-\xend\ command line:
+The \Xend\ node control daemon performs system management functions
+related to virtual machines. It forms a central point of control of
+virtualized resources, and must be running in order to start and manage
+virtual machines. \Xend\ must be run as root because it needs access to
+privileged system management functions.
+
+An initialization script named \texttt{/etc/init.d/xend} is provided to
+start \Xend\ at boot time. Use the tool appropriate (i.e. chkconfig) for
+your Linux distribution to specify the runlevels at which this script
+should be executed, or manually create symbolic links in the correct
+runlevel directories.
+
+\Xend\ can be started on the command line as well, and supports the
+following set of parameters:
 
 \begin{tabular}{ll}
   \verb!# xend start! & start \xend, if not already running \\
@@ -24,19 +27,66 @@
   \verb!# xend status! & indicates \xend\ status by its return code
 \end{tabular}
 
-A SysV init script called {\tt xend} is provided to start \xend\ at boot
-time. {\tt make install} installs this script in \path{/etc/init.d}. To
-enable it, you have to make symbolic links in the appropriate runlevel
-directories or use the {\tt chkconfig} tool, where available.
-
-Once \xend\ is running, more sophisticated administration can be done
-using the xm tool (see Section~\ref{s:xm}) and the experimental Xensv
-web interface (see Section~\ref{s:xensv}).
-
-As \xend\ runs, events will be logged to \path{/var/log/xend.log} and,
-if the migration assistant daemon (\path{xfrd}) has been started,
-\path{/var/log/xfrd.log}. These may be of use for troubleshooting
-problems.
+Once \Xend\ is running, more sophisticated administration may be
+done using the \texttt{xm} utility. See Section~\ref{s:xm}.
+
+\subsection{Logging}
+
+As \Xend\ runs, events will be logged to \texttt{/var/log/xend.log}.
+If debugging is enabled, additional logging is performed
+by \Xend\ in \texttt{/var/log/xend-debug.log}.
+
+\subsection{Configuring \Xend\ }
+
+\Xend\ is written in Python. At startup, it reads its configuration
+information from the file \path{/etc/xen/xend-config.sxp}. The Xen
+installation places an example \texttt{xend-config.sxp} file in the
+\texttt{/etc/xen} subdirectory which should work for most installations.
+
+See the example configuration file \texttt{xend-debug.sxp} and the
+section 5 man page \texttt{xend-config.sxp} for a full list of
+parameters and more detailed information. Some of the most important
+parameters are discussed below.
+
+An HTTP interface and a Unix domain socket API are available to
+communicate with \Xend. This allows remote users to pass commands to the
+daemon. By default, \Xend does not start an HTTP server. It does start a
+Unix domain socket management server, as the low level utility
+\texttt{xm} requires it. For support of cross-machine migration, \Xend\
+can start a relocation server. This support is not enabled by default
+for security reasons.
+
+Note: the example \texttt{xend} configuration file modifies the defaults and
+starts up \Xend\ as an HTTP server as well as a relocation server.
+
+From the file:
+
+\begin{verbatim}
+#(xend-http-server no)
+(xend-http-server yes)
+#(xend-unix-server yes)
+#(xend-relocation-server no)
+(xend-relocation-server yes)
+\end{verbatim}
+
+Comment or uncomment lines in that file to disable or enable features
+that you require.
+
+Connections from remote hosts are disabled by default:
+
+\begin{verbatim}
+# Address xend should listen on for HTTP connections, if xend-http-server is
+# set.
+# Specifying 'localhost' prevents remote connections.
+# Specifying the empty string '' (the default) allows all connections.
+#(xend-address '')
+(xend-address localhost)
+\end{verbatim}
+
+It is recommended that if migration support is not needed, the
+\texttt{xend-relocation-server} parameter value be changed to "\texttt{no}" or
+commented out.
+
 
 \section{Xm}
 \label{s:xm}
@@ -133,7 +183,7 @@
 \end{quote}
 
 The \path{xm list} command also supports a long output format when the
-\path{-l} switch is used.  This outputs the fulls details of the
+\path{-l} switch is used.  This outputs the full details of the
 running domains in \xend's SXP configuration format.
 
 For example, suppose the system is running the ttylinux domain as
@@ -160,6 +210,6 @@
 # xencons localhost 9605
 \end{verbatim}
 
-\section{xenstored}
-
-Placeholder.
+%\section{xenstored}
+
+%Placeholder.

Regards,
Robb

- -- 
Robb Romans                     (512) 838-0419
Linux Commando                  T/L   678-0419
ARS NA5TT
.-- - ..-. ..--..
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.8 <http://mailcrypt.sourceforge.net/>

iD8DBQFDlJ7odoW/RCLrCx0RAluHAJ0dH2yWi5a+6oeCau4r7ELDCt1W0wCgnldt
L1QOoBdgGZlISebTYYzTW/g=
=pPHG
-----END PGP SIGNATURE-----

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel