Mercurial > dive4elements > gnv-client

annotate doc/admin-manual/operating-the-system.tex @ 922:237f3a809aee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removed sections that were not tested doc/trunk@1059 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Hans Plum <hans.plum@intevation.de>
date Wed, 05 May 2010 10:33:25 +0000
parents fb1e051713cc
children 9d94bf77e442
rev   line source
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
1 \section{Management of operational processes}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
2
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
3 For running the entire GNV-system the following components have to be
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
4 available in the described sequence:
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
5 \begin{enumerate}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
6 \item Database server
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
7 \item Artefact-server
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
8 \item Apache Tomcat running the WebClient
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
9 \item Apache WebServer
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
10 \end{enumerate}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
11
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
12 During a server startup the installed components get started
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
13 automatically.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
14
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
15 \subsection{Managing the Artifact Server}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
16
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
17 \subsubsection*{Starting and Stopping}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
18
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
19 The artifact-server can be restarted without stopping the WebClient.
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
20 During the restart-process client accessing the server get an approriate
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
21 message. Their session data will not be lost if the artefact database
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
22 will remain untouched.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
23
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
24 Stopping artifact-server:
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
25 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
26 /etc/init.d/artefact-server stop
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
27 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
28
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
29 Starting artifact server
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
30 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
31 /etc/init.d/artefact-server start
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
32 \end{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
33
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
34 Restarting artifact server
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
35 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
36 /etc/init.d/artefact-server restart
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
37 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
38
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
39 \subsubsection*{Troubleshooting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
40
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
41 \paragraph*{Database problems}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
42 For checking problems with the connection to the database server, check
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
43 the logfile of the artifact-server (c.f.
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
44 chapter~\chapter{ref:artifact-server-install},
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
45 p.~pageref{ref:artifact-server-install}.
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
46
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
47 In most cases, a restart of the artifact-server will help to solve
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
48 problems in the artifact-server. If you still encounter problems, check
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
49 for the network connection to the database server and the maturity of
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
50 the database server.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
51
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
52 \paragraph*{Caching problems}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
53 Inconsistencies between original data and cached data:
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
54 The artefact-server stores result sets of the database in a cache and
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
55 provides maps via configuration files for MapServer based on shapefiles.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
56 In case of inconsistencies showing up for longer than twice the
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
57 maximum of the update cycle of internal ETL processes, do the following
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
58 as user \verb+root+:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
59
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
60 \begin{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
61 /etc/init.d/artefact-server stop
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
62 rm -ri $ARTEFACT-SERVER-HOME/cache/*
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
63 /etc/init.d/artefact-server start
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
64 \end{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
65
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
66 \subsection{Managing the GNV-Client}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
67 \subsubsection*{Start Stop Restart}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
68
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
69 The GNV-WebClient can be managed by controlling Apache Tomcat instance:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
70
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
71 Status GNV-WebClient
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
72 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
73 /etc/init.d/tomcat5.5 status
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
74 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
75
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
76 Stopping GNV-WebClient
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
77 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
78 /etc/init.d/tomcat5.5 stop
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
79 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
80
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
81 Starting GNV-WebClient
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
82 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
83 /etc/init.d/tomcat5.5 start
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
84 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
85
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
86 Restarting GNV-WebClient
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
87 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
88 /etc/init.d/tomcat5.5 restart
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
89 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
90
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
91 \subsubsection*{Troubleshooting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
92
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
93 If the GNV-WebClient can not be accessed through the Apache WebServer, do the
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
94 following:
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
95 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
96 1. /etc/init.d/apache2 restart
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
97 2. Check in your browser at http://$SERVERNAME/gnv
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
98 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
99
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
100 If you still encounter problems, follow the next these steps:
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
101
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
102 {\bf Caution: The entire application will be down until the WebServer is
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
103 back up.}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
104 \begin{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
105 /etc/init.d/apache2 stop
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
106 /etc/init.d/tomcat5.5 stop
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
107 rm -r /usr/share/tomcat5.5/work/Catalina/localhost/gnv/*
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
108 /etc/init.d/tomcat5.5 start # wait until tomcat is up
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
109 /etc/init.d/apache2 start
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
110 \end{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
111
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
112 For further information, you look into the log information during the use of the
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
113 GNV WebClient
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
114 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
115 tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
116 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
117
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
118 To get even more logging, do the following:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
119
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
120 {\bf Caution: The entire application will be down until the Apache Tomcat
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
121 has been started properly; the higher log-level can affect the
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
122 runtime-behaviour of the client. For further instructions, c.f.
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
123 Chapter~\ref{ref:webclient-config}, p.~\pageref{ref:webclient-config}.}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
124
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
125 \begin{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
126 /etc/init.d/tomcat5.5 stop
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
127 Set logging to DEBUG
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
128 vim /usr/share/tomcat5.5/webapps/gnv/WEB-INF/classes/log4j.properties
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
129 /etc/init.d/tomcat5.5 start # wait until tomcat is up
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
130 tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
131 \end{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
132
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
133 It is recommended to undo the logging configuration, after the relevant
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
134 part has been found.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
135
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
136 \section{Lists of References}
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
137 %% TODO: List of references
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
138
http://dive4elements.wald.intevation.org