diff doc/admin-manual/operating-the-system.tex @ 921:fb1e051713cc

Improved artifact, webclient and operations section doc/trunk@1058 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Hans Plum <hans.plum@intevation.de>
date Wed, 05 May 2010 10:07:24 +0000
parents 1ebde13e620f
children 237f3a809aee
line wrap: on
line diff
--- a/doc/admin-manual/operating-the-system.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/operating-the-system.tex	Wed May 05 10:07:24 2010 +0000
@@ -1,51 +1,62 @@
 \section{Management of operational processes}
 
-Availability of the components
-  1. Database server 
-  2. Artefact-server
-  3. Apache Tomcat running the WebClient
-  4. Apache WebServer
+For running the entire GNV-system the following components have to be
+available in the described sequence:
+\begin{enumerate}
+  \item Database server 
+  \item Artefact-server
+  \item Apache Tomcat running the WebClient
+  \item Apache WebServer
+\end{enumerate}
 
 During a server startup the installed components get started
 automatically.
 
-\subsection{Managing the Artefact Server}
+\subsection{Managing the Artifact Server}
 
-\subsubsection*{Start Stop Restart}
+\subsubsection*{Starting and Stopping}
 
-The artefact server can be restarted without stopping the WebClient.
+The artifact-server can be restarted without stopping the WebClient.
 During the restart-process client accessing the server get an approriate
 message. Their session data will not be lost if the artefact database
 will remain untouched.
 
-  Stopping artefact server
-  \verb+ /etc/init.d/artefact-server stop+
+  Stopping artifact-server:
+  \begin{lstlisting}
+  /etc/init.d/artefact-server stop
+  \end{lstlisting}
 
-  Starting artefact server
-  \verb+ /etc/init.d/artefact-server start+
-
-  Restarting artefact server
-  \verb+ /etc/init.d/artefact-server restart+
+  Starting artifact server
+  \begin{lstlisting}
+  /etc/init.d/artefact-server start
+  \end{lstlisting}
+  
+  Restarting artifact server
+  \begin{lstlisting}
+  /etc/init.d/artefact-server restart
+  \end{lstlisting}
 
 \subsubsection*{Monitoring the System}
 
-C.f. Testing the installation for the levels: operating system,
-network and service availability
+C.f. Chapter~\ref{ref:artifact-server-testing},
+p.~\pageref{ref:artifact-server-testing} for testing the installation on
+different levels: operating system, network and service availability.
 
 \subsubsection*{Troubleshooting}
 
-Database problems
-For checking problems for problems with the connection to the database
-server, check the logfile of the artefact-server (c.f. FIXME
-installation) look for entries like FIXME.
+\paragraph*{Database problems}
+For checking problems with the connection to the database server, check
+the logfile of the artifact-server (c.f.
+chapter~\chapter{ref:artifact-server-install},
+p.~pageref{ref:artifact-server-install}.
 
-In most cases, a restart of the artefact-server will help to solve
-problems in the artefact-server. If you still encounter problems, check
+In most cases, a restart of the artifact-server will help to solve
+problems in the artifact-server. If you still encounter problems, check
 for the network connection to the database server and the maturity of
 the database server.
 
-
-Inconsistencies between original data and cached data
+\paragraph*{Caching problems}
+Inconsistencies between original data and cached data:
 The artefact-server stores result sets of the database in a cache and
 provides maps via configuration files for MapServer based on shapefiles.
 In case of inconsistencies showing up for longer than twice the
@@ -54,7 +65,7 @@
 
 \begin{lstlisting}
   /etc/init.d/artefact-server stop
-  rm -ri \$ARTEFACT-SERVER-HOME/cache/*
+  rm -ri $ARTEFACT-SERVER-HOME/cache/*
   /etc/init.d/artefact-server start
 \end{lstlisting}
 
@@ -64,16 +75,24 @@
 The GNV-WebClient can be managed by controlling Apache Tomcat instance:
 
  Status GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 status+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 status
+ \end{lstlisting}
 
  Stopping GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 stop+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 stop
+ \end{lstlisting}
 
  Starting GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 start+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 start
+ \end{lstlisting}
 
  Restarting GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 restart+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 restart
+ \end{lstlisting}
 
 \subsubsection*{Monitoring the System}
 
@@ -81,14 +100,17 @@
 
 \subsubsection*{Troubleshooting}
 
-The GNV-WebClient can not accessed through the Apache WebServer, do the
+If the GNV-WebClient can not be accessed through the Apache WebServer, do the
 following:
-1. \verb+ /etc/init.d/apache2 restart+
-2. Check in your browser at \verb+ http://\$SERVERNAME/gnv+
+\begin{lstlisting}
+  1. /etc/init.d/apache2 restart
+  2. Check in your browser at http://$SERVERNAME/gnv
+\end{lstlisting}
 
 If you still encounter problems, follow the next these steps:
+
 {\bf Caution: The entire application will be down until the WebServer is
-back up}
+back up.}
 \begin{lstlisting}
   /etc/init.d/apache2 stop
   /etc/init.d/tomcat5.5 stop
@@ -97,18 +119,22 @@
   /etc/init.d/apache2 start
 \end{lstlisting}
 
-For further information, you look into the Logging during the use of the
+For further information, you look into the log information during the use of the
 GNV WebClient
-\verb+ tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log+
+\begin{lstlisting}
+  tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
+\end{lstlisting}
 
 To get even more logging, do the following:
 
 {\bf Caution: The entire application will be down until the Apache Tomcat
-has started properly; the higher log-level can affect the
-runtime-behaviour of the client}
+has been started properly; the higher log-level can affect the
+runtime-behaviour of the client. For further instructions, c.f.
+Chapter~\ref{ref:webclient-config}, p.~\pageref{ref:webclient-config}.}
+
 \begin{lstlisting}
   /etc/init.d/tomcat5.5 stop
-  Set logging to DEBUG (FIXME)
+  Set logging to DEBUG 
   vim /usr/share/tomcat5.5/webapps/gnv/WEB-INF/classes/log4j.properties
   /etc/init.d/tomcat5.5 start # wait until tomcat is up
   tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
@@ -118,6 +144,5 @@
 part has been found.
 
 \section{Lists of References}
-FIXME
+%% TODO: List of references
 
-FIXME: How to adapt the address/port of connection to REST-server.E

http://dive4elements.wald.intevation.org